aws-sdk-rds 1.51.0 → 1.52.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +506 -511
- data/lib/aws-sdk-rds/db_cluster.rb +85 -90
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +6 -11
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +16 -15
- data/lib/aws-sdk-rds/db_engine.rb +10 -4
- data/lib/aws-sdk-rds/db_instance.rb +247 -234
- data/lib/aws-sdk-rds/db_parameter_group.rb +4 -10
- data/lib/aws-sdk-rds/db_security_group.rb +3 -8
- data/lib/aws-sdk-rds/db_snapshot.rb +30 -29
- data/lib/aws-sdk-rds/db_subnet_group.rb +2 -7
- data/lib/aws-sdk-rds/event_subscription.rb +4 -3
- data/lib/aws-sdk-rds/option_group.rb +4 -9
- data/lib/aws-sdk-rds/pending_maintenance_action.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +113 -136
- data/lib/aws-sdk-rds/types.rb +771 -704
- metadata +4 -4
data/lib/aws-sdk-rds/types.rb
CHANGED
@@ -11,7 +11,7 @@ module Aws::RDS
|
|
11
11
|
# Data returned by the **DescribeAccountAttributes** action.
|
12
12
|
#
|
13
13
|
# @!attribute [rw] account_quotas
|
14
|
-
# A list of AccountQuota objects. Within this list, each quota has a
|
14
|
+
# A list of `AccountQuota` objects. Within this list, each quota has a
|
15
15
|
# name, a count of usage toward the quota maximum, and a maximum value
|
16
16
|
# for the quota.
|
17
17
|
# @return [Array<Types::AccountQuota>]
|
@@ -23,8 +23,91 @@ module Aws::RDS
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
-
# Describes a quota for an AWS account
|
27
|
-
#
|
26
|
+
# Describes a quota for an AWS account.
|
27
|
+
#
|
28
|
+
# The following are account quotas:
|
29
|
+
#
|
30
|
+
# * `AllocatedStorage` - The total allocated storage per account, in
|
31
|
+
# GiB. The used value is the total allocated storage in the account,
|
32
|
+
# in GiB.
|
33
|
+
#
|
34
|
+
# * `AuthorizationsPerDBSecurityGroup` - The number of ingress rules per
|
35
|
+
# DB security group. The used value is the highest number of ingress
|
36
|
+
# rules in a DB security group in the account. Other DB security
|
37
|
+
# groups in the account might have a lower number of ingress rules.
|
38
|
+
#
|
39
|
+
# * `CustomEndpointsPerDBCluster` - The number of custom endpoints per
|
40
|
+
# DB cluster. The used value is the highest number of custom endpoints
|
41
|
+
# in a DB clusters in the account. Other DB clusters in the account
|
42
|
+
# might have a lower number of custom endpoints.
|
43
|
+
#
|
44
|
+
# * `DBClusterParameterGroups` - The number of DB cluster parameter
|
45
|
+
# groups per account, excluding default parameter groups. The used
|
46
|
+
# value is the count of nondefault DB cluster parameter groups in the
|
47
|
+
# account.
|
48
|
+
#
|
49
|
+
# * `DBClusterRoles` - The number of associated AWS Identity and Access
|
50
|
+
# Management (IAM) roles per DB cluster. The used value is the highest
|
51
|
+
# number of associated IAM roles for a DB cluster in the account.
|
52
|
+
# Other DB clusters in the account might have a lower number of
|
53
|
+
# associated IAM roles.
|
54
|
+
#
|
55
|
+
# * `DBClusters` - The number of DB clusters per account. The used value
|
56
|
+
# is the count of DB clusters in the account.
|
57
|
+
#
|
58
|
+
# * `DBInstanceRoles` - The number of associated IAM roles per DB
|
59
|
+
# instance. The used value is the highest number of associated IAM
|
60
|
+
# roles for a DB instance in the account. Other DB instances in the
|
61
|
+
# account might have a lower number of associated IAM roles.
|
62
|
+
#
|
63
|
+
# * `DBInstances` - The number of DB instances per account. The used
|
64
|
+
# value is the count of the DB instances in the account.
|
65
|
+
#
|
66
|
+
# * `DBParameterGroups` - The number of DB parameter groups per account,
|
67
|
+
# excluding default parameter groups. The used value is the count of
|
68
|
+
# nondefault DB parameter groups in the account.
|
69
|
+
#
|
70
|
+
# * `DBSecurityGroups` - The number of DB security groups (not VPC
|
71
|
+
# security groups) per account, excluding the default security group.
|
72
|
+
# The used value is the count of nondefault DB security groups in the
|
73
|
+
# account.
|
74
|
+
#
|
75
|
+
# * `DBSubnetGroups` - The number of DB subnet groups per account. The
|
76
|
+
# used value is the count of the DB subnet groups in the account.
|
77
|
+
#
|
78
|
+
# * `EventSubscriptions` - The number of event subscriptions per
|
79
|
+
# account. The used value is the count of the event subscriptions in
|
80
|
+
# the account.
|
81
|
+
#
|
82
|
+
# * `ManualSnapshots` - The number of manual DB snapshots per account.
|
83
|
+
# The used value is the count of the manual DB snapshots in the
|
84
|
+
# account.
|
85
|
+
#
|
86
|
+
# * `OptionGroups` - The number of DB option groups per account,
|
87
|
+
# excluding default option groups. The used value is the count of
|
88
|
+
# nondefault DB option groups in the account.
|
89
|
+
#
|
90
|
+
# * `ReadReplicasPerMaster` - The number of Read Replicas per DB
|
91
|
+
# instance. The used value is the highest number of Read Replicas for
|
92
|
+
# a DB instance in the account. Other DB instances in the account
|
93
|
+
# might have a lower number of Read Replicas.
|
94
|
+
#
|
95
|
+
# * `ReservedDBInstances` - The number of reserved DB instances per
|
96
|
+
# account. The used value is the count of the active reserved DB
|
97
|
+
# instances in the account.
|
98
|
+
#
|
99
|
+
# * `SubnetsPerDBSubnetGroup` - The number of subnets per DB subnet
|
100
|
+
# group. The used value is highest number of subnets for a DB subnet
|
101
|
+
# group in the account. Other DB subnet groups in the account might
|
102
|
+
# have a lower number of subnets.
|
103
|
+
#
|
104
|
+
# For more information, see [Limits][1] in the *Amazon RDS User Guide*
|
105
|
+
# and [Limits][2] in the *Amazon Aurora User Guide*.
|
106
|
+
#
|
107
|
+
#
|
108
|
+
#
|
109
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html
|
110
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html
|
28
111
|
#
|
29
112
|
# @!attribute [rw] account_quota_name
|
30
113
|
# The name of the Amazon RDS quota for this AWS account.
|
@@ -103,7 +186,7 @@ module Aws::RDS
|
|
103
186
|
# @!attribute [rw] feature_name
|
104
187
|
# The name of the feature for the DB instance that the IAM role is to
|
105
188
|
# be associated with. For the list of supported feature names, see
|
106
|
-
# DBEngineVersion
|
189
|
+
# `DBEngineVersion`.
|
107
190
|
# @return [String]
|
108
191
|
#
|
109
192
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddRoleToDBInstanceMessage AWS API Documentation
|
@@ -156,7 +239,7 @@ module Aws::RDS
|
|
156
239
|
|
157
240
|
# @!attribute [rw] event_subscription
|
158
241
|
# Contains the results of a successful invocation of the
|
159
|
-
# DescribeEventSubscriptions action.
|
242
|
+
# `DescribeEventSubscriptions` action.
|
160
243
|
# @return [Types::EventSubscription]
|
161
244
|
#
|
162
245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddSourceIdentifierToSubscriptionResult AWS API Documentation
|
@@ -319,7 +402,7 @@ module Aws::RDS
|
|
319
402
|
# Contains the details for an Amazon RDS DB security group.
|
320
403
|
#
|
321
404
|
# This data type is used as a response element in the
|
322
|
-
# DescribeDBSecurityGroups action.
|
405
|
+
# `DescribeDBSecurityGroups` action.
|
323
406
|
# @return [Types::DBSecurityGroup]
|
324
407
|
#
|
325
408
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AuthorizeDBSecurityGroupIngressResult AWS API Documentation
|
@@ -331,11 +414,8 @@ module Aws::RDS
|
|
331
414
|
|
332
415
|
# Contains Availability Zone information.
|
333
416
|
#
|
334
|
-
# This data type is used as an element in the
|
335
|
-
#
|
336
|
-
# * OrderableDBInstanceOption
|
337
|
-
#
|
338
|
-
# ^
|
417
|
+
# This data type is used as an element in the
|
418
|
+
# `OrderableDBInstanceOption` data type.
|
339
419
|
#
|
340
420
|
# @!attribute [rw] name
|
341
421
|
# The name of the Availability Zone.
|
@@ -432,15 +512,17 @@ module Aws::RDS
|
|
432
512
|
# @return [Time]
|
433
513
|
#
|
434
514
|
# @!attribute [rw] force
|
435
|
-
# A value that
|
436
|
-
# binary logging is enabled. Otherwise, an error occurs when
|
437
|
-
# logging is enabled.
|
515
|
+
# A value that indicates whether to force the DB cluster to backtrack
|
516
|
+
# when binary logging is enabled. Otherwise, an error occurs when
|
517
|
+
# binary logging is enabled.
|
438
518
|
# @return [Boolean]
|
439
519
|
#
|
440
520
|
# @!attribute [rw] use_earliest_time_on_point_in_time_unavailable
|
441
|
-
#
|
442
|
-
# backtrack time
|
443
|
-
#
|
521
|
+
# A value that indicates whether to backtrack the DB cluster to the
|
522
|
+
# earliest possible backtrack time when *BacktrackTo* is set to a
|
523
|
+
# timestamp earlier than the earliest backtrack time. When this
|
524
|
+
# parameter is disabled and *BacktrackTo* is set to a timestamp
|
525
|
+
# earlier than the earliest backtrack time, an error occurs.
|
444
526
|
# @return [Boolean]
|
445
527
|
#
|
446
528
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/BacktrackDBClusterMessage AWS API Documentation
|
@@ -494,12 +576,12 @@ module Aws::RDS
|
|
494
576
|
# Data returned by the **DescribeCertificates** action.
|
495
577
|
#
|
496
578
|
# @!attribute [rw] certificates
|
497
|
-
# The list of Certificate objects for the AWS account.
|
579
|
+
# The list of `Certificate` objects for the AWS account.
|
498
580
|
# @return [Array<Types::Certificate>]
|
499
581
|
#
|
500
582
|
# @!attribute [rw] marker
|
501
583
|
# An optional pagination token provided by a previous
|
502
|
-
# DescribeCertificates request. If this parameter is specified, the
|
584
|
+
# `DescribeCertificates` request. If this parameter is specified, the
|
503
585
|
# response includes only records beyond the marker, up to the value
|
504
586
|
# specified by `MaxRecords` .
|
505
587
|
# @return [String]
|
@@ -513,7 +595,7 @@ module Aws::RDS
|
|
513
595
|
end
|
514
596
|
|
515
597
|
# This data type is used as a response element in the action
|
516
|
-
# DescribeDBEngineVersions
|
598
|
+
# `DescribeDBEngineVersions`.
|
517
599
|
#
|
518
600
|
# @!attribute [rw] character_set_name
|
519
601
|
# The name of the character set.
|
@@ -650,7 +732,7 @@ module Aws::RDS
|
|
650
732
|
# Contains the details of an Amazon RDS DB cluster parameter group.
|
651
733
|
#
|
652
734
|
# This data type is used as a response element in the
|
653
|
-
# DescribeDBClusterParameterGroups action.
|
735
|
+
# `DescribeDBClusterParameterGroups` action.
|
654
736
|
# @return [Types::DBClusterParameterGroup]
|
655
737
|
#
|
656
738
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterParameterGroupResult AWS API Documentation
|
@@ -786,9 +868,9 @@ module Aws::RDS
|
|
786
868
|
# @return [String]
|
787
869
|
#
|
788
870
|
# @!attribute [rw] copy_tags
|
789
|
-
#
|
790
|
-
# target DB cluster snapshot
|
791
|
-
#
|
871
|
+
# A value that indicates whether to copy all tags from the source DB
|
872
|
+
# cluster snapshot to the target DB cluster snapshot. By default, tags
|
873
|
+
# are not copied.
|
792
874
|
# @return [Boolean]
|
793
875
|
#
|
794
876
|
# @!attribute [rw] tags
|
@@ -826,7 +908,7 @@ module Aws::RDS
|
|
826
908
|
# Contains the details for an Amazon RDS DB cluster snapshot
|
827
909
|
#
|
828
910
|
# This data type is used as a response element in the
|
829
|
-
# DescribeDBClusterSnapshots action.
|
911
|
+
# `DescribeDBClusterSnapshots` action.
|
830
912
|
# @return [Types::DBClusterSnapshot]
|
831
913
|
#
|
832
914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterSnapshotResult AWS API Documentation
|
@@ -911,7 +993,7 @@ module Aws::RDS
|
|
911
993
|
# Contains the details of an Amazon RDS DB parameter group.
|
912
994
|
#
|
913
995
|
# This data type is used as a response element in the
|
914
|
-
# DescribeDBParameterGroups action.
|
996
|
+
# `DescribeDBParameterGroups` action.
|
915
997
|
# @return [Types::DBParameterGroup]
|
916
998
|
#
|
917
999
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBParameterGroupResult AWS API Documentation
|
@@ -1020,8 +1102,8 @@ module Aws::RDS
|
|
1020
1102
|
# @return [Array<Types::Tag>]
|
1021
1103
|
#
|
1022
1104
|
# @!attribute [rw] copy_tags
|
1023
|
-
#
|
1024
|
-
# snapshot
|
1105
|
+
# A value that indicates whether to copy all tags from the source DB
|
1106
|
+
# snapshot to the target DB snapshot. By default, tags are not copied.
|
1025
1107
|
# @return [Boolean]
|
1026
1108
|
#
|
1027
1109
|
# @!attribute [rw] pre_signed_url
|
@@ -1120,7 +1202,7 @@ module Aws::RDS
|
|
1120
1202
|
# Contains the details of an Amazon RDS DB snapshot.
|
1121
1203
|
#
|
1122
1204
|
# This data type is used as a response element in the
|
1123
|
-
# DescribeDBSnapshots action.
|
1205
|
+
# `DescribeDBSnapshots` action.
|
1124
1206
|
# @return [Types::DBSnapshot]
|
1125
1207
|
#
|
1126
1208
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBSnapshotResult AWS API Documentation
|
@@ -1312,8 +1394,8 @@ module Aws::RDS
|
|
1312
1394
|
# }
|
1313
1395
|
#
|
1314
1396
|
# @!attribute [rw] availability_zones
|
1315
|
-
# A list of
|
1316
|
-
# can be created
|
1397
|
+
# A list of Availability Zones (AZs) where instances in the DB cluster
|
1398
|
+
# can be created. For information on AWS Regions and Availability
|
1317
1399
|
# Zones, see [Choosing the Regions and Availability Zones][1] in the
|
1318
1400
|
# *Amazon Aurora User Guide*.
|
1319
1401
|
#
|
@@ -1323,8 +1405,7 @@ module Aws::RDS
|
|
1323
1405
|
# @return [Array<String>]
|
1324
1406
|
#
|
1325
1407
|
# @!attribute [rw] backup_retention_period
|
1326
|
-
# The number of days for which automated backups are retained.
|
1327
|
-
# must specify a minimum value of 1.
|
1408
|
+
# The number of days for which automated backups are retained.
|
1328
1409
|
#
|
1329
1410
|
# Default: 1
|
1330
1411
|
#
|
@@ -1494,16 +1575,11 @@ module Aws::RDS
|
|
1494
1575
|
# @return [String]
|
1495
1576
|
#
|
1496
1577
|
# @!attribute [rw] tags
|
1497
|
-
#
|
1498
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
1499
|
-
#
|
1500
|
-
#
|
1501
|
-
#
|
1502
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1578
|
+
# Tags to assign to the DB cluster.
|
1503
1579
|
# @return [Array<Types::Tag>]
|
1504
1580
|
#
|
1505
1581
|
# @!attribute [rw] storage_encrypted
|
1506
|
-
#
|
1582
|
+
# A value that indicates whether the DB cluster is encrypted.
|
1507
1583
|
# @return [Boolean]
|
1508
1584
|
#
|
1509
1585
|
# @!attribute [rw] kms_key_id
|
@@ -1522,7 +1598,7 @@ module Aws::RDS
|
|
1522
1598
|
# source. Otherwise, Amazon RDS will use your default encryption
|
1523
1599
|
# key.
|
1524
1600
|
#
|
1525
|
-
# * If the `StorageEncrypted` parameter is
|
1601
|
+
# * If the `StorageEncrypted` parameter is enabled and
|
1526
1602
|
# `ReplicationSourceIdentifier` is not specified, then Amazon RDS
|
1527
1603
|
# will use your default encryption key.
|
1528
1604
|
#
|
@@ -1578,10 +1654,9 @@ module Aws::RDS
|
|
1578
1654
|
# @return [String]
|
1579
1655
|
#
|
1580
1656
|
# @!attribute [rw] enable_iam_database_authentication
|
1581
|
-
#
|
1582
|
-
# accounts to database accounts
|
1583
|
-
#
|
1584
|
-
# Default: `false`
|
1657
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
1658
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
1659
|
+
# mapping is disabled.
|
1585
1660
|
# @return [Boolean]
|
1586
1661
|
#
|
1587
1662
|
# @!attribute [rw] backtrack_window
|
@@ -1620,9 +1695,9 @@ module Aws::RDS
|
|
1620
1695
|
# @return [Types::ScalingConfiguration]
|
1621
1696
|
#
|
1622
1697
|
# @!attribute [rw] deletion_protection
|
1623
|
-
#
|
1624
|
-
# The database can't be deleted when
|
1625
|
-
# default is
|
1698
|
+
# A value that indicates whether the DB cluster has deletion
|
1699
|
+
# protection enabled. The database can't be deleted when deletion
|
1700
|
+
# protection is enabled. By default, deletion protection is disabled.
|
1626
1701
|
# @return [Boolean]
|
1627
1702
|
#
|
1628
1703
|
# @!attribute [rw] global_cluster_identifier
|
@@ -1631,8 +1706,8 @@ module Aws::RDS
|
|
1631
1706
|
# @return [String]
|
1632
1707
|
#
|
1633
1708
|
# @!attribute [rw] copy_tags_to_snapshot
|
1634
|
-
#
|
1635
|
-
#
|
1709
|
+
# A value that indicates whether to copy all tags from the DB cluster
|
1710
|
+
# to snapshots of the DB cluster. The default is not to copy them.
|
1636
1711
|
# @return [Boolean]
|
1637
1712
|
#
|
1638
1713
|
# @!attribute [rw] destination_region
|
@@ -1730,12 +1805,7 @@ module Aws::RDS
|
|
1730
1805
|
# @return [String]
|
1731
1806
|
#
|
1732
1807
|
# @!attribute [rw] tags
|
1733
|
-
#
|
1734
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
1735
|
-
#
|
1736
|
-
#
|
1737
|
-
#
|
1738
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1808
|
+
# Tags to assign to the DB cluster parameter group.
|
1739
1809
|
# @return [Array<Types::Tag>]
|
1740
1810
|
#
|
1741
1811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterParameterGroupMessage AWS API Documentation
|
@@ -1752,7 +1822,7 @@ module Aws::RDS
|
|
1752
1822
|
# Contains the details of an Amazon RDS DB cluster parameter group.
|
1753
1823
|
#
|
1754
1824
|
# This data type is used as a response element in the
|
1755
|
-
# DescribeDBClusterParameterGroups action.
|
1825
|
+
# `DescribeDBClusterParameterGroups` action.
|
1756
1826
|
# @return [Types::DBClusterParameterGroup]
|
1757
1827
|
#
|
1758
1828
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterParameterGroupResult AWS API Documentation
|
@@ -1766,7 +1836,7 @@ module Aws::RDS
|
|
1766
1836
|
# Contains the details of an Amazon Aurora DB cluster.
|
1767
1837
|
#
|
1768
1838
|
# This data type is used as a response element in the
|
1769
|
-
# DescribeDBClusters
|
1839
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
1770
1840
|
# @return [Types::DBCluster]
|
1771
1841
|
#
|
1772
1842
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterResult AWS API Documentation
|
@@ -1835,7 +1905,7 @@ module Aws::RDS
|
|
1835
1905
|
# Contains the details for an Amazon RDS DB cluster snapshot
|
1836
1906
|
#
|
1837
1907
|
# This data type is used as a response element in the
|
1838
|
-
# DescribeDBClusterSnapshots action.
|
1908
|
+
# `DescribeDBClusterSnapshots` action.
|
1839
1909
|
# @return [Types::DBClusterSnapshot]
|
1840
1910
|
#
|
1841
1911
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterSnapshotResult AWS API Documentation
|
@@ -1910,8 +1980,6 @@ module Aws::RDS
|
|
1910
1980
|
# The meaning of this parameter differs according to the database
|
1911
1981
|
# engine you use.
|
1912
1982
|
#
|
1913
|
-
# Type: String
|
1914
|
-
#
|
1915
1983
|
# **MySQL**
|
1916
1984
|
#
|
1917
1985
|
# The name of the database to create when the DB instance is created.
|
@@ -2142,7 +2210,7 @@ module Aws::RDS
|
|
2142
2210
|
# **Amazon Aurora**
|
2143
2211
|
#
|
2144
2212
|
# Not applicable. The name for the master user is managed by the DB
|
2145
|
-
# cluster.
|
2213
|
+
# cluster.
|
2146
2214
|
#
|
2147
2215
|
# **MariaDB**
|
2148
2216
|
#
|
@@ -2210,7 +2278,7 @@ module Aws::RDS
|
|
2210
2278
|
# **Amazon Aurora**
|
2211
2279
|
#
|
2212
2280
|
# Not applicable. The password for the master user is managed by the
|
2213
|
-
# DB cluster.
|
2281
|
+
# DB cluster.
|
2214
2282
|
#
|
2215
2283
|
# **MariaDB**
|
2216
2284
|
#
|
@@ -2246,15 +2314,14 @@ module Aws::RDS
|
|
2246
2314
|
# **Amazon Aurora**
|
2247
2315
|
#
|
2248
2316
|
# Not applicable. The associated list of EC2 VPC security groups is
|
2249
|
-
# managed by the DB cluster.
|
2250
|
-
# CreateDBCluster.
|
2317
|
+
# managed by the DB cluster.
|
2251
2318
|
#
|
2252
2319
|
# Default: The default EC2 VPC security group for the DB subnet
|
2253
2320
|
# group's VPC.
|
2254
2321
|
# @return [Array<String>]
|
2255
2322
|
#
|
2256
2323
|
# @!attribute [rw] availability_zone
|
2257
|
-
# The
|
2324
|
+
# The Availability Zone (AZ) where the database will be created. For
|
2258
2325
|
# information on AWS Regions and Availability Zones, see [Regions and
|
2259
2326
|
# Availability Zones][1].
|
2260
2327
|
#
|
@@ -2263,8 +2330,8 @@ module Aws::RDS
|
|
2263
2330
|
#
|
2264
2331
|
# Example: `us-east-1d`
|
2265
2332
|
#
|
2266
|
-
# Constraint: The AvailabilityZone parameter can't be specified if
|
2267
|
-
# the
|
2333
|
+
# Constraint: The `AvailabilityZone` parameter can't be specified if
|
2334
|
+
# the DB instance is a Multi-AZ deployment. The specified Availability
|
2268
2335
|
# Zone must be in the same AWS Region as the current endpoint.
|
2269
2336
|
#
|
2270
2337
|
#
|
@@ -2320,8 +2387,7 @@ module Aws::RDS
|
|
2320
2387
|
# **Amazon Aurora**
|
2321
2388
|
#
|
2322
2389
|
# Not applicable. The retention period for automated backups is
|
2323
|
-
# managed by the DB cluster.
|
2324
|
-
# CreateDBCluster.
|
2390
|
+
# managed by the DB cluster.
|
2325
2391
|
#
|
2326
2392
|
# Default: 1
|
2327
2393
|
#
|
@@ -2341,8 +2407,7 @@ module Aws::RDS
|
|
2341
2407
|
# **Amazon Aurora**
|
2342
2408
|
#
|
2343
2409
|
# Not applicable. The daily time range for creating automated backups
|
2344
|
-
# is managed by the DB cluster.
|
2345
|
-
# CreateDBCluster.
|
2410
|
+
# is managed by the DB cluster.
|
2346
2411
|
#
|
2347
2412
|
# The default is a 30-minute window selected at random from an 8-hour
|
2348
2413
|
# block of time for each AWS Region. To see the time blocks available,
|
@@ -2415,15 +2480,16 @@ module Aws::RDS
|
|
2415
2480
|
# @return [Integer]
|
2416
2481
|
#
|
2417
2482
|
# @!attribute [rw] multi_az
|
2418
|
-
# A value that
|
2419
|
-
# deployment. You can't set the AvailabilityZone parameter if the
|
2420
|
-
#
|
2483
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
2484
|
+
# deployment. You can't set the `AvailabilityZone` parameter if the
|
2485
|
+
# DB instance is a Multi-AZ deployment.
|
2421
2486
|
# @return [Boolean]
|
2422
2487
|
#
|
2423
2488
|
# @!attribute [rw] engine_version
|
2424
2489
|
# The version number of the database engine to use.
|
2425
2490
|
#
|
2426
|
-
# For a list of valid engine versions,
|
2491
|
+
# For a list of valid engine versions, use the
|
2492
|
+
# `DescribeDBEngineVersions` action.
|
2427
2493
|
#
|
2428
2494
|
# The following are the database engines and links to information
|
2429
2495
|
# about the major and minor versions that are available with Amazon
|
@@ -2432,8 +2498,7 @@ module Aws::RDS
|
|
2432
2498
|
# **Amazon Aurora**
|
2433
2499
|
#
|
2434
2500
|
# Not applicable. The version number of the database engine to be used
|
2435
|
-
# by the DB instance is managed by the DB cluster.
|
2436
|
-
# information, see CreateDBCluster.
|
2501
|
+
# by the DB instance is managed by the DB cluster.
|
2437
2502
|
#
|
2438
2503
|
# **MariaDB**
|
2439
2504
|
#
|
@@ -2470,10 +2535,9 @@ module Aws::RDS
|
|
2470
2535
|
# @return [String]
|
2471
2536
|
#
|
2472
2537
|
# @!attribute [rw] auto_minor_version_upgrade
|
2473
|
-
#
|
2474
|
-
# the DB instance during the maintenance window.
|
2475
|
-
#
|
2476
|
-
# Default: `true`
|
2538
|
+
# A value that indicates whether minor engine upgrades are applied
|
2539
|
+
# automatically to the DB instance during the maintenance window. By
|
2540
|
+
# default, minor engine upgrades are applied automatically.
|
2477
2541
|
# @return [Boolean]
|
2478
2542
|
#
|
2479
2543
|
# @!attribute [rw] license_model
|
@@ -2514,14 +2578,15 @@ module Aws::RDS
|
|
2514
2578
|
# **Amazon Aurora**
|
2515
2579
|
#
|
2516
2580
|
# Not applicable. The character set is managed by the DB cluster. For
|
2517
|
-
# more information, see CreateDBCluster
|
2581
|
+
# more information, see `CreateDBCluster`.
|
2518
2582
|
# @return [String]
|
2519
2583
|
#
|
2520
2584
|
# @!attribute [rw] publicly_accessible
|
2521
|
-
#
|
2522
|
-
#
|
2523
|
-
#
|
2524
|
-
#
|
2585
|
+
# A value that indicates whether the DB instance is publicly
|
2586
|
+
# accessible. When the DB instance is publicly accessible, it is an
|
2587
|
+
# Internet-facing instance with a publicly resolvable DNS name, which
|
2588
|
+
# resolves to a public IP address. When the DB instance is not
|
2589
|
+
# publicly accessible, it is an internal instance with a DNS name that
|
2525
2590
|
# resolves to a private IP address.
|
2526
2591
|
#
|
2527
2592
|
# Default: The default behavior varies depending on whether
|
@@ -2547,20 +2612,11 @@ module Aws::RDS
|
|
2547
2612
|
# @return [Boolean]
|
2548
2613
|
#
|
2549
2614
|
# @!attribute [rw] tags
|
2550
|
-
#
|
2551
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
2552
|
-
#
|
2553
|
-
#
|
2554
|
-
#
|
2555
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
2615
|
+
# Tags to assign to the DB instance.
|
2556
2616
|
# @return [Array<Types::Tag>]
|
2557
2617
|
#
|
2558
2618
|
# @!attribute [rw] db_cluster_identifier
|
2559
2619
|
# The identifier of the DB cluster that the instance will belong to.
|
2560
|
-
#
|
2561
|
-
# For information on creating a DB cluster, see CreateDBCluster.
|
2562
|
-
#
|
2563
|
-
# Type: String
|
2564
2620
|
# @return [String]
|
2565
2621
|
#
|
2566
2622
|
# @!attribute [rw] storage_type
|
@@ -2571,8 +2627,7 @@ module Aws::RDS
|
|
2571
2627
|
# If you specify `io1`, you must also include a value for the `Iops`
|
2572
2628
|
# parameter.
|
2573
2629
|
#
|
2574
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
2575
|
-
# `standard`
|
2630
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
2576
2631
|
# @return [String]
|
2577
2632
|
#
|
2578
2633
|
# @!attribute [rw] tde_credential_arn
|
@@ -2586,14 +2641,13 @@ module Aws::RDS
|
|
2586
2641
|
# @return [String]
|
2587
2642
|
#
|
2588
2643
|
# @!attribute [rw] storage_encrypted
|
2589
|
-
#
|
2644
|
+
# A value that indicates whether the DB instance is encrypted. By
|
2645
|
+
# default, it is not encrypted.
|
2590
2646
|
#
|
2591
2647
|
# **Amazon Aurora**
|
2592
2648
|
#
|
2593
2649
|
# Not applicable. The encryption for DB instances is managed by the DB
|
2594
|
-
# cluster.
|
2595
|
-
#
|
2596
|
-
# Default: false
|
2650
|
+
# cluster.
|
2597
2651
|
# @return [Boolean]
|
2598
2652
|
#
|
2599
2653
|
# @!attribute [rw] kms_key_id
|
@@ -2608,29 +2662,38 @@ module Aws::RDS
|
|
2608
2662
|
# **Amazon Aurora**
|
2609
2663
|
#
|
2610
2664
|
# Not applicable. The KMS key identifier is managed by the DB cluster.
|
2611
|
-
# For more information, see CreateDBCluster
|
2665
|
+
# For more information, see `CreateDBCluster`.
|
2612
2666
|
#
|
2613
|
-
# If
|
2614
|
-
#
|
2615
|
-
#
|
2616
|
-
#
|
2617
|
-
#
|
2667
|
+
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
2668
|
+
# the `KmsKeyId` parameter, then Amazon RDS will use your default
|
2669
|
+
# encryption key. AWS KMS creates the default encryption key for your
|
2670
|
+
# AWS account. Your AWS account has a different default encryption key
|
2671
|
+
# for each AWS Region.
|
2618
2672
|
# @return [String]
|
2619
2673
|
#
|
2620
2674
|
# @!attribute [rw] domain
|
2621
|
-
#
|
2675
|
+
# For an Amazon RDS DB instance that's running Microsoft SQL Server,
|
2676
|
+
# this parameter specifies the Active Directory directory ID to create
|
2677
|
+
# the instance in. Amazon RDS uses Windows Authentication to
|
2678
|
+
# authenticate users that connect to the DB instance. For more
|
2679
|
+
# information, see [Using Windows Authentication with an Amazon RDS DB
|
2680
|
+
# Instance Running Microsoft SQL Server][1] in the *Amazon RDS User
|
2681
|
+
# Guide*.
|
2682
|
+
#
|
2683
|
+
#
|
2684
|
+
#
|
2685
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html
|
2622
2686
|
# @return [String]
|
2623
2687
|
#
|
2624
2688
|
# @!attribute [rw] copy_tags_to_snapshot
|
2625
|
-
#
|
2626
|
-
#
|
2689
|
+
# A value that indicates whether to copy tags from the DB instance to
|
2690
|
+
# snapshots of the DB instance. By default, tags are not copied.
|
2627
2691
|
#
|
2628
2692
|
# **Amazon Aurora**
|
2629
2693
|
#
|
2630
2694
|
# Not applicable. Copying tags to snapshots is managed by the DB
|
2631
2695
|
# cluster. Setting this value for an Aurora DB instance has no effect
|
2632
|
-
# on the DB cluster setting.
|
2633
|
-
# CreateDBCluster.
|
2696
|
+
# on the DB cluster setting.
|
2634
2697
|
# @return [Boolean]
|
2635
2698
|
#
|
2636
2699
|
# @!attribute [rw] monitoring_interval
|
@@ -2689,8 +2752,9 @@ module Aws::RDS
|
|
2689
2752
|
# @return [String]
|
2690
2753
|
#
|
2691
2754
|
# @!attribute [rw] enable_iam_database_authentication
|
2692
|
-
#
|
2693
|
-
# accounts to database accounts
|
2755
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
2756
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
2757
|
+
# mapping is disabled.
|
2694
2758
|
#
|
2695
2759
|
# You can enable IAM database authentication for the following
|
2696
2760
|
# database engines:
|
@@ -2698,21 +2762,18 @@ module Aws::RDS
|
|
2698
2762
|
# **Amazon Aurora**
|
2699
2763
|
#
|
2700
2764
|
# Not applicable. Mapping AWS IAM accounts to database accounts is
|
2701
|
-
# managed by the DB cluster.
|
2702
|
-
# CreateDBCluster.
|
2765
|
+
# managed by the DB cluster.
|
2703
2766
|
#
|
2704
2767
|
# **MySQL**
|
2705
2768
|
#
|
2706
2769
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
2707
2770
|
#
|
2708
2771
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
2709
|
-
#
|
2710
|
-
# Default: `false`
|
2711
2772
|
# @return [Boolean]
|
2712
2773
|
#
|
2713
2774
|
# @!attribute [rw] enable_performance_insights
|
2714
|
-
#
|
2715
|
-
#
|
2775
|
+
# A value that indicates whether to enable Performance Insights for
|
2776
|
+
# the DB instance.
|
2716
2777
|
#
|
2717
2778
|
# For more information, see [Using Amazon Performance Insights][1] in
|
2718
2779
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -2726,6 +2787,11 @@ module Aws::RDS
|
|
2726
2787
|
# The AWS KMS key identifier for encryption of Performance Insights
|
2727
2788
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
2728
2789
|
# identifier, or the KMS key alias for the KMS encryption key.
|
2790
|
+
#
|
2791
|
+
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
2792
|
+
# then Amazon RDS uses your default encryption key. AWS KMS creates
|
2793
|
+
# the default encryption key for your AWS account. Your AWS account
|
2794
|
+
# has a different default encryption key for each AWS Region.
|
2729
2795
|
# @return [String]
|
2730
2796
|
#
|
2731
2797
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -2751,10 +2817,10 @@ module Aws::RDS
|
|
2751
2817
|
# @return [Array<Types::ProcessorFeature>]
|
2752
2818
|
#
|
2753
2819
|
# @!attribute [rw] deletion_protection
|
2754
|
-
#
|
2755
|
-
# enabled. The database can't be deleted when
|
2756
|
-
#
|
2757
|
-
# DB Instance][1].
|
2820
|
+
# A value that indicates whether the DB instance has deletion
|
2821
|
+
# protection enabled. The database can't be deleted when deletion
|
2822
|
+
# protection is enabled. By default, deletion protection is disabled.
|
2823
|
+
# For more information, see [ Deleting a DB Instance][1].
|
2758
2824
|
#
|
2759
2825
|
#
|
2760
2826
|
#
|
@@ -2914,8 +2980,7 @@ module Aws::RDS
|
|
2914
2980
|
# @return [String]
|
2915
2981
|
#
|
2916
2982
|
# @!attribute [rw] availability_zone
|
2917
|
-
# The
|
2918
|
-
# in.
|
2983
|
+
# The Availability Zone (AZ) where the Read Replica will be created.
|
2919
2984
|
#
|
2920
2985
|
# Default: A random, system-chosen Availability Zone in the
|
2921
2986
|
# endpoint's AWS Region.
|
@@ -2932,7 +2997,8 @@ module Aws::RDS
|
|
2932
2997
|
# @return [Integer]
|
2933
2998
|
#
|
2934
2999
|
# @!attribute [rw] multi_az
|
2935
|
-
#
|
3000
|
+
# A value that indicates whether the Read Replica is in a Multi-AZ
|
3001
|
+
# deployment.
|
2936
3002
|
#
|
2937
3003
|
# You can create a Read Replica as a Multi-AZ DB instance. RDS creates
|
2938
3004
|
# a standby of your replica in another Availability Zone for failover
|
@@ -2942,8 +3008,8 @@ module Aws::RDS
|
|
2942
3008
|
# @return [Boolean]
|
2943
3009
|
#
|
2944
3010
|
# @!attribute [rw] auto_minor_version_upgrade
|
2945
|
-
#
|
2946
|
-
# the Read Replica during the maintenance window.
|
3011
|
+
# A value that indicates whether minor engine upgrades are applied
|
3012
|
+
# automatically to the Read Replica during the maintenance window.
|
2947
3013
|
#
|
2948
3014
|
# Default: Inherits from the source DB instance
|
2949
3015
|
# @return [Boolean]
|
@@ -2959,10 +3025,11 @@ module Aws::RDS
|
|
2959
3025
|
# @return [String]
|
2960
3026
|
#
|
2961
3027
|
# @!attribute [rw] publicly_accessible
|
2962
|
-
#
|
2963
|
-
#
|
2964
|
-
#
|
2965
|
-
#
|
3028
|
+
# A value that indicates whether the DB instance is publicly
|
3029
|
+
# accessible. When the DB instance is publicly accessible, it is an
|
3030
|
+
# Internet-facing instance with a publicly resolvable DNS name, which
|
3031
|
+
# resolves to a public IP address. When the DB instance is not
|
3032
|
+
# publicly accessible, it is an internal instance with a DNS name that
|
2966
3033
|
# resolves to a private IP address. For more information, see
|
2967
3034
|
# CreateDBInstance.
|
2968
3035
|
# @return [Boolean]
|
@@ -3020,13 +3087,13 @@ module Aws::RDS
|
|
3020
3087
|
# If you specify `io1`, you must also include a value for the `Iops`
|
3021
3088
|
# parameter.
|
3022
3089
|
#
|
3023
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
3024
|
-
# `standard`
|
3090
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
3025
3091
|
# @return [String]
|
3026
3092
|
#
|
3027
3093
|
# @!attribute [rw] copy_tags_to_snapshot
|
3028
|
-
#
|
3029
|
-
# Replica
|
3094
|
+
# A value that indicates whether to copy all tags from the Read
|
3095
|
+
# Replica to snapshots of the Read Replica. By default, tags are not
|
3096
|
+
# copied.
|
3030
3097
|
# @return [Boolean]
|
3031
3098
|
#
|
3032
3099
|
# @!attribute [rw] monitoring_interval
|
@@ -3130,8 +3197,9 @@ module Aws::RDS
|
|
3130
3197
|
# @return [String]
|
3131
3198
|
#
|
3132
3199
|
# @!attribute [rw] enable_iam_database_authentication
|
3133
|
-
#
|
3134
|
-
# accounts to database accounts
|
3200
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
3201
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
3202
|
+
# mapping is disabled.
|
3135
3203
|
#
|
3136
3204
|
# You can enable IAM database authentication for the following
|
3137
3205
|
# database engines
|
@@ -3141,13 +3209,11 @@ module Aws::RDS
|
|
3141
3209
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
3142
3210
|
#
|
3143
3211
|
# * Aurora MySQL 5.6 or higher
|
3144
|
-
#
|
3145
|
-
# Default: `false`
|
3146
3212
|
# @return [Boolean]
|
3147
3213
|
#
|
3148
3214
|
# @!attribute [rw] enable_performance_insights
|
3149
|
-
#
|
3150
|
-
#
|
3215
|
+
# A value that indicates whether to enable Performance Insights for
|
3216
|
+
# the Read Replica.
|
3151
3217
|
#
|
3152
3218
|
# For more information, see [Using Amazon Performance Insights][1] in
|
3153
3219
|
# the *Amazon RDS User Guide*.
|
@@ -3161,6 +3227,11 @@ module Aws::RDS
|
|
3161
3227
|
# The AWS KMS key identifier for encryption of Performance Insights
|
3162
3228
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
3163
3229
|
# identifier, or the KMS key alias for the KMS encryption key.
|
3230
|
+
#
|
3231
|
+
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
3232
|
+
# then Amazon RDS uses your default encryption key. AWS KMS creates
|
3233
|
+
# the default encryption key for your AWS account. Your AWS account
|
3234
|
+
# has a different default encryption key for each AWS Region.
|
3164
3235
|
# @return [String]
|
3165
3236
|
#
|
3166
3237
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -3185,15 +3256,15 @@ module Aws::RDS
|
|
3185
3256
|
# @return [Array<Types::ProcessorFeature>]
|
3186
3257
|
#
|
3187
3258
|
# @!attribute [rw] use_default_processor_features
|
3188
|
-
# A value that
|
3189
|
-
# uses its default processor features.
|
3259
|
+
# A value that indicates whether the DB instance class of the DB
|
3260
|
+
# instance uses its default processor features.
|
3190
3261
|
# @return [Boolean]
|
3191
3262
|
#
|
3192
3263
|
# @!attribute [rw] deletion_protection
|
3193
|
-
#
|
3194
|
-
# enabled. The database can't be deleted when
|
3195
|
-
#
|
3196
|
-
# DB Instance][1].
|
3264
|
+
# A value that indicates whether the DB instance has deletion
|
3265
|
+
# protection enabled. The database can't be deleted when deletion
|
3266
|
+
# protection is enabled. By default, deletion protection is disabled.
|
3267
|
+
# For more information, see [ Deleting a DB Instance][1].
|
3197
3268
|
#
|
3198
3269
|
#
|
3199
3270
|
#
|
@@ -3247,7 +3318,7 @@ module Aws::RDS
|
|
3247
3318
|
# Contains the details of an Amazon RDS DB instance.
|
3248
3319
|
#
|
3249
3320
|
# This data type is used as a response element in the
|
3250
|
-
# DescribeDBInstances action.
|
3321
|
+
# `DescribeDBInstances` action.
|
3251
3322
|
# @return [Types::DBInstance]
|
3252
3323
|
#
|
3253
3324
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplicaResult AWS API Documentation
|
@@ -3261,7 +3332,7 @@ module Aws::RDS
|
|
3261
3332
|
# Contains the details of an Amazon RDS DB instance.
|
3262
3333
|
#
|
3263
3334
|
# This data type is used as a response element in the
|
3264
|
-
# DescribeDBInstances action.
|
3335
|
+
# `DescribeDBInstances` action.
|
3265
3336
|
# @return [Types::DBInstance]
|
3266
3337
|
#
|
3267
3338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceResult AWS API Documentation
|
@@ -3324,12 +3395,7 @@ module Aws::RDS
|
|
3324
3395
|
# @return [String]
|
3325
3396
|
#
|
3326
3397
|
# @!attribute [rw] tags
|
3327
|
-
#
|
3328
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
3329
|
-
#
|
3330
|
-
#
|
3331
|
-
#
|
3332
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
3398
|
+
# Tags to assign to the DB parameter group.
|
3333
3399
|
# @return [Array<Types::Tag>]
|
3334
3400
|
#
|
3335
3401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBParameterGroupMessage AWS API Documentation
|
@@ -3346,7 +3412,7 @@ module Aws::RDS
|
|
3346
3412
|
# Contains the details of an Amazon RDS DB parameter group.
|
3347
3413
|
#
|
3348
3414
|
# This data type is used as a response element in the
|
3349
|
-
# DescribeDBParameterGroups action.
|
3415
|
+
# `DescribeDBParameterGroups` action.
|
3350
3416
|
# @return [Types::DBParameterGroup]
|
3351
3417
|
#
|
3352
3418
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBParameterGroupResult AWS API Documentation
|
@@ -3392,12 +3458,7 @@ module Aws::RDS
|
|
3392
3458
|
# @return [String]
|
3393
3459
|
#
|
3394
3460
|
# @!attribute [rw] tags
|
3395
|
-
#
|
3396
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
3397
|
-
#
|
3398
|
-
#
|
3399
|
-
#
|
3400
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
3461
|
+
# Tags to assign to the DB security group.
|
3401
3462
|
# @return [Array<Types::Tag>]
|
3402
3463
|
#
|
3403
3464
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSecurityGroupMessage AWS API Documentation
|
@@ -3413,7 +3474,7 @@ module Aws::RDS
|
|
3413
3474
|
# Contains the details for an Amazon RDS DB security group.
|
3414
3475
|
#
|
3415
3476
|
# This data type is used as a response element in the
|
3416
|
-
# DescribeDBSecurityGroups action.
|
3477
|
+
# `DescribeDBSecurityGroups` action.
|
3417
3478
|
# @return [Types::DBSecurityGroup]
|
3418
3479
|
#
|
3419
3480
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSecurityGroupResult AWS API Documentation
|
@@ -3486,7 +3547,7 @@ module Aws::RDS
|
|
3486
3547
|
# Contains the details of an Amazon RDS DB snapshot.
|
3487
3548
|
#
|
3488
3549
|
# This data type is used as a response element in the
|
3489
|
-
# DescribeDBSnapshots action.
|
3550
|
+
# `DescribeDBSnapshots` action.
|
3490
3551
|
# @return [Types::DBSnapshot]
|
3491
3552
|
#
|
3492
3553
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSnapshotResult AWS API Documentation
|
@@ -3530,12 +3591,7 @@ module Aws::RDS
|
|
3530
3591
|
# @return [Array<String>]
|
3531
3592
|
#
|
3532
3593
|
# @!attribute [rw] tags
|
3533
|
-
#
|
3534
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
3535
|
-
#
|
3536
|
-
#
|
3537
|
-
#
|
3538
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
3594
|
+
# Tags to assign to the DB subnet group.
|
3539
3595
|
# @return [Array<Types::Tag>]
|
3540
3596
|
#
|
3541
3597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSubnetGroupMessage AWS API Documentation
|
@@ -3552,7 +3608,7 @@ module Aws::RDS
|
|
3552
3608
|
# Contains the details of an Amazon RDS DB subnet group.
|
3553
3609
|
#
|
3554
3610
|
# This data type is used as a response element in the
|
3555
|
-
# DescribeDBSubnetGroups action.
|
3611
|
+
# `DescribeDBSubnetGroups` action.
|
3556
3612
|
# @return [Types::DBSubnetGroup]
|
3557
3613
|
#
|
3558
3614
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSubnetGroupResult AWS API Documentation
|
@@ -3638,8 +3694,9 @@ module Aws::RDS
|
|
3638
3694
|
# @return [Array<String>]
|
3639
3695
|
#
|
3640
3696
|
# @!attribute [rw] enabled
|
3641
|
-
# A
|
3642
|
-
#
|
3697
|
+
# A value that indicates whether to activate the subscription. If the
|
3698
|
+
# event notification subscription is not activated, the subscription
|
3699
|
+
# is created but not active.
|
3643
3700
|
# @return [Boolean]
|
3644
3701
|
#
|
3645
3702
|
# @!attribute [rw] tags
|
@@ -3666,7 +3723,7 @@ module Aws::RDS
|
|
3666
3723
|
|
3667
3724
|
# @!attribute [rw] event_subscription
|
3668
3725
|
# Contains the results of a successful invocation of the
|
3669
|
-
# DescribeEventSubscriptions action.
|
3726
|
+
# `DescribeEventSubscriptions` action.
|
3670
3727
|
# @return [Types::EventSubscription]
|
3671
3728
|
#
|
3672
3729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateEventSubscriptionResult AWS API Documentation
|
@@ -3709,7 +3766,8 @@ module Aws::RDS
|
|
3709
3766
|
#
|
3710
3767
|
# @!attribute [rw] deletion_protection
|
3711
3768
|
# The deletion protection setting for the new global database. The
|
3712
|
-
# global database can't be deleted when
|
3769
|
+
# global database can't be deleted when deletion protection is
|
3770
|
+
# enabled.
|
3713
3771
|
# @return [Boolean]
|
3714
3772
|
#
|
3715
3773
|
# @!attribute [rw] database_name
|
@@ -3791,12 +3849,7 @@ module Aws::RDS
|
|
3791
3849
|
# @return [String]
|
3792
3850
|
#
|
3793
3851
|
# @!attribute [rw] tags
|
3794
|
-
#
|
3795
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
3796
|
-
#
|
3797
|
-
#
|
3798
|
-
#
|
3799
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
3852
|
+
# Tags to assign to the option group.
|
3800
3853
|
# @return [Array<Types::Tag>]
|
3801
3854
|
#
|
3802
3855
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateOptionGroupMessage AWS API Documentation
|
@@ -3823,7 +3876,7 @@ module Aws::RDS
|
|
3823
3876
|
# Contains the details of an Amazon Aurora DB cluster.
|
3824
3877
|
#
|
3825
3878
|
# This data type is used as a response element in the
|
3826
|
-
# DescribeDBClusters
|
3879
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
3827
3880
|
#
|
3828
3881
|
# @!attribute [rw] allocated_storage
|
3829
3882
|
# For all database engines except Amazon Aurora, `AllocatedStorage`
|
@@ -3834,8 +3887,8 @@ module Aws::RDS
|
|
3834
3887
|
# @return [Integer]
|
3835
3888
|
#
|
3836
3889
|
# @!attribute [rw] availability_zones
|
3837
|
-
# Provides the list of
|
3838
|
-
# cluster can be created
|
3890
|
+
# Provides the list of Availability Zones (AZs) where instances in the
|
3891
|
+
# DB cluster can be created.
|
3839
3892
|
# @return [Array<String>]
|
3840
3893
|
#
|
3841
3894
|
# @!attribute [rw] backup_retention_period
|
@@ -3980,7 +4033,7 @@ module Aws::RDS
|
|
3980
4033
|
# @return [Boolean]
|
3981
4034
|
#
|
3982
4035
|
# @!attribute [rw] kms_key_id
|
3983
|
-
# If `StorageEncrypted` is
|
4036
|
+
# If `StorageEncrypted` is enabled, the AWS KMS key identifier for the
|
3984
4037
|
# encrypted DB cluster.
|
3985
4038
|
# @return [String]
|
3986
4039
|
#
|
@@ -4002,8 +4055,8 @@ module Aws::RDS
|
|
4002
4055
|
# @return [Array<Types::DBClusterRole>]
|
4003
4056
|
#
|
4004
4057
|
# @!attribute [rw] iam_database_authentication_enabled
|
4005
|
-
#
|
4006
|
-
# to database accounts is enabled
|
4058
|
+
# A value that indicates whether the mapping of AWS Identity and
|
4059
|
+
# Access Management (IAM) accounts to database accounts is enabled.
|
4007
4060
|
# @return [Boolean]
|
4008
4061
|
#
|
4009
4062
|
# @!attribute [rw] clone_group_id
|
@@ -4073,7 +4126,7 @@ module Aws::RDS
|
|
4073
4126
|
#
|
4074
4127
|
# @!attribute [rw] deletion_protection
|
4075
4128
|
# Indicates if the DB cluster has deletion protection enabled. The
|
4076
|
-
# database can't be deleted when
|
4129
|
+
# database can't be deleted when deletion protection is enabled.
|
4077
4130
|
# @return [Boolean]
|
4078
4131
|
#
|
4079
4132
|
# @!attribute [rw] http_endpoint_enabled
|
@@ -4082,8 +4135,8 @@ module Aws::RDS
|
|
4082
4135
|
#
|
4083
4136
|
# </note>
|
4084
4137
|
#
|
4085
|
-
#
|
4086
|
-
# DB cluster is enabled
|
4138
|
+
# A value that indicates whether the HTTP endpoint for an Aurora
|
4139
|
+
# Serverless DB cluster is enabled.
|
4087
4140
|
#
|
4088
4141
|
# When enabled, the HTTP endpoint provides a connectionless web
|
4089
4142
|
# service API for running SQL queries on the Aurora Serverless DB
|
@@ -4156,7 +4209,7 @@ module Aws::RDS
|
|
4156
4209
|
end
|
4157
4210
|
|
4158
4211
|
# This data type is used as a response element in the
|
4159
|
-
# DescribeDBClusterBacktracks action.
|
4212
|
+
# `DescribeDBClusterBacktracks` action.
|
4160
4213
|
#
|
4161
4214
|
# @!attribute [rw] db_cluster_identifier
|
4162
4215
|
# Contains a user-supplied DB cluster identifier. This identifier is
|
@@ -4209,11 +4262,11 @@ module Aws::RDS
|
|
4209
4262
|
end
|
4210
4263
|
|
4211
4264
|
# Contains the result of a successful invocation of the
|
4212
|
-
# DescribeDBClusterBacktracks action.
|
4265
|
+
# `DescribeDBClusterBacktracks` action.
|
4213
4266
|
#
|
4214
4267
|
# @!attribute [rw] marker
|
4215
4268
|
# A pagination token that can be used in a subsequent
|
4216
|
-
# DescribeDBClusterBacktracks request.
|
4269
|
+
# `DescribeDBClusterBacktracks` request.
|
4217
4270
|
# @return [String]
|
4218
4271
|
#
|
4219
4272
|
# @!attribute [rw] db_cluster_backtracks
|
@@ -4267,16 +4320,16 @@ module Aws::RDS
|
|
4267
4320
|
# Amazon Aurora DB cluster. This data type is used as a response element
|
4268
4321
|
# in the following actions:
|
4269
4322
|
#
|
4270
|
-
# * CreateDBClusterEndpoint
|
4323
|
+
# * `CreateDBClusterEndpoint`
|
4271
4324
|
#
|
4272
|
-
# * DescribeDBClusterEndpoints
|
4325
|
+
# * `DescribeDBClusterEndpoints`
|
4273
4326
|
#
|
4274
|
-
# * ModifyDBClusterEndpoint
|
4327
|
+
# * `ModifyDBClusterEndpoint`
|
4275
4328
|
#
|
4276
|
-
# * DeleteDBClusterEndpoint
|
4329
|
+
# * `DeleteDBClusterEndpoint`
|
4277
4330
|
#
|
4278
4331
|
# For the data structure that represents Amazon RDS DB instance
|
4279
|
-
# endpoints, see Endpoint
|
4332
|
+
# endpoints, see `Endpoint`.
|
4280
4333
|
#
|
4281
4334
|
# @!attribute [rw] db_cluster_endpoint_identifier
|
4282
4335
|
# The identifier associated with the endpoint. This parameter is
|
@@ -4344,9 +4397,9 @@ module Aws::RDS
|
|
4344
4397
|
|
4345
4398
|
# @!attribute [rw] marker
|
4346
4399
|
# An optional pagination token provided by a previous
|
4347
|
-
# DescribeDBClusterEndpoints request. If this parameter is
|
4348
|
-
# the response includes only records beyond the marker, up
|
4349
|
-
# value specified by `MaxRecords`.
|
4400
|
+
# `DescribeDBClusterEndpoints` request. If this parameter is
|
4401
|
+
# specified, the response includes only records beyond the marker, up
|
4402
|
+
# to the value specified by `MaxRecords`.
|
4350
4403
|
# @return [String]
|
4351
4404
|
#
|
4352
4405
|
# @!attribute [rw] db_cluster_endpoints
|
@@ -4369,8 +4422,8 @@ module Aws::RDS
|
|
4369
4422
|
# @return [String]
|
4370
4423
|
#
|
4371
4424
|
# @!attribute [rw] is_cluster_writer
|
4372
|
-
#
|
4373
|
-
# for the DB cluster
|
4425
|
+
# A value that indicates whehter the cluster member is the primary
|
4426
|
+
# instance for the DB cluster.
|
4374
4427
|
# @return [Boolean]
|
4375
4428
|
#
|
4376
4429
|
# @!attribute [rw] db_cluster_parameter_group_status
|
@@ -4400,7 +4453,7 @@ module Aws::RDS
|
|
4400
4453
|
end
|
4401
4454
|
|
4402
4455
|
# Contains the result of a successful invocation of the
|
4403
|
-
# DescribeDBClusters action.
|
4456
|
+
# `DescribeDBClusters` action.
|
4404
4457
|
#
|
4405
4458
|
# @!attribute [rw] marker
|
4406
4459
|
# A pagination token that can be used in a subsequent
|
@@ -4440,7 +4493,7 @@ module Aws::RDS
|
|
4440
4493
|
# Contains the details of an Amazon RDS DB cluster parameter group.
|
4441
4494
|
#
|
4442
4495
|
# This data type is used as a response element in the
|
4443
|
-
# DescribeDBClusterParameterGroups action.
|
4496
|
+
# `DescribeDBClusterParameterGroups` action.
|
4444
4497
|
#
|
4445
4498
|
# @!attribute [rw] db_cluster_parameter_group_name
|
4446
4499
|
# Provides the name of the DB cluster parameter group.
|
@@ -4575,11 +4628,11 @@ module Aws::RDS
|
|
4575
4628
|
# Contains the details for an Amazon RDS DB cluster snapshot
|
4576
4629
|
#
|
4577
4630
|
# This data type is used as a response element in the
|
4578
|
-
# DescribeDBClusterSnapshots action.
|
4631
|
+
# `DescribeDBClusterSnapshots` action.
|
4579
4632
|
#
|
4580
4633
|
# @!attribute [rw] availability_zones
|
4581
|
-
# Provides the list of
|
4582
|
-
# cluster snapshot can be restored
|
4634
|
+
# Provides the list of Availability Zones (AZs) where instances in the
|
4635
|
+
# DB cluster snapshot can be restored.
|
4583
4636
|
# @return [Array<String>]
|
4584
4637
|
#
|
4585
4638
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
@@ -4699,7 +4752,7 @@ module Aws::RDS
|
|
4699
4752
|
#
|
4700
4753
|
# Manual DB cluster snapshot attributes are used to authorize other AWS
|
4701
4754
|
# accounts to restore a manual DB cluster snapshot. For more
|
4702
|
-
# information, see the ModifyDBClusterSnapshotAttribute API action.
|
4755
|
+
# information, see the `ModifyDBClusterSnapshotAttribute` API action.
|
4703
4756
|
#
|
4704
4757
|
# @!attribute [rw] attribute_name
|
4705
4758
|
# The name of the manual DB cluster snapshot attribute.
|
@@ -4707,7 +4760,7 @@ module Aws::RDS
|
|
4707
4760
|
# The attribute named `restore` refers to the list of AWS accounts
|
4708
4761
|
# that have permission to copy or restore the manual DB cluster
|
4709
4762
|
# snapshot. For more information, see the
|
4710
|
-
# ModifyDBClusterSnapshotAttribute API action.
|
4763
|
+
# `ModifyDBClusterSnapshotAttribute` API action.
|
4711
4764
|
# @return [String]
|
4712
4765
|
#
|
4713
4766
|
# @!attribute [rw] attribute_values
|
@@ -4729,11 +4782,11 @@ module Aws::RDS
|
|
4729
4782
|
end
|
4730
4783
|
|
4731
4784
|
# Contains the results of a successful call to the
|
4732
|
-
# DescribeDBClusterSnapshotAttributes API action.
|
4785
|
+
# `DescribeDBClusterSnapshotAttributes` API action.
|
4733
4786
|
#
|
4734
4787
|
# Manual DB cluster snapshot attributes are used to authorize other AWS
|
4735
4788
|
# accounts to copy or restore a manual DB cluster snapshot. For more
|
4736
|
-
# information, see the ModifyDBClusterSnapshotAttribute API action.
|
4789
|
+
# information, see the `ModifyDBClusterSnapshotAttribute` API action.
|
4737
4790
|
#
|
4738
4791
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
4739
4792
|
# The identifier of the manual DB cluster snapshot that the attributes
|
@@ -4754,13 +4807,13 @@ module Aws::RDS
|
|
4754
4807
|
end
|
4755
4808
|
|
4756
4809
|
# Provides a list of DB cluster snapshots for the user as the result of
|
4757
|
-
# a call to the DescribeDBClusterSnapshots action.
|
4810
|
+
# a call to the `DescribeDBClusterSnapshots` action.
|
4758
4811
|
#
|
4759
4812
|
# @!attribute [rw] marker
|
4760
4813
|
# An optional pagination token provided by a previous
|
4761
|
-
# DescribeDBClusterSnapshots request. If this parameter is
|
4762
|
-
# the response includes only records beyond the marker, up
|
4763
|
-
# value specified by `MaxRecords`.
|
4814
|
+
# `DescribeDBClusterSnapshots` request. If this parameter is
|
4815
|
+
# specified, the response includes only records beyond the marker, up
|
4816
|
+
# to the value specified by `MaxRecords`.
|
4764
4817
|
# @return [String]
|
4765
4818
|
#
|
4766
4819
|
# @!attribute [rw] db_cluster_snapshots
|
@@ -4776,7 +4829,7 @@ module Aws::RDS
|
|
4776
4829
|
end
|
4777
4830
|
|
4778
4831
|
# This data type is used as a response element in the action
|
4779
|
-
# DescribeDBEngineVersions
|
4832
|
+
# `DescribeDBEngineVersions`.
|
4780
4833
|
#
|
4781
4834
|
# @!attribute [rw] engine
|
4782
4835
|
# The name of the database engine.
|
@@ -4868,7 +4921,7 @@ module Aws::RDS
|
|
4868
4921
|
end
|
4869
4922
|
|
4870
4923
|
# Contains the result of a successful invocation of the
|
4871
|
-
# DescribeDBEngineVersions action.
|
4924
|
+
# `DescribeDBEngineVersions` action.
|
4872
4925
|
#
|
4873
4926
|
# @!attribute [rw] marker
|
4874
4927
|
# An optional pagination token provided by a previous request. If this
|
@@ -4891,7 +4944,7 @@ module Aws::RDS
|
|
4891
4944
|
# Contains the details of an Amazon RDS DB instance.
|
4892
4945
|
#
|
4893
4946
|
# This data type is used as a response element in the
|
4894
|
-
# DescribeDBInstances action.
|
4947
|
+
# `DescribeDBInstances` action.
|
4895
4948
|
#
|
4896
4949
|
# @!attribute [rw] db_instance_identifier
|
4897
4950
|
# Contains a user-supplied database identifier. This identifier is the
|
@@ -4960,7 +5013,7 @@ module Aws::RDS
|
|
4960
5013
|
# @return [Integer]
|
4961
5014
|
#
|
4962
5015
|
# @!attribute [rw] db_security_groups
|
4963
|
-
#
|
5016
|
+
# A list of DB security group elements containing
|
4964
5017
|
# `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements.
|
4965
5018
|
# @return [Array<Types::DBSecurityGroupMembership>]
|
4966
5019
|
#
|
@@ -5124,7 +5177,7 @@ module Aws::RDS
|
|
5124
5177
|
#
|
5125
5178
|
# Not applicable. Copying tags to snapshots is managed by the DB
|
5126
5179
|
# cluster. Setting this value for an Aurora DB instance has no effect
|
5127
|
-
# on the DB cluster setting. For more information, see DBCluster
|
5180
|
+
# on the DB cluster setting. For more information, see `DBCluster`.
|
5128
5181
|
# @return [Boolean]
|
5129
5182
|
#
|
5130
5183
|
# @!attribute [rw] monitoring_interval
|
@@ -5215,8 +5268,8 @@ module Aws::RDS
|
|
5215
5268
|
#
|
5216
5269
|
# @!attribute [rw] deletion_protection
|
5217
5270
|
# Indicates if the DB instance has deletion protection enabled. The
|
5218
|
-
# database can't be deleted when
|
5219
|
-
# information, see [ Deleting a DB Instance][1].
|
5271
|
+
# database can't be deleted when deletion protection is enabled. For
|
5272
|
+
# more information, see [ Deleting a DB Instance][1].
|
5220
5273
|
#
|
5221
5274
|
#
|
5222
5275
|
#
|
@@ -5447,7 +5500,7 @@ module Aws::RDS
|
|
5447
5500
|
end
|
5448
5501
|
|
5449
5502
|
# Contains the result of a successful invocation of the
|
5450
|
-
# DescribeDBInstanceAutomatedBackups action.
|
5503
|
+
# `DescribeDBInstanceAutomatedBackups` action.
|
5451
5504
|
#
|
5452
5505
|
# @!attribute [rw] marker
|
5453
5506
|
# An optional pagination token provided by a previous request. If this
|
@@ -5456,7 +5509,7 @@ module Aws::RDS
|
|
5456
5509
|
# @return [String]
|
5457
5510
|
#
|
5458
5511
|
# @!attribute [rw] db_instance_automated_backups
|
5459
|
-
# A list of DBInstanceAutomatedBackup instances.
|
5512
|
+
# A list of `DBInstanceAutomatedBackup` instances.
|
5460
5513
|
# @return [Array<Types::DBInstanceAutomatedBackup>]
|
5461
5514
|
#
|
5462
5515
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstanceAutomatedBackupMessage AWS API Documentation
|
@@ -5468,7 +5521,7 @@ module Aws::RDS
|
|
5468
5521
|
end
|
5469
5522
|
|
5470
5523
|
# Contains the result of a successful invocation of the
|
5471
|
-
# DescribeDBInstances action.
|
5524
|
+
# `DescribeDBInstances` action.
|
5472
5525
|
#
|
5473
5526
|
# @!attribute [rw] marker
|
5474
5527
|
# An optional pagination token provided by a previous request. If this
|
@@ -5477,7 +5530,7 @@ module Aws::RDS
|
|
5477
5530
|
# @return [String]
|
5478
5531
|
#
|
5479
5532
|
# @!attribute [rw] db_instances
|
5480
|
-
# A list of DBInstance instances.
|
5533
|
+
# A list of `DBInstance` instances.
|
5481
5534
|
# @return [Array<Types::DBInstance>]
|
5482
5535
|
#
|
5483
5536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstanceMessage AWS API Documentation
|
@@ -5499,7 +5552,7 @@ module Aws::RDS
|
|
5499
5552
|
# @!attribute [rw] feature_name
|
5500
5553
|
# The name of the feature associated with the AWS Identity and Access
|
5501
5554
|
# Management (IAM) role. For the list of supported feature names, see
|
5502
|
-
# DBEngineVersion
|
5555
|
+
# `DBEngineVersion`.
|
5503
5556
|
# @return [String]
|
5504
5557
|
#
|
5505
5558
|
# @!attribute [rw] status
|
@@ -5561,7 +5614,7 @@ module Aws::RDS
|
|
5561
5614
|
# Contains the details of an Amazon RDS DB parameter group.
|
5562
5615
|
#
|
5563
5616
|
# This data type is used as a response element in the
|
5564
|
-
# DescribeDBParameterGroups action.
|
5617
|
+
# `DescribeDBParameterGroups` action.
|
5565
5618
|
#
|
5566
5619
|
# @!attribute [rw] db_parameter_group_name
|
5567
5620
|
# Provides the name of the DB parameter group.
|
@@ -5592,10 +5645,10 @@ module Aws::RDS
|
|
5592
5645
|
end
|
5593
5646
|
|
5594
5647
|
# Contains the result of a successful invocation of the
|
5595
|
-
# DescribeDBParameters action.
|
5648
|
+
# `DescribeDBParameters` action.
|
5596
5649
|
#
|
5597
5650
|
# @!attribute [rw] parameters
|
5598
|
-
# A list of Parameter values.
|
5651
|
+
# A list of `Parameter` values.
|
5599
5652
|
# @return [Array<Types::Parameter>]
|
5600
5653
|
#
|
5601
5654
|
# @!attribute [rw] marker
|
@@ -5613,7 +5666,7 @@ module Aws::RDS
|
|
5613
5666
|
end
|
5614
5667
|
|
5615
5668
|
# Contains the result of a successful invocation of the
|
5616
|
-
# ModifyDBParameterGroup or ResetDBParameterGroup action.
|
5669
|
+
# `ModifyDBParameterGroup` or `ResetDBParameterGroup` action.
|
5617
5670
|
#
|
5618
5671
|
# @!attribute [rw] db_parameter_group_name
|
5619
5672
|
# Provides the name of the DB parameter group.
|
@@ -5630,17 +5683,17 @@ module Aws::RDS
|
|
5630
5683
|
#
|
5631
5684
|
# This data type is used as a response element in the following actions:
|
5632
5685
|
#
|
5633
|
-
# * CreateDBInstance
|
5686
|
+
# * `CreateDBInstance`
|
5634
5687
|
#
|
5635
|
-
# * CreateDBInstanceReadReplica
|
5688
|
+
# * `CreateDBInstanceReadReplica`
|
5636
5689
|
#
|
5637
|
-
# * DeleteDBInstance
|
5690
|
+
# * `DeleteDBInstance`
|
5638
5691
|
#
|
5639
|
-
# * ModifyDBInstance
|
5692
|
+
# * `ModifyDBInstance`
|
5640
5693
|
#
|
5641
|
-
# * RebootDBInstance
|
5694
|
+
# * `RebootDBInstance`
|
5642
5695
|
#
|
5643
|
-
# * RestoreDBInstanceFromDBSnapshot
|
5696
|
+
# * `RestoreDBInstanceFromDBSnapshot`
|
5644
5697
|
#
|
5645
5698
|
# @!attribute [rw] db_parameter_group_name
|
5646
5699
|
# The name of the DP parameter group.
|
@@ -5659,7 +5712,7 @@ module Aws::RDS
|
|
5659
5712
|
end
|
5660
5713
|
|
5661
5714
|
# Contains the result of a successful invocation of the
|
5662
|
-
# DescribeDBParameterGroups action.
|
5715
|
+
# `DescribeDBParameterGroups` action.
|
5663
5716
|
#
|
5664
5717
|
# @!attribute [rw] marker
|
5665
5718
|
# An optional pagination token provided by a previous request. If this
|
@@ -5668,7 +5721,7 @@ module Aws::RDS
|
|
5668
5721
|
# @return [String]
|
5669
5722
|
#
|
5670
5723
|
# @!attribute [rw] db_parameter_groups
|
5671
|
-
# A list of DBParameterGroup instances.
|
5724
|
+
# A list of `DBParameterGroup` instances.
|
5672
5725
|
# @return [Array<Types::DBParameterGroup>]
|
5673
5726
|
#
|
5674
5727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBParameterGroupsMessage AWS API Documentation
|
@@ -5682,7 +5735,7 @@ module Aws::RDS
|
|
5682
5735
|
# Contains the details for an Amazon RDS DB security group.
|
5683
5736
|
#
|
5684
5737
|
# This data type is used as a response element in the
|
5685
|
-
# DescribeDBSecurityGroups action.
|
5738
|
+
# `DescribeDBSecurityGroups` action.
|
5686
5739
|
#
|
5687
5740
|
# @!attribute [rw] owner_id
|
5688
5741
|
# Provides the AWS ID of the owner of a specific DB security group.
|
@@ -5701,11 +5754,11 @@ module Aws::RDS
|
|
5701
5754
|
# @return [String]
|
5702
5755
|
#
|
5703
5756
|
# @!attribute [rw] ec2_security_groups
|
5704
|
-
# Contains a list of EC2SecurityGroup elements.
|
5757
|
+
# Contains a list of `EC2SecurityGroup` elements.
|
5705
5758
|
# @return [Array<Types::EC2SecurityGroup>]
|
5706
5759
|
#
|
5707
5760
|
# @!attribute [rw] ip_ranges
|
5708
|
-
# Contains a list of IPRange elements.
|
5761
|
+
# Contains a list of `IPRange` elements.
|
5709
5762
|
# @return [Array<Types::IPRange>]
|
5710
5763
|
#
|
5711
5764
|
# @!attribute [rw] db_security_group_arn
|
@@ -5727,13 +5780,13 @@ module Aws::RDS
|
|
5727
5780
|
|
5728
5781
|
# This data type is used as a response element in the following actions:
|
5729
5782
|
#
|
5730
|
-
# * ModifyDBInstance
|
5783
|
+
# * `ModifyDBInstance`
|
5731
5784
|
#
|
5732
|
-
# * RebootDBInstance
|
5785
|
+
# * `RebootDBInstance`
|
5733
5786
|
#
|
5734
|
-
# * RestoreDBInstanceFromDBSnapshot
|
5787
|
+
# * `RestoreDBInstanceFromDBSnapshot`
|
5735
5788
|
#
|
5736
|
-
# * RestoreDBInstanceToPointInTime
|
5789
|
+
# * `RestoreDBInstanceToPointInTime`
|
5737
5790
|
#
|
5738
5791
|
# @!attribute [rw] db_security_group_name
|
5739
5792
|
# The name of the DB security group.
|
@@ -5752,7 +5805,7 @@ module Aws::RDS
|
|
5752
5805
|
end
|
5753
5806
|
|
5754
5807
|
# Contains the result of a successful invocation of the
|
5755
|
-
# DescribeDBSecurityGroups action.
|
5808
|
+
# `DescribeDBSecurityGroups` action.
|
5756
5809
|
#
|
5757
5810
|
# @!attribute [rw] marker
|
5758
5811
|
# An optional pagination token provided by a previous request. If this
|
@@ -5761,7 +5814,7 @@ module Aws::RDS
|
|
5761
5814
|
# @return [String]
|
5762
5815
|
#
|
5763
5816
|
# @!attribute [rw] db_security_groups
|
5764
|
-
# A list of DBSecurityGroup instances.
|
5817
|
+
# A list of `DBSecurityGroup` instances.
|
5765
5818
|
# @return [Array<Types::DBSecurityGroup>]
|
5766
5819
|
#
|
5767
5820
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBSecurityGroupMessage AWS API Documentation
|
@@ -5775,7 +5828,7 @@ module Aws::RDS
|
|
5775
5828
|
# Contains the details of an Amazon RDS DB snapshot.
|
5776
5829
|
#
|
5777
5830
|
# This data type is used as a response element in the
|
5778
|
-
# DescribeDBSnapshots action.
|
5831
|
+
# `DescribeDBSnapshots` action.
|
5779
5832
|
#
|
5780
5833
|
# @!attribute [rw] db_snapshot_identifier
|
5781
5834
|
# Specifies the identifier for the DB snapshot.
|
@@ -5944,14 +5997,14 @@ module Aws::RDS
|
|
5944
5997
|
#
|
5945
5998
|
# Manual DB snapshot attributes are used to authorize other AWS accounts
|
5946
5999
|
# to restore a manual DB snapshot. For more information, see the
|
5947
|
-
# ModifyDBSnapshotAttribute API.
|
6000
|
+
# `ModifyDBSnapshotAttribute` API.
|
5948
6001
|
#
|
5949
6002
|
# @!attribute [rw] attribute_name
|
5950
6003
|
# The name of the manual DB snapshot attribute.
|
5951
6004
|
#
|
5952
6005
|
# The attribute named `restore` refers to the list of AWS accounts
|
5953
6006
|
# that have permission to copy or restore the manual DB cluster
|
5954
|
-
# snapshot. For more information, see the ModifyDBSnapshotAttribute
|
6007
|
+
# snapshot. For more information, see the `ModifyDBSnapshotAttribute`
|
5955
6008
|
# API action.
|
5956
6009
|
# @return [String]
|
5957
6010
|
#
|
@@ -5974,11 +6027,11 @@ module Aws::RDS
|
|
5974
6027
|
end
|
5975
6028
|
|
5976
6029
|
# Contains the results of a successful call to the
|
5977
|
-
# DescribeDBSnapshotAttributes API action.
|
6030
|
+
# `DescribeDBSnapshotAttributes` API action.
|
5978
6031
|
#
|
5979
6032
|
# Manual DB snapshot attributes are used to authorize other AWS accounts
|
5980
6033
|
# to copy or restore a manual DB snapshot. For more information, see the
|
5981
|
-
# ModifyDBSnapshotAttribute API action.
|
6034
|
+
# `ModifyDBSnapshotAttribute` API action.
|
5982
6035
|
#
|
5983
6036
|
# @!attribute [rw] db_snapshot_identifier
|
5984
6037
|
# The identifier of the manual DB snapshot that the attributes apply
|
@@ -5998,7 +6051,7 @@ module Aws::RDS
|
|
5998
6051
|
end
|
5999
6052
|
|
6000
6053
|
# Contains the result of a successful invocation of the
|
6001
|
-
# DescribeDBSnapshots action.
|
6054
|
+
# `DescribeDBSnapshots` action.
|
6002
6055
|
#
|
6003
6056
|
# @!attribute [rw] marker
|
6004
6057
|
# An optional pagination token provided by a previous request. If this
|
@@ -6007,7 +6060,7 @@ module Aws::RDS
|
|
6007
6060
|
# @return [String]
|
6008
6061
|
#
|
6009
6062
|
# @!attribute [rw] db_snapshots
|
6010
|
-
# A list of DBSnapshot instances.
|
6063
|
+
# A list of `DBSnapshot` instances.
|
6011
6064
|
# @return [Array<Types::DBSnapshot>]
|
6012
6065
|
#
|
6013
6066
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBSnapshotMessage AWS API Documentation
|
@@ -6021,7 +6074,7 @@ module Aws::RDS
|
|
6021
6074
|
# Contains the details of an Amazon RDS DB subnet group.
|
6022
6075
|
#
|
6023
6076
|
# This data type is used as a response element in the
|
6024
|
-
# DescribeDBSubnetGroups action.
|
6077
|
+
# `DescribeDBSubnetGroups` action.
|
6025
6078
|
#
|
6026
6079
|
# @!attribute [rw] db_subnet_group_name
|
6027
6080
|
# The name of the DB subnet group.
|
@@ -6040,7 +6093,7 @@ module Aws::RDS
|
|
6040
6093
|
# @return [String]
|
6041
6094
|
#
|
6042
6095
|
# @!attribute [rw] subnets
|
6043
|
-
# Contains a list of Subnet elements.
|
6096
|
+
# Contains a list of `Subnet` elements.
|
6044
6097
|
# @return [Array<Types::Subnet>]
|
6045
6098
|
#
|
6046
6099
|
# @!attribute [rw] db_subnet_group_arn
|
@@ -6060,7 +6113,7 @@ module Aws::RDS
|
|
6060
6113
|
end
|
6061
6114
|
|
6062
6115
|
# Contains the result of a successful invocation of the
|
6063
|
-
# DescribeDBSubnetGroups action.
|
6116
|
+
# `DescribeDBSubnetGroups` action.
|
6064
6117
|
#
|
6065
6118
|
# @!attribute [rw] marker
|
6066
6119
|
# An optional pagination token provided by a previous request. If this
|
@@ -6069,7 +6122,7 @@ module Aws::RDS
|
|
6069
6122
|
# @return [String]
|
6070
6123
|
#
|
6071
6124
|
# @!attribute [rw] db_subnet_groups
|
6072
|
-
# A list of DBSubnetGroup instances.
|
6125
|
+
# A list of `DBSubnetGroup` instances.
|
6073
6126
|
# @return [Array<Types::DBSubnetGroup>]
|
6074
6127
|
#
|
6075
6128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBSubnetGroupMessage AWS API Documentation
|
@@ -6120,25 +6173,26 @@ module Aws::RDS
|
|
6120
6173
|
# @return [String]
|
6121
6174
|
#
|
6122
6175
|
# @!attribute [rw] skip_final_snapshot
|
6123
|
-
#
|
6124
|
-
# DB cluster is deleted. If
|
6125
|
-
# snapshot is created. If
|
6126
|
-
# is created before the DB cluster is
|
6176
|
+
# A value that indicates whether to skip the creation of a final DB
|
6177
|
+
# cluster snapshot before the DB cluster is deleted. If skip is
|
6178
|
+
# specified, no DB cluster snapshot is created. If skip is not
|
6179
|
+
# specified, a DB cluster snapshot is created before the DB cluster is
|
6180
|
+
# deleted. By default, skip is not specified, and the DB cluster
|
6181
|
+
# snapshot is created. By default, this parameter is disabled.
|
6127
6182
|
#
|
6128
6183
|
# <note markdown="1"> You must specify a `FinalDBSnapshotIdentifier` parameter if
|
6129
|
-
# `SkipFinalSnapshot` is
|
6184
|
+
# `SkipFinalSnapshot` is disabled.
|
6130
6185
|
#
|
6131
6186
|
# </note>
|
6132
|
-
#
|
6133
|
-
# Default: `false`
|
6134
6187
|
# @return [Boolean]
|
6135
6188
|
#
|
6136
6189
|
# @!attribute [rw] final_db_snapshot_identifier
|
6137
6190
|
# The DB cluster snapshot identifier of the new DB cluster snapshot
|
6138
|
-
# created when `SkipFinalSnapshot` is
|
6191
|
+
# created when `SkipFinalSnapshot` is disabled.
|
6139
6192
|
#
|
6140
|
-
# <note markdown="1"> Specifying this parameter and also
|
6141
|
-
#
|
6193
|
+
# <note markdown="1"> Specifying this parameter and also skipping the creation of a final
|
6194
|
+
# DB cluster snapshot with the `SkipFinalShapshot` parameter results
|
6195
|
+
# in an error.
|
6142
6196
|
#
|
6143
6197
|
# </note>
|
6144
6198
|
#
|
@@ -6190,7 +6244,7 @@ module Aws::RDS
|
|
6190
6244
|
# Contains the details of an Amazon Aurora DB cluster.
|
6191
6245
|
#
|
6192
6246
|
# This data type is used as a response element in the
|
6193
|
-
# DescribeDBClusters
|
6247
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
6194
6248
|
# @return [Types::DBCluster]
|
6195
6249
|
#
|
6196
6250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterResult AWS API Documentation
|
@@ -6225,7 +6279,7 @@ module Aws::RDS
|
|
6225
6279
|
# Contains the details for an Amazon RDS DB cluster snapshot
|
6226
6280
|
#
|
6227
6281
|
# This data type is used as a response element in the
|
6228
|
-
# DescribeDBClusterSnapshots action.
|
6282
|
+
# `DescribeDBClusterSnapshots` action.
|
6229
6283
|
# @return [Types::DBClusterSnapshot]
|
6230
6284
|
#
|
6231
6285
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterSnapshotResult AWS API Documentation
|
@@ -6291,32 +6345,31 @@ module Aws::RDS
|
|
6291
6345
|
# @return [String]
|
6292
6346
|
#
|
6293
6347
|
# @!attribute [rw] skip_final_snapshot
|
6294
|
-
# A value that indicates whether
|
6295
|
-
# the DB instance is deleted. If
|
6296
|
-
# is created. If
|
6297
|
-
# the DB instance is deleted.
|
6348
|
+
# A value that indicates whether to skip the creation of a final DB
|
6349
|
+
# snapshot before the DB instance is deleted. If skip is specified, no
|
6350
|
+
# DB snapshot is created. If skip is not specified, a DB snapshot is
|
6351
|
+
# created before the DB instance is deleted. By default, skip is not
|
6352
|
+
# specified, and the DB snapshot is created.
|
6298
6353
|
#
|
6299
|
-
#
|
6300
|
-
#
|
6301
|
-
#
|
6302
|
-
#
|
6354
|
+
# Note that when a DB instance is in a failure state and has a status
|
6355
|
+
# of 'failed', 'incompatible-restore', or
|
6356
|
+
# 'incompatible-network', it can only be deleted when skip is
|
6357
|
+
# specified.
|
6303
6358
|
#
|
6304
|
-
# Specify
|
6359
|
+
# Specify skip when deleting a Read Replica.
|
6305
6360
|
#
|
6306
|
-
# <note markdown="1"> The
|
6307
|
-
#
|
6361
|
+
# <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip is
|
6362
|
+
# not specified.
|
6308
6363
|
#
|
6309
6364
|
# </note>
|
6310
|
-
#
|
6311
|
-
# Default: `false`
|
6312
6365
|
# @return [Boolean]
|
6313
6366
|
#
|
6314
6367
|
# @!attribute [rw] final_db_snapshot_identifier
|
6315
|
-
# The `DBSnapshotIdentifier` of the new
|
6316
|
-
# `SkipFinalSnapshot` is
|
6368
|
+
# The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
|
6369
|
+
# `SkipFinalSnapshot` parameter is disabled.
|
6317
6370
|
#
|
6318
|
-
# <note markdown="1"> Specifying this parameter and also
|
6319
|
-
#
|
6371
|
+
# <note markdown="1"> Specifying this parameter and also specifying to skip final DB
|
6372
|
+
# snapshot creation in SkipFinalShapshot results in an error.
|
6320
6373
|
#
|
6321
6374
|
# </note>
|
6322
6375
|
#
|
@@ -6334,7 +6387,8 @@ module Aws::RDS
|
|
6334
6387
|
# @!attribute [rw] delete_automated_backups
|
6335
6388
|
# A value that indicates whether to remove automated backups
|
6336
6389
|
# immediately after the DB instance is deleted. This parameter isn't
|
6337
|
-
# case-sensitive.
|
6390
|
+
# case-sensitive. The default is to remove automated backups
|
6391
|
+
# immediately after the DB instance is deleted.
|
6338
6392
|
# @return [Boolean]
|
6339
6393
|
#
|
6340
6394
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceMessage AWS API Documentation
|
@@ -6351,7 +6405,7 @@ module Aws::RDS
|
|
6351
6405
|
# Contains the details of an Amazon RDS DB instance.
|
6352
6406
|
#
|
6353
6407
|
# This data type is used as a response element in the
|
6354
|
-
# DescribeDBInstances action.
|
6408
|
+
# `DescribeDBInstances` action.
|
6355
6409
|
# @return [Types::DBInstance]
|
6356
6410
|
#
|
6357
6411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceResult AWS API Documentation
|
@@ -6444,7 +6498,7 @@ module Aws::RDS
|
|
6444
6498
|
# Contains the details of an Amazon RDS DB snapshot.
|
6445
6499
|
#
|
6446
6500
|
# This data type is used as a response element in the
|
6447
|
-
# DescribeDBSnapshots action.
|
6501
|
+
# `DescribeDBSnapshots` action.
|
6448
6502
|
# @return [Types::DBSnapshot]
|
6449
6503
|
#
|
6450
6504
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBSnapshotResult AWS API Documentation
|
@@ -6504,7 +6558,7 @@ module Aws::RDS
|
|
6504
6558
|
|
6505
6559
|
# @!attribute [rw] event_subscription
|
6506
6560
|
# Contains the results of a successful invocation of the
|
6507
|
-
# DescribeEventSubscriptions action.
|
6561
|
+
# `DescribeEventSubscriptions` action.
|
6508
6562
|
# @return [Types::EventSubscription]
|
6509
6563
|
#
|
6510
6564
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteEventSubscriptionResult AWS API Documentation
|
@@ -6615,7 +6669,7 @@ module Aws::RDS
|
|
6615
6669
|
#
|
6616
6670
|
# @!attribute [rw] marker
|
6617
6671
|
# An optional pagination token provided by a previous
|
6618
|
-
# DescribeCertificates request. If this parameter is specified, the
|
6672
|
+
# `DescribeCertificates` request. If this parameter is specified, the
|
6619
6673
|
# response includes only records beyond the marker, up to the value
|
6620
6674
|
# specified by `MaxRecords`.
|
6621
6675
|
# @return [String]
|
@@ -6700,8 +6754,7 @@ module Aws::RDS
|
|
6700
6754
|
# * `pending`
|
6701
6755
|
#
|
6702
6756
|
# The results list includes information about only the backtracks
|
6703
|
-
# identified by these values.
|
6704
|
-
# status values, see DBClusterBacktrack.
|
6757
|
+
# identified by these values.
|
6705
6758
|
# @return [Array<Types::Filter>]
|
6706
6759
|
#
|
6707
6760
|
# @!attribute [rw] max_records
|
@@ -6717,9 +6770,9 @@ module Aws::RDS
|
|
6717
6770
|
#
|
6718
6771
|
# @!attribute [rw] marker
|
6719
6772
|
# An optional pagination token provided by a previous
|
6720
|
-
# DescribeDBClusterBacktracks request. If this parameter is
|
6721
|
-
# the response includes only records beyond the marker, up
|
6722
|
-
# value specified by `MaxRecords`.
|
6773
|
+
# `DescribeDBClusterBacktracks` request. If this parameter is
|
6774
|
+
# specified, the response includes only records beyond the marker, up
|
6775
|
+
# to the value specified by `MaxRecords`.
|
6723
6776
|
# @return [String]
|
6724
6777
|
#
|
6725
6778
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterBacktracksMessage AWS API Documentation
|
@@ -6788,9 +6841,9 @@ module Aws::RDS
|
|
6788
6841
|
#
|
6789
6842
|
# @!attribute [rw] marker
|
6790
6843
|
# An optional pagination token provided by a previous
|
6791
|
-
# DescribeDBClusterEndpoints request. If this parameter is
|
6792
|
-
# the response includes only records beyond the marker, up
|
6793
|
-
# value specified by `MaxRecords`.
|
6844
|
+
# `DescribeDBClusterEndpoints` request. If this parameter is
|
6845
|
+
# specified, the response includes only records beyond the marker, up
|
6846
|
+
# to the value specified by `MaxRecords`.
|
6794
6847
|
# @return [String]
|
6795
6848
|
#
|
6796
6849
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterEndpointsMessage AWS API Documentation
|
@@ -6950,11 +7003,11 @@ module Aws::RDS
|
|
6950
7003
|
|
6951
7004
|
# @!attribute [rw] db_cluster_snapshot_attributes_result
|
6952
7005
|
# Contains the results of a successful call to the
|
6953
|
-
# DescribeDBClusterSnapshotAttributes API action.
|
7006
|
+
# `DescribeDBClusterSnapshotAttributes` API action.
|
6954
7007
|
#
|
6955
7008
|
# Manual DB cluster snapshot attributes are used to authorize other
|
6956
7009
|
# AWS accounts to copy or restore a manual DB cluster snapshot. For
|
6957
|
-
# more information, see the ModifyDBClusterSnapshotAttribute API
|
7010
|
+
# more information, see the `ModifyDBClusterSnapshotAttribute` API
|
6958
7011
|
# action.
|
6959
7012
|
# @return [Types::DBClusterSnapshotAttributesResult]
|
6960
7013
|
#
|
@@ -7030,10 +7083,10 @@ module Aws::RDS
|
|
7030
7083
|
#
|
7031
7084
|
# If you don't specify a `SnapshotType` value, then both automated
|
7032
7085
|
# and manual DB cluster snapshots are returned. You can include shared
|
7033
|
-
# DB cluster snapshots with these results by
|
7034
|
-
# `IncludeShared` parameter
|
7035
|
-
#
|
7036
|
-
# parameter
|
7086
|
+
# DB cluster snapshots with these results by enabling the
|
7087
|
+
# `IncludeShared` parameter. You can include public DB cluster
|
7088
|
+
# snapshots with these results by enabling the `IncludePublic`
|
7089
|
+
# parameter.
|
7037
7090
|
#
|
7038
7091
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
7039
7092
|
# `SnapshotType` values of `manual` or `automated`. The
|
@@ -7065,19 +7118,20 @@ module Aws::RDS
|
|
7065
7118
|
# @return [String]
|
7066
7119
|
#
|
7067
7120
|
# @!attribute [rw] include_shared
|
7068
|
-
#
|
7069
|
-
# accounts that this AWS account has been
|
7070
|
-
#
|
7121
|
+
# A value that indicates whether to include shared manual DB cluster
|
7122
|
+
# snapshots from other AWS accounts that this AWS account has been
|
7123
|
+
# given permission to copy or restore. By default, these snapshots are
|
7124
|
+
# not included.
|
7071
7125
|
#
|
7072
7126
|
# You can give an AWS account permission to restore a manual DB
|
7073
7127
|
# cluster snapshot from another AWS account by the
|
7074
|
-
# ModifyDBClusterSnapshotAttribute API action.
|
7128
|
+
# `ModifyDBClusterSnapshotAttribute` API action.
|
7075
7129
|
# @return [Boolean]
|
7076
7130
|
#
|
7077
7131
|
# @!attribute [rw] include_public
|
7078
|
-
#
|
7079
|
-
# be copied or restored by any AWS
|
7080
|
-
# default
|
7132
|
+
# A value that indicates whether to include manual DB cluster
|
7133
|
+
# snapshots that are public and can be copied or restored by any AWS
|
7134
|
+
# account. By default, the public snapshots are not included.
|
7081
7135
|
#
|
7082
7136
|
# You can share a manual DB cluster snapshot as public by using the
|
7083
7137
|
# ModifyDBClusterSnapshotAttribute API action.
|
@@ -7149,7 +7203,7 @@ module Aws::RDS
|
|
7149
7203
|
#
|
7150
7204
|
# @!attribute [rw] marker
|
7151
7205
|
# An optional pagination token provided by a previous
|
7152
|
-
# DescribeDBClusters request. If this parameter is specified, the
|
7206
|
+
# `DescribeDBClusters` request. If this parameter is specified, the
|
7153
7207
|
# response includes only records beyond the marker, up to the value
|
7154
7208
|
# specified by `MaxRecords`.
|
7155
7209
|
# @return [String]
|
@@ -7227,18 +7281,25 @@ module Aws::RDS
|
|
7227
7281
|
# @return [String]
|
7228
7282
|
#
|
7229
7283
|
# @!attribute [rw] default_only
|
7230
|
-
#
|
7231
|
-
# engine and major version combination is
|
7284
|
+
# A value that indicates whether only the default version of the
|
7285
|
+
# specified engine or engine and major version combination is
|
7286
|
+
# returned.
|
7232
7287
|
# @return [Boolean]
|
7233
7288
|
#
|
7234
7289
|
# @!attribute [rw] list_supported_character_sets
|
7235
|
-
#
|
7290
|
+
# A value that indicates whether to list the supported character sets
|
7291
|
+
# for each engine version.
|
7292
|
+
#
|
7293
|
+
# If this parameter is enabled and the requested engine supports the
|
7236
7294
|
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
7237
7295
|
# includes a list of supported character sets for each engine version.
|
7238
7296
|
# @return [Boolean]
|
7239
7297
|
#
|
7240
7298
|
# @!attribute [rw] list_supported_timezones
|
7241
|
-
#
|
7299
|
+
# A value that indicates whether to list the supported time zones for
|
7300
|
+
# each engine version.
|
7301
|
+
#
|
7302
|
+
# If this parameter is enabled and the requested engine supports the
|
7242
7303
|
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
7243
7304
|
# list of supported time zones for each engine version.
|
7244
7305
|
# @return [Boolean]
|
@@ -7410,7 +7471,7 @@ module Aws::RDS
|
|
7410
7471
|
include Aws::Structure
|
7411
7472
|
end
|
7412
7473
|
|
7413
|
-
# This data type is used as a response element to DescribeDBLogFiles
|
7474
|
+
# This data type is used as a response element to `DescribeDBLogFiles`.
|
7414
7475
|
#
|
7415
7476
|
# @!attribute [rw] log_file_name
|
7416
7477
|
# The name of the log file for the specified DB instance.
|
@@ -7507,7 +7568,7 @@ module Aws::RDS
|
|
7507
7568
|
include Aws::Structure
|
7508
7569
|
end
|
7509
7570
|
|
7510
|
-
# The response from a call to DescribeDBLogFiles
|
7571
|
+
# The response from a call to `DescribeDBLogFiles`.
|
7511
7572
|
#
|
7512
7573
|
# @!attribute [rw] describe_db_log_files
|
7513
7574
|
# The DB log files returned.
|
@@ -7722,11 +7783,11 @@ module Aws::RDS
|
|
7722
7783
|
|
7723
7784
|
# @!attribute [rw] db_snapshot_attributes_result
|
7724
7785
|
# Contains the results of a successful call to the
|
7725
|
-
# DescribeDBSnapshotAttributes API action.
|
7786
|
+
# `DescribeDBSnapshotAttributes` API action.
|
7726
7787
|
#
|
7727
7788
|
# Manual DB snapshot attributes are used to authorize other AWS
|
7728
7789
|
# accounts to copy or restore a manual DB snapshot. For more
|
7729
|
-
# information, see the ModifyDBSnapshotAttribute API action.
|
7790
|
+
# information, see the `ModifyDBSnapshotAttribute` API action.
|
7730
7791
|
# @return [Types::DBSnapshotAttributesResult]
|
7731
7792
|
#
|
7732
7793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSnapshotAttributesResult AWS API Documentation
|
@@ -7808,9 +7869,9 @@ module Aws::RDS
|
|
7808
7869
|
# If you don't specify a `SnapshotType` value, then both automated
|
7809
7870
|
# and manual snapshots are returned. Shared and public DB snapshots
|
7810
7871
|
# are not included in the returned results by default. You can include
|
7811
|
-
# shared snapshots with these results by
|
7812
|
-
# parameter
|
7813
|
-
#
|
7872
|
+
# shared snapshots with these results by enabling the `IncludeShared`
|
7873
|
+
# parameter. You can include public snapshots with these results by
|
7874
|
+
# enabling the `IncludePublic` parameter.
|
7814
7875
|
#
|
7815
7876
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
7816
7877
|
# `SnapshotType` values of `manual` or `automated`. The
|
@@ -7846,19 +7907,20 @@ module Aws::RDS
|
|
7846
7907
|
# @return [String]
|
7847
7908
|
#
|
7848
7909
|
# @!attribute [rw] include_shared
|
7849
|
-
#
|
7850
|
-
# that this AWS account has been
|
7851
|
-
#
|
7910
|
+
# A value that indicates whether to include shared manual DB cluster
|
7911
|
+
# snapshots from other AWS accounts that this AWS account has been
|
7912
|
+
# given permission to copy or restore. By default, these snapshots are
|
7913
|
+
# not included.
|
7852
7914
|
#
|
7853
7915
|
# You can give an AWS account permission to restore a manual DB
|
7854
7916
|
# snapshot from another AWS account by using the
|
7855
|
-
# ModifyDBSnapshotAttribute API action.
|
7917
|
+
# `ModifyDBSnapshotAttribute` API action.
|
7856
7918
|
# @return [Boolean]
|
7857
7919
|
#
|
7858
7920
|
# @!attribute [rw] include_public
|
7859
|
-
#
|
7860
|
-
# copied or restored by any AWS
|
7861
|
-
# default
|
7921
|
+
# A value that indicates whether to include manual DB cluster
|
7922
|
+
# snapshots that are public and can be copied or restored by any AWS
|
7923
|
+
# account. By default, the public snapshots are not included.
|
7862
7924
|
#
|
7863
7925
|
# You can share a manual DB snapshot as public by using the
|
7864
7926
|
# ModifyDBSnapshotAttribute API.
|
@@ -7988,7 +8050,7 @@ module Aws::RDS
|
|
7988
8050
|
|
7989
8051
|
# @!attribute [rw] engine_defaults
|
7990
8052
|
# Contains the result of a successful invocation of the
|
7991
|
-
# DescribeEngineDefaultParameters action.
|
8053
|
+
# `DescribeEngineDefaultParameters` action.
|
7992
8054
|
# @return [Types::EngineDefaults]
|
7993
8055
|
#
|
7994
8056
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEngineDefaultClusterParametersResult AWS API Documentation
|
@@ -8051,7 +8113,7 @@ module Aws::RDS
|
|
8051
8113
|
|
8052
8114
|
# @!attribute [rw] engine_defaults
|
8053
8115
|
# Contains the result of a successful invocation of the
|
8054
|
-
# DescribeEngineDefaultParameters action.
|
8116
|
+
# `DescribeEngineDefaultParameters` action.
|
8055
8117
|
# @return [Types::EngineDefaults]
|
8056
8118
|
#
|
8057
8119
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEngineDefaultParametersResult AWS API Documentation
|
@@ -8317,9 +8379,9 @@ module Aws::RDS
|
|
8317
8379
|
#
|
8318
8380
|
# @!attribute [rw] marker
|
8319
8381
|
# An optional pagination token provided by a previous
|
8320
|
-
# DescribeGlobalClusters request. If this parameter is specified,
|
8321
|
-
# response includes only records beyond the marker, up to the
|
8322
|
-
# specified by `MaxRecords`.
|
8382
|
+
# `DescribeGlobalClusters` request. If this parameter is specified,
|
8383
|
+
# the response includes only records beyond the marker, up to the
|
8384
|
+
# value specified by `MaxRecords`.
|
8323
8385
|
# @return [String]
|
8324
8386
|
#
|
8325
8387
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeGlobalClustersMessage AWS API Documentation
|
@@ -8497,8 +8559,8 @@ module Aws::RDS
|
|
8497
8559
|
# @return [String]
|
8498
8560
|
#
|
8499
8561
|
# @!attribute [rw] vpc
|
8500
|
-
#
|
8501
|
-
#
|
8562
|
+
# A value that indicates whether to show only VPC or non-VPC
|
8563
|
+
# offerings.
|
8502
8564
|
# @return [Boolean]
|
8503
8565
|
#
|
8504
8566
|
# @!attribute [rw] filters
|
@@ -8658,8 +8720,8 @@ module Aws::RDS
|
|
8658
8720
|
# @return [String]
|
8659
8721
|
#
|
8660
8722
|
# @!attribute [rw] multi_az
|
8661
|
-
#
|
8662
|
-
#
|
8723
|
+
# A value that indicates whether to show only those reservations that
|
8724
|
+
# support Multi-AZ.
|
8663
8725
|
# @return [Boolean]
|
8664
8726
|
#
|
8665
8727
|
# @!attribute [rw] filters
|
@@ -8758,8 +8820,8 @@ module Aws::RDS
|
|
8758
8820
|
# @return [String]
|
8759
8821
|
#
|
8760
8822
|
# @!attribute [rw] multi_az
|
8761
|
-
#
|
8762
|
-
#
|
8823
|
+
# A value that indicates whether to show only those reservations that
|
8824
|
+
# support Multi-AZ.
|
8763
8825
|
# @return [Boolean]
|
8764
8826
|
#
|
8765
8827
|
# @!attribute [rw] filters
|
@@ -8836,7 +8898,7 @@ module Aws::RDS
|
|
8836
8898
|
#
|
8837
8899
|
# @!attribute [rw] marker
|
8838
8900
|
# An optional pagination token provided by a previous
|
8839
|
-
# DescribeSourceRegions request. If this parameter is specified, the
|
8901
|
+
# `DescribeSourceRegions` request. If this parameter is specified, the
|
8840
8902
|
# response includes only records beyond the marker, up to the value
|
8841
8903
|
# specified by `MaxRecords`.
|
8842
8904
|
# @return [String]
|
@@ -8876,8 +8938,8 @@ module Aws::RDS
|
|
8876
8938
|
# @!attribute [rw] valid_db_instance_modifications_message
|
8877
8939
|
# Information about valid modifications that you can make to your DB
|
8878
8940
|
# instance. Contains the result of a successful call to the
|
8879
|
-
# DescribeValidDBInstanceModifications action. You can use this
|
8880
|
-
# information when you call ModifyDBInstance
|
8941
|
+
# `DescribeValidDBInstanceModifications` action. You can use this
|
8942
|
+
# information when you call `ModifyDBInstance`.
|
8881
8943
|
# @return [Types::ValidDBInstanceModificationsMessage]
|
8882
8944
|
#
|
8883
8945
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeValidDBInstanceModificationsResult AWS API Documentation
|
@@ -8937,7 +8999,7 @@ module Aws::RDS
|
|
8937
8999
|
end
|
8938
9000
|
|
8939
9001
|
# This data type is used as a response element to
|
8940
|
-
# DownloadDBLogFilePortion
|
9002
|
+
# `DownloadDBLogFilePortion`.
|
8941
9003
|
#
|
8942
9004
|
# @!attribute [rw] log_file_data
|
8943
9005
|
# Entries from the specified log file.
|
@@ -9032,11 +9094,11 @@ module Aws::RDS
|
|
9032
9094
|
|
9033
9095
|
# This data type is used as a response element in the following actions:
|
9034
9096
|
#
|
9035
|
-
# * AuthorizeDBSecurityGroupIngress
|
9097
|
+
# * `AuthorizeDBSecurityGroupIngress`
|
9036
9098
|
#
|
9037
|
-
# * DescribeDBSecurityGroups
|
9099
|
+
# * `DescribeDBSecurityGroups`
|
9038
9100
|
#
|
9039
|
-
# * RevokeDBSecurityGroupIngress
|
9101
|
+
# * `RevokeDBSecurityGroupIngress`
|
9040
9102
|
#
|
9041
9103
|
# @!attribute [rw] status
|
9042
9104
|
# Provides the status of the EC2 security group. Status can be
|
@@ -9070,14 +9132,14 @@ module Aws::RDS
|
|
9070
9132
|
# Amazon RDS DB instance. This data type is used as a response element
|
9071
9133
|
# in the following actions:
|
9072
9134
|
#
|
9073
|
-
# * CreateDBInstance
|
9135
|
+
# * `CreateDBInstance`
|
9074
9136
|
#
|
9075
|
-
# * DescribeDBInstances
|
9137
|
+
# * `DescribeDBInstances`
|
9076
9138
|
#
|
9077
|
-
# * DeleteDBInstance
|
9139
|
+
# * `DeleteDBInstance`
|
9078
9140
|
#
|
9079
9141
|
# For the data structure that represents Amazon Aurora DB cluster
|
9080
|
-
# endpoints, see DBClusterEndpoint
|
9142
|
+
# endpoints, see `DBClusterEndpoint`.
|
9081
9143
|
#
|
9082
9144
|
# @!attribute [rw] address
|
9083
9145
|
# Specifies the DNS address of the DB instance.
|
@@ -9102,7 +9164,7 @@ module Aws::RDS
|
|
9102
9164
|
end
|
9103
9165
|
|
9104
9166
|
# Contains the result of a successful invocation of the
|
9105
|
-
# DescribeEngineDefaultParameters action.
|
9167
|
+
# `DescribeEngineDefaultParameters` action.
|
9106
9168
|
#
|
9107
9169
|
# @!attribute [rw] db_parameter_group_family
|
9108
9170
|
# Specifies the name of the DB parameter group family that the engine
|
@@ -9129,7 +9191,7 @@ module Aws::RDS
|
|
9129
9191
|
include Aws::Structure
|
9130
9192
|
end
|
9131
9193
|
|
9132
|
-
# This data type is used as a response element in the DescribeEvents
|
9194
|
+
# This data type is used as a response element in the `DescribeEvents`
|
9133
9195
|
# action.
|
9134
9196
|
#
|
9135
9197
|
# @!attribute [rw] source_identifier
|
@@ -9169,7 +9231,7 @@ module Aws::RDS
|
|
9169
9231
|
end
|
9170
9232
|
|
9171
9233
|
# Contains the results of a successful invocation of the
|
9172
|
-
# DescribeEventCategories action.
|
9234
|
+
# `DescribeEventCategories` action.
|
9173
9235
|
#
|
9174
9236
|
# @!attribute [rw] source_type
|
9175
9237
|
# The source type that the returned categories belong to
|
@@ -9201,7 +9263,7 @@ module Aws::RDS
|
|
9201
9263
|
end
|
9202
9264
|
|
9203
9265
|
# Contains the results of a successful invocation of the
|
9204
|
-
# DescribeEventSubscriptions action.
|
9266
|
+
# `DescribeEventSubscriptions` action.
|
9205
9267
|
#
|
9206
9268
|
# @!attribute [rw] customer_aws_id
|
9207
9269
|
# The AWS customer account associated with the RDS event notification
|
@@ -9293,7 +9355,7 @@ module Aws::RDS
|
|
9293
9355
|
include Aws::Structure
|
9294
9356
|
end
|
9295
9357
|
|
9296
|
-
# Contains the result of a successful invocation of the DescribeEvents
|
9358
|
+
# Contains the result of a successful invocation of the `DescribeEvents`
|
9297
9359
|
# action.
|
9298
9360
|
#
|
9299
9361
|
# @!attribute [rw] marker
|
@@ -9303,7 +9365,7 @@ module Aws::RDS
|
|
9303
9365
|
# @return [String]
|
9304
9366
|
#
|
9305
9367
|
# @!attribute [rw] events
|
9306
|
-
# A list of Event instances.
|
9368
|
+
# A list of `Event` instances.
|
9307
9369
|
# @return [Array<Types::Event>]
|
9308
9370
|
#
|
9309
9371
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/EventsMessage AWS API Documentation
|
@@ -9352,7 +9414,7 @@ module Aws::RDS
|
|
9352
9414
|
# Contains the details of an Amazon Aurora DB cluster.
|
9353
9415
|
#
|
9354
9416
|
# This data type is used as a response element in the
|
9355
|
-
# DescribeDBClusters
|
9417
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
9356
9418
|
# @return [Types::DBCluster]
|
9357
9419
|
#
|
9358
9420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverDBClusterResult AWS API Documentation
|
@@ -9374,15 +9436,15 @@ module Aws::RDS
|
|
9374
9436
|
#
|
9375
9437
|
# The following actions can be filtered:
|
9376
9438
|
#
|
9377
|
-
# * DescribeDBClusterBacktracks
|
9439
|
+
# * `DescribeDBClusterBacktracks`
|
9378
9440
|
#
|
9379
|
-
# * DescribeDBClusterEndpoints
|
9441
|
+
# * `DescribeDBClusterEndpoints`
|
9380
9442
|
#
|
9381
|
-
# * DescribeDBClusters
|
9443
|
+
# * `DescribeDBClusters`
|
9382
9444
|
#
|
9383
|
-
# * DescribeDBInstances
|
9445
|
+
# * `DescribeDBInstances`
|
9384
9446
|
#
|
9385
|
-
# * DescribePendingMaintenanceActions
|
9447
|
+
# * `DescribePendingMaintenanceActions`
|
9386
9448
|
#
|
9387
9449
|
# @note When making an API call, you may pass Filter
|
9388
9450
|
# data as a hash:
|
@@ -9518,7 +9580,7 @@ module Aws::RDS
|
|
9518
9580
|
end
|
9519
9581
|
|
9520
9582
|
# This data type is used as a response element in the
|
9521
|
-
# DescribeDBSecurityGroups action.
|
9583
|
+
# `DescribeDBSecurityGroups` action.
|
9522
9584
|
#
|
9523
9585
|
# @!attribute [rw] status
|
9524
9586
|
# Specifies the status of the IP range. Status can be "authorizing",
|
@@ -9621,7 +9683,8 @@ module Aws::RDS
|
|
9621
9683
|
#
|
9622
9684
|
# Constraints:
|
9623
9685
|
#
|
9624
|
-
# * Value must be `2`, `4`, `8`, `16`, `32`, `64`, `128`, or
|
9686
|
+
# * Value must be `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, or
|
9687
|
+
# `256`.
|
9625
9688
|
#
|
9626
9689
|
# ^
|
9627
9690
|
# @return [Integer]
|
@@ -9759,22 +9822,22 @@ module Aws::RDS
|
|
9759
9822
|
# @return [String]
|
9760
9823
|
#
|
9761
9824
|
# @!attribute [rw] apply_immediately
|
9762
|
-
# A value that
|
9825
|
+
# A value that indicates whether the modifications in this request and
|
9763
9826
|
# any pending modifications are asynchronously applied as soon as
|
9764
9827
|
# possible, regardless of the `PreferredMaintenanceWindow` setting for
|
9765
|
-
# the DB cluster. If this parameter is
|
9766
|
-
#
|
9828
|
+
# the DB cluster. If this parameter is disabled, changes to the DB
|
9829
|
+
# cluster are applied during the next maintenance window.
|
9767
9830
|
#
|
9768
9831
|
# The `ApplyImmediately` parameter only affects the
|
9769
9832
|
# `EnableIAMDatabaseAuthentication`, `MasterUserPassword`, and
|
9770
|
-
# `NewDBClusterIdentifier` values. If
|
9771
|
-
#
|
9772
|
-
# `
|
9773
|
-
#
|
9774
|
-
#
|
9775
|
-
#
|
9833
|
+
# `NewDBClusterIdentifier` values. If the `ApplyImmediately` parameter
|
9834
|
+
# is disabled, then changes to the `EnableIAMDatabaseAuthentication`,
|
9835
|
+
# `MasterUserPassword`, and `NewDBClusterIdentifier` values are
|
9836
|
+
# applied during the next maintenance window. All other changes are
|
9837
|
+
# applied immediately, regardless of the value of the
|
9838
|
+
# `ApplyImmediately` parameter.
|
9776
9839
|
#
|
9777
|
-
#
|
9840
|
+
# By default, this parameter is disabled.
|
9778
9841
|
# @return [Boolean]
|
9779
9842
|
#
|
9780
9843
|
# @!attribute [rw] backup_retention_period
|
@@ -9819,11 +9882,11 @@ module Aws::RDS
|
|
9819
9882
|
# A value that indicates that the DB cluster should be associated with
|
9820
9883
|
# the specified option group. Changing this parameter doesn't result
|
9821
9884
|
# in an outage except in the following case, and the change is applied
|
9822
|
-
# during the next maintenance window unless the `ApplyImmediately`
|
9823
|
-
#
|
9824
|
-
#
|
9825
|
-
#
|
9826
|
-
#
|
9885
|
+
# during the next maintenance window unless the `ApplyImmediately` is
|
9886
|
+
# enabled for this request. If the parameter change results in an
|
9887
|
+
# option group that enables OEM, this change can cause a brief
|
9888
|
+
# (sub-second) period during which new connections are rejected but
|
9889
|
+
# existing connections are not interrupted.
|
9827
9890
|
#
|
9828
9891
|
# Permanent options can't be removed from an option group. The option
|
9829
9892
|
# group can't be removed from a DB cluster once it is associated with
|
@@ -9877,10 +9940,9 @@ module Aws::RDS
|
|
9877
9940
|
# @return [String]
|
9878
9941
|
#
|
9879
9942
|
# @!attribute [rw] enable_iam_database_authentication
|
9880
|
-
#
|
9881
|
-
# accounts to database accounts
|
9882
|
-
#
|
9883
|
-
# Default: `false`
|
9943
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
9944
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
9945
|
+
# mapping is disabled.
|
9884
9946
|
# @return [Boolean]
|
9885
9947
|
#
|
9886
9948
|
# @!attribute [rw] backtrack_window
|
@@ -9905,11 +9967,10 @@ module Aws::RDS
|
|
9905
9967
|
# @!attribute [rw] engine_version
|
9906
9968
|
# The version number of the database engine to which you want to
|
9907
9969
|
# upgrade. Changing this parameter results in an outage. The change is
|
9908
|
-
# applied during the next maintenance window unless
|
9909
|
-
#
|
9970
|
+
# applied during the next maintenance window unless `ApplyImmediately`
|
9971
|
+
# is enabled.
|
9910
9972
|
#
|
9911
|
-
# For a list of valid engine versions,
|
9912
|
-
# DescribeDBEngineVersions.
|
9973
|
+
# For a list of valid engine versions, use DescribeDBEngineVersions.
|
9913
9974
|
# @return [String]
|
9914
9975
|
#
|
9915
9976
|
# @!attribute [rw] scaling_configuration
|
@@ -9918,8 +9979,9 @@ module Aws::RDS
|
|
9918
9979
|
# @return [Types::ScalingConfiguration]
|
9919
9980
|
#
|
9920
9981
|
# @!attribute [rw] deletion_protection
|
9921
|
-
#
|
9922
|
-
# database can't be deleted when
|
9982
|
+
# A value that indicates whether the DB cluster has deletion
|
9983
|
+
# protection enabled. The database can't be deleted when deletion
|
9984
|
+
# protection is enabled. By default, deletion protection is disabled.
|
9923
9985
|
# @return [Boolean]
|
9924
9986
|
#
|
9925
9987
|
# @!attribute [rw] enable_http_endpoint
|
@@ -9946,8 +10008,8 @@ module Aws::RDS
|
|
9946
10008
|
# @return [Boolean]
|
9947
10009
|
#
|
9948
10010
|
# @!attribute [rw] copy_tags_to_snapshot
|
9949
|
-
#
|
9950
|
-
#
|
10011
|
+
# A value that indicates whether to copy all tags from the DB cluster
|
10012
|
+
# to snapshots of the DB cluster. The default is not to copy them.
|
9951
10013
|
# @return [Boolean]
|
9952
10014
|
#
|
9953
10015
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterMessage AWS API Documentation
|
@@ -10017,7 +10079,7 @@ module Aws::RDS
|
|
10017
10079
|
# Contains the details of an Amazon Aurora DB cluster.
|
10018
10080
|
#
|
10019
10081
|
# This data type is used as a response element in the
|
10020
|
-
# DescribeDBClusters
|
10082
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
10021
10083
|
# @return [Types::DBCluster]
|
10022
10084
|
#
|
10023
10085
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterResult AWS API Documentation
|
@@ -10086,11 +10148,11 @@ module Aws::RDS
|
|
10086
10148
|
|
10087
10149
|
# @!attribute [rw] db_cluster_snapshot_attributes_result
|
10088
10150
|
# Contains the results of a successful call to the
|
10089
|
-
# DescribeDBClusterSnapshotAttributes API action.
|
10151
|
+
# `DescribeDBClusterSnapshotAttributes` API action.
|
10090
10152
|
#
|
10091
10153
|
# Manual DB cluster snapshot attributes are used to authorize other
|
10092
10154
|
# AWS accounts to copy or restore a manual DB cluster snapshot. For
|
10093
|
-
# more information, see the ModifyDBClusterSnapshotAttribute API
|
10155
|
+
# more information, see the `ModifyDBClusterSnapshotAttribute` API
|
10094
10156
|
# action.
|
10095
10157
|
# @return [Types::DBClusterSnapshotAttributesResult]
|
10096
10158
|
#
|
@@ -10176,7 +10238,7 @@ module Aws::RDS
|
|
10176
10238
|
# they are 10% greater than the current value.
|
10177
10239
|
#
|
10178
10240
|
# For the valid values for allocated storage for each engine, see
|
10179
|
-
# CreateDBInstance
|
10241
|
+
# `CreateDBInstance`.
|
10180
10242
|
# @return [Integer]
|
10181
10243
|
#
|
10182
10244
|
# @!attribute [rw] db_instance_class
|
@@ -10188,7 +10250,7 @@ module Aws::RDS
|
|
10188
10250
|
#
|
10189
10251
|
# If you modify the DB instance class, an outage occurs during the
|
10190
10252
|
# change. The change is applied during the next maintenance window,
|
10191
|
-
# unless `ApplyImmediately` is
|
10253
|
+
# unless `ApplyImmediately` is enabled for this request.
|
10192
10254
|
#
|
10193
10255
|
# Default: Uses existing setting
|
10194
10256
|
#
|
@@ -10206,7 +10268,7 @@ module Aws::RDS
|
|
10206
10268
|
#
|
10207
10269
|
# Changing the subnet group causes an outage during the change. The
|
10208
10270
|
# change is applied during the next maintenance window, unless you
|
10209
|
-
#
|
10271
|
+
# enable `ApplyImmediately`.
|
10210
10272
|
#
|
10211
10273
|
# Constraints: If supplied, must match the name of an existing
|
10212
10274
|
# DBSubnetGroup.
|
@@ -10238,7 +10300,7 @@ module Aws::RDS
|
|
10238
10300
|
#
|
10239
10301
|
# Not applicable. The associated list of EC2 VPC security groups is
|
10240
10302
|
# managed by the DB cluster. For more information, see
|
10241
|
-
# ModifyDBCluster
|
10303
|
+
# `ModifyDBCluster`.
|
10242
10304
|
#
|
10243
10305
|
# Constraints:
|
10244
10306
|
#
|
@@ -10248,22 +10310,19 @@ module Aws::RDS
|
|
10248
10310
|
# @return [Array<String>]
|
10249
10311
|
#
|
10250
10312
|
# @!attribute [rw] apply_immediately
|
10251
|
-
#
|
10252
|
-
# modifications are asynchronously applied as soon as
|
10253
|
-
# regardless of the `PreferredMaintenanceWindow` setting for
|
10254
|
-
# instance.
|
10313
|
+
# A value that indicates whether the modifications in this request and
|
10314
|
+
# any pending modifications are asynchronously applied as soon as
|
10315
|
+
# possible, regardless of the `PreferredMaintenanceWindow` setting for
|
10316
|
+
# the DB instance. By default, this parameter is disabled.
|
10255
10317
|
#
|
10256
|
-
# If this parameter is
|
10318
|
+
# If this parameter is disabled, changes to the DB instance are
|
10257
10319
|
# applied during the next maintenance window. Some parameter changes
|
10258
10320
|
# can cause an outage and are applied on the next call to
|
10259
10321
|
# RebootDBInstance, or the next failure reboot. Review the table of
|
10260
|
-
# parameters in [Modifying a DB Instance
|
10261
|
-
#
|
10262
|
-
#
|
10263
|
-
#
|
10264
|
-
# applied.
|
10265
|
-
#
|
10266
|
-
# Default: `false`
|
10322
|
+
# parameters in [Modifying a DB Instance][1] in the *Amazon RDS User
|
10323
|
+
# Guide.* to see the impact of enabling or disabling
|
10324
|
+
# `ApplyImmediately` for each modified parameter and to determine when
|
10325
|
+
# the changes are applied.
|
10267
10326
|
#
|
10268
10327
|
#
|
10269
10328
|
#
|
@@ -10283,7 +10342,7 @@ module Aws::RDS
|
|
10283
10342
|
# **Amazon Aurora**
|
10284
10343
|
#
|
10285
10344
|
# Not applicable. The password for the master user is managed by the
|
10286
|
-
# DB cluster. For more information, see ModifyDBCluster
|
10345
|
+
# DB cluster. For more information, see `ModifyDBCluster`.
|
10287
10346
|
#
|
10288
10347
|
# Default: Uses existing setting
|
10289
10348
|
#
|
@@ -10320,7 +10379,7 @@ module Aws::RDS
|
|
10320
10379
|
# Changing this setting doesn't result in an outage. The parameter
|
10321
10380
|
# group name itself is changed immediately, but the actual parameter
|
10322
10381
|
# changes are not applied until you reboot the instance without
|
10323
|
-
# failover. The
|
10382
|
+
# failover. The DB instance will NOT be rebooted automatically and the
|
10324
10383
|
# parameter changes will NOT be applied during the next maintenance
|
10325
10384
|
# window.
|
10326
10385
|
#
|
@@ -10338,15 +10397,15 @@ module Aws::RDS
|
|
10338
10397
|
# Changing this parameter can result in an outage if you change from 0
|
10339
10398
|
# to a non-zero value or from a non-zero value to 0. These changes are
|
10340
10399
|
# applied during the next maintenance window unless the
|
10341
|
-
# `ApplyImmediately` parameter is
|
10342
|
-
#
|
10400
|
+
# `ApplyImmediately` parameter is enabled for this request. If you
|
10401
|
+
# change the parameter from one non-zero value to another non-zero
|
10343
10402
|
# value, the change is asynchronously applied as soon as possible.
|
10344
10403
|
#
|
10345
10404
|
# **Amazon Aurora**
|
10346
10405
|
#
|
10347
10406
|
# Not applicable. The retention period for automated backups is
|
10348
10407
|
# managed by the DB cluster. For more information, see
|
10349
|
-
# ModifyDBCluster
|
10408
|
+
# `ModifyDBCluster`.
|
10350
10409
|
#
|
10351
10410
|
# Default: Uses existing setting
|
10352
10411
|
#
|
@@ -10374,7 +10433,7 @@ module Aws::RDS
|
|
10374
10433
|
#
|
10375
10434
|
# Not applicable. The daily time range for creating automated backups
|
10376
10435
|
# is managed by the DB cluster. For more information, see
|
10377
|
-
# ModifyDBCluster
|
10436
|
+
# `ModifyDBCluster`.
|
10378
10437
|
#
|
10379
10438
|
# Constraints:
|
10380
10439
|
#
|
@@ -10408,17 +10467,17 @@ module Aws::RDS
|
|
10408
10467
|
# @return [String]
|
10409
10468
|
#
|
10410
10469
|
# @!attribute [rw] multi_az
|
10411
|
-
#
|
10412
|
-
# parameter doesn't result in an outage and
|
10413
|
-
# during the next maintenance window unless the
|
10414
|
-
# parameter is
|
10470
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
10471
|
+
# deployment. Changing this parameter doesn't result in an outage and
|
10472
|
+
# the change is applied during the next maintenance window unless the
|
10473
|
+
# `ApplyImmediately` parameter is enabled for this request.
|
10415
10474
|
# @return [Boolean]
|
10416
10475
|
#
|
10417
10476
|
# @!attribute [rw] engine_version
|
10418
10477
|
# The version number of the database engine to upgrade to. Changing
|
10419
10478
|
# this parameter results in an outage and the change is applied during
|
10420
10479
|
# the next maintenance window unless the `ApplyImmediately` parameter
|
10421
|
-
# is
|
10480
|
+
# is eanbled for this request.
|
10422
10481
|
#
|
10423
10482
|
# For major version upgrades, if a nondefault DB parameter group is
|
10424
10483
|
# currently in use, a new DB parameter group in the DB parameter group
|
@@ -10426,26 +10485,26 @@ module Aws::RDS
|
|
10426
10485
|
# parameter group can be the default for that DB parameter group
|
10427
10486
|
# family.
|
10428
10487
|
#
|
10429
|
-
# For information about valid engine versions, see CreateDBInstance
|
10430
|
-
# or call DescribeDBEngineVersions
|
10488
|
+
# For information about valid engine versions, see `CreateDBInstance`,
|
10489
|
+
# or call `DescribeDBEngineVersions`.
|
10431
10490
|
# @return [String]
|
10432
10491
|
#
|
10433
10492
|
# @!attribute [rw] allow_major_version_upgrade
|
10434
|
-
#
|
10435
|
-
# parameter doesn't result in an outage and the change
|
10436
|
-
# asynchronously applied as soon as possible.
|
10493
|
+
# A value that indicates whether major version upgrades are allowed.
|
10494
|
+
# Changing this parameter doesn't result in an outage and the change
|
10495
|
+
# is asynchronously applied as soon as possible.
|
10437
10496
|
#
|
10438
|
-
# Constraints:
|
10439
|
-
# value for the EngineVersion parameter that is a different major
|
10497
|
+
# Constraints: Major version upgrades must be allowed when specifying
|
10498
|
+
# a value for the EngineVersion parameter that is a different major
|
10440
10499
|
# version than the DB instance's current version.
|
10441
10500
|
# @return [Boolean]
|
10442
10501
|
#
|
10443
10502
|
# @!attribute [rw] auto_minor_version_upgrade
|
10444
|
-
#
|
10445
|
-
# the DB instance during the maintenance window.
|
10446
|
-
# parameter doesn't result in an outage except in the
|
10447
|
-
# and the change is asynchronously applied as soon as
|
10448
|
-
# outage
|
10503
|
+
# A value that indicates whether minor version upgrades are applied
|
10504
|
+
# automatically to the DB instance during the maintenance window.
|
10505
|
+
# Changing this parameter doesn't result in an outage except in the
|
10506
|
+
# following case and the change is asynchronously applied as soon as
|
10507
|
+
# possible. An outage results if this parameter is enabled during the
|
10449
10508
|
# maintenance window, and a newer minor version is available, and RDS
|
10450
10509
|
# has enabled auto patching for that engine version.
|
10451
10510
|
# @return [Boolean]
|
@@ -10463,10 +10522,10 @@ module Aws::RDS
|
|
10463
10522
|
#
|
10464
10523
|
# Changing this setting doesn't result in an outage and the change is
|
10465
10524
|
# applied during the next maintenance window unless the
|
10466
|
-
# `ApplyImmediately` parameter is
|
10467
|
-
#
|
10468
|
-
#
|
10469
|
-
#
|
10525
|
+
# `ApplyImmediately` parameter is enabled for this request. If you are
|
10526
|
+
# migrating from Provisioned IOPS to standard storage, set this value
|
10527
|
+
# to 0. The DB instance will require a reboot for the change in
|
10528
|
+
# storage type to take effect.
|
10470
10529
|
#
|
10471
10530
|
# If you choose to migrate your DB instance from using standard
|
10472
10531
|
# storage to using Provisioned IOPS, or from using Provisioned IOPS to
|
@@ -10497,7 +10556,7 @@ module Aws::RDS
|
|
10497
10556
|
# specified option group. Changing this parameter doesn't result in
|
10498
10557
|
# an outage except in the following case and the change is applied
|
10499
10558
|
# during the next maintenance window unless the `ApplyImmediately`
|
10500
|
-
# parameter is
|
10559
|
+
# parameter is enabled for this request. If the parameter change
|
10501
10560
|
# results in an option group that enables OEM, this change can cause a
|
10502
10561
|
# brief (sub-second) period during which new connections are rejected
|
10503
10562
|
# but existing connections are not interrupted.
|
@@ -10511,9 +10570,9 @@ module Aws::RDS
|
|
10511
10570
|
# @!attribute [rw] new_db_instance_identifier
|
10512
10571
|
# The new DB instance identifier for the DB instance when renaming a
|
10513
10572
|
# DB instance. When you change the DB instance identifier, an instance
|
10514
|
-
# reboot
|
10515
|
-
#
|
10516
|
-
# Immediately
|
10573
|
+
# reboot occurs immediately if you enable `ApplyImmediately`, or will
|
10574
|
+
# occur during the next maintenance window if you disable Apply
|
10575
|
+
# Immediately. This value is stored as a lowercase string.
|
10517
10576
|
#
|
10518
10577
|
# Constraints:
|
10519
10578
|
#
|
@@ -10550,8 +10609,7 @@ module Aws::RDS
|
|
10550
10609
|
#
|
10551
10610
|
# Valid values: `standard | gp2 | io1`
|
10552
10611
|
#
|
10553
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
10554
|
-
# `standard`
|
10612
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
10555
10613
|
# @return [String]
|
10556
10614
|
#
|
10557
10615
|
# @!attribute [rw] tde_credential_arn
|
@@ -10577,15 +10635,15 @@ module Aws::RDS
|
|
10577
10635
|
# @return [String]
|
10578
10636
|
#
|
10579
10637
|
# @!attribute [rw] copy_tags_to_snapshot
|
10580
|
-
#
|
10581
|
-
#
|
10638
|
+
# A value that indicates whether to copy all tags from the DB instance
|
10639
|
+
# to snapshots of the DB instance. By default, tags are not copied.
|
10582
10640
|
#
|
10583
10641
|
# **Amazon Aurora**
|
10584
10642
|
#
|
10585
10643
|
# Not applicable. Copying tags to snapshots is managed by the DB
|
10586
10644
|
# cluster. Setting this value for an Aurora DB instance has no effect
|
10587
10645
|
# on the DB cluster setting. For more information, see
|
10588
|
-
# ModifyDBCluster
|
10646
|
+
# `ModifyDBCluster`.
|
10589
10647
|
# @return [Boolean]
|
10590
10648
|
#
|
10591
10649
|
# @!attribute [rw] monitoring_interval
|
@@ -10650,21 +10708,20 @@ module Aws::RDS
|
|
10650
10708
|
# @return [Integer]
|
10651
10709
|
#
|
10652
10710
|
# @!attribute [rw] publicly_accessible
|
10653
|
-
#
|
10654
|
-
#
|
10655
|
-
# Internet-facing with a publicly resolvable DNS name, which
|
10656
|
-
# to a public IP address.
|
10657
|
-
#
|
10711
|
+
# A value that indicates whether the DB instance is publicly
|
10712
|
+
# accessible. When the DB instance is publicly accessible, it is an
|
10713
|
+
# Internet-facing instance with a publicly resolvable DNS name, which
|
10714
|
+
# resolves to a public IP address. When the DB instance is not
|
10715
|
+
# publicly accessible, it is an internal instance with a DNS name that
|
10716
|
+
# resolves to a private IP address.
|
10658
10717
|
#
|
10659
10718
|
# `PubliclyAccessible` only applies to DB instances in a VPC. The DB
|
10660
10719
|
# instance must be part of a public subnet and `PubliclyAccessible`
|
10661
|
-
# must be
|
10720
|
+
# must be enabled for it to be publicly accessible.
|
10662
10721
|
#
|
10663
10722
|
# Changes to the `PubliclyAccessible` parameter are applied
|
10664
10723
|
# immediately regardless of the value of the `ApplyImmediately`
|
10665
10724
|
# parameter.
|
10666
|
-
#
|
10667
|
-
# Default: false
|
10668
10725
|
# @return [Boolean]
|
10669
10726
|
#
|
10670
10727
|
# @!attribute [rw] monitoring_role_arn
|
@@ -10703,8 +10760,9 @@ module Aws::RDS
|
|
10703
10760
|
# @return [Integer]
|
10704
10761
|
#
|
10705
10762
|
# @!attribute [rw] enable_iam_database_authentication
|
10706
|
-
#
|
10707
|
-
# accounts to database accounts
|
10763
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
10764
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
10765
|
+
# mapping is disabled.
|
10708
10766
|
#
|
10709
10767
|
# You can enable IAM database authentication for the following
|
10710
10768
|
# database engines
|
@@ -10713,20 +10771,18 @@ module Aws::RDS
|
|
10713
10771
|
#
|
10714
10772
|
# Not applicable. Mapping AWS IAM accounts to database accounts is
|
10715
10773
|
# managed by the DB cluster. For more information, see
|
10716
|
-
# ModifyDBCluster
|
10774
|
+
# `ModifyDBCluster`.
|
10717
10775
|
#
|
10718
10776
|
# **MySQL**
|
10719
10777
|
#
|
10720
10778
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
10721
10779
|
#
|
10722
10780
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
10723
|
-
#
|
10724
|
-
# Default: `false`
|
10725
10781
|
# @return [Boolean]
|
10726
10782
|
#
|
10727
10783
|
# @!attribute [rw] enable_performance_insights
|
10728
|
-
#
|
10729
|
-
#
|
10784
|
+
# A value that indicates whether to enable Performance Insights for
|
10785
|
+
# the DB instance.
|
10730
10786
|
#
|
10731
10787
|
# For more information, see [Using Amazon Performance Insights][1] in
|
10732
10788
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -10740,6 +10796,11 @@ module Aws::RDS
|
|
10740
10796
|
# The AWS KMS key identifier for encryption of Performance Insights
|
10741
10797
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
10742
10798
|
# identifier, or the KMS key alias for the KMS encryption key.
|
10799
|
+
#
|
10800
|
+
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
10801
|
+
# then Amazon RDS uses your default encryption key. AWS KMS creates
|
10802
|
+
# the default encryption key for your AWS account. Your AWS account
|
10803
|
+
# has a different default encryption key for each AWS Region.
|
10743
10804
|
# @return [String]
|
10744
10805
|
#
|
10745
10806
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -10762,14 +10823,15 @@ module Aws::RDS
|
|
10762
10823
|
# @return [Array<Types::ProcessorFeature>]
|
10763
10824
|
#
|
10764
10825
|
# @!attribute [rw] use_default_processor_features
|
10765
|
-
# A value that
|
10766
|
-
# uses its default processor features.
|
10826
|
+
# A value that indicates whether the DB instance class of the DB
|
10827
|
+
# instance uses its default processor features.
|
10767
10828
|
# @return [Boolean]
|
10768
10829
|
#
|
10769
10830
|
# @!attribute [rw] deletion_protection
|
10770
|
-
#
|
10771
|
-
# database can't be deleted when
|
10772
|
-
#
|
10831
|
+
# A value that indicates whether the DB instance has deletion
|
10832
|
+
# protection enabled. The database can't be deleted when deletion
|
10833
|
+
# protection is enabled. By default, deletion protection is disabled.
|
10834
|
+
# For more information, see [ Deleting a DB Instance][1].
|
10773
10835
|
#
|
10774
10836
|
#
|
10775
10837
|
#
|
@@ -10826,7 +10888,7 @@ module Aws::RDS
|
|
10826
10888
|
# Contains the details of an Amazon RDS DB instance.
|
10827
10889
|
#
|
10828
10890
|
# This data type is used as a response element in the
|
10829
|
-
# DescribeDBInstances action.
|
10891
|
+
# `DescribeDBInstances` action.
|
10830
10892
|
# @return [Types::DBInstance]
|
10831
10893
|
#
|
10832
10894
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstanceResult AWS API Documentation
|
@@ -10950,11 +11012,11 @@ module Aws::RDS
|
|
10950
11012
|
|
10951
11013
|
# @!attribute [rw] db_snapshot_attributes_result
|
10952
11014
|
# Contains the results of a successful call to the
|
10953
|
-
# DescribeDBSnapshotAttributes API action.
|
11015
|
+
# `DescribeDBSnapshotAttributes` API action.
|
10954
11016
|
#
|
10955
11017
|
# Manual DB snapshot attributes are used to authorize other AWS
|
10956
11018
|
# accounts to copy or restore a manual DB snapshot. For more
|
10957
|
-
# information, see the ModifyDBSnapshotAttribute API action.
|
11019
|
+
# information, see the `ModifyDBSnapshotAttribute` API action.
|
10958
11020
|
# @return [Types::DBSnapshotAttributesResult]
|
10959
11021
|
#
|
10960
11022
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSnapshotAttributeResult AWS API Documentation
|
@@ -11024,7 +11086,7 @@ module Aws::RDS
|
|
11024
11086
|
# Contains the details of an Amazon RDS DB snapshot.
|
11025
11087
|
#
|
11026
11088
|
# This data type is used as a response element in the
|
11027
|
-
# DescribeDBSnapshots action.
|
11089
|
+
# `DescribeDBSnapshots` action.
|
11028
11090
|
# @return [Types::DBSnapshot]
|
11029
11091
|
#
|
11030
11092
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSnapshotResult AWS API Documentation
|
@@ -11074,7 +11136,7 @@ module Aws::RDS
|
|
11074
11136
|
# Contains the details of an Amazon RDS DB subnet group.
|
11075
11137
|
#
|
11076
11138
|
# This data type is used as a response element in the
|
11077
|
-
# DescribeDBSubnetGroups action.
|
11139
|
+
# `DescribeDBSubnetGroups` action.
|
11078
11140
|
# @return [Types::DBSubnetGroup]
|
11079
11141
|
#
|
11080
11142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSubnetGroupResult AWS API Documentation
|
@@ -11127,7 +11189,7 @@ module Aws::RDS
|
|
11127
11189
|
# @return [Array<String>]
|
11128
11190
|
#
|
11129
11191
|
# @!attribute [rw] enabled
|
11130
|
-
# A
|
11192
|
+
# A value that indicates whether to activate the subscription.
|
11131
11193
|
# @return [Boolean]
|
11132
11194
|
#
|
11133
11195
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyEventSubscriptionMessage AWS API Documentation
|
@@ -11143,7 +11205,7 @@ module Aws::RDS
|
|
11143
11205
|
|
11144
11206
|
# @!attribute [rw] event_subscription
|
11145
11207
|
# Contains the results of a successful invocation of the
|
11146
|
-
# DescribeEventSubscriptions action.
|
11208
|
+
# `DescribeEventSubscriptions` action.
|
11147
11209
|
# @return [Types::EventSubscription]
|
11148
11210
|
#
|
11149
11211
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyEventSubscriptionResult AWS API Documentation
|
@@ -11191,8 +11253,8 @@ module Aws::RDS
|
|
11191
11253
|
#
|
11192
11254
|
# @!attribute [rw] deletion_protection
|
11193
11255
|
# Indicates if the global database cluster has deletion protection
|
11194
|
-
# enabled. The global database cluster can't be deleted when
|
11195
|
-
#
|
11256
|
+
# enabled. The global database cluster can't be deleted when deletion
|
11257
|
+
# protection is enabled.
|
11196
11258
|
# @return [Boolean]
|
11197
11259
|
#
|
11198
11260
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyGlobalClusterMessage AWS API Documentation
|
@@ -11266,7 +11328,7 @@ module Aws::RDS
|
|
11266
11328
|
# @return [Array<String>]
|
11267
11329
|
#
|
11268
11330
|
# @!attribute [rw] apply_immediately
|
11269
|
-
#
|
11331
|
+
# A value that indicates whether to apply the change immediately or
|
11270
11332
|
# during the next maintenance window for each instance associated with
|
11271
11333
|
# the option group.
|
11272
11334
|
# @return [Boolean]
|
@@ -11753,7 +11815,7 @@ module Aws::RDS
|
|
11753
11815
|
end
|
11754
11816
|
|
11755
11817
|
# The version for an option. Option group option versions are returned
|
11756
|
-
# by the DescribeOptionGroupOptions action.
|
11818
|
+
# by the `DescribeOptionGroupOptions` action.
|
11757
11819
|
#
|
11758
11820
|
# @!attribute [rw] version
|
11759
11821
|
# The version of the option.
|
@@ -11775,7 +11837,7 @@ module Aws::RDS
|
|
11775
11837
|
# Contains a list of available options for a DB instance.
|
11776
11838
|
#
|
11777
11839
|
# This data type is used as a response element in the
|
11778
|
-
# DescribeOrderableDBInstanceOptions action.
|
11840
|
+
# `DescribeOrderableDBInstanceOptions` action.
|
11779
11841
|
#
|
11780
11842
|
# @!attribute [rw] engine
|
11781
11843
|
# The engine type of a DB instance.
|
@@ -11898,11 +11960,11 @@ module Aws::RDS
|
|
11898
11960
|
end
|
11899
11961
|
|
11900
11962
|
# Contains the result of a successful invocation of the
|
11901
|
-
# DescribeOrderableDBInstanceOptions action.
|
11963
|
+
# `DescribeOrderableDBInstanceOptions` action.
|
11902
11964
|
#
|
11903
11965
|
# @!attribute [rw] orderable_db_instance_options
|
11904
|
-
# An OrderableDBInstanceOption structure containing information
|
11905
|
-
# orderable options for the DB instance.
|
11966
|
+
# An `OrderableDBInstanceOption` structure containing information
|
11967
|
+
# about orderable options for the DB instance.
|
11906
11968
|
# @return [Array<Types::OrderableDBInstanceOption>]
|
11907
11969
|
#
|
11908
11970
|
# @!attribute [rw] marker
|
@@ -11921,10 +11983,10 @@ module Aws::RDS
|
|
11921
11983
|
end
|
11922
11984
|
|
11923
11985
|
# This data type is used as a request parameter in the
|
11924
|
-
# ModifyDBParameterGroup and ResetDBParameterGroup actions.
|
11986
|
+
# `ModifyDBParameterGroup` and `ResetDBParameterGroup` actions.
|
11925
11987
|
#
|
11926
11988
|
# This data type is used as a response element in the
|
11927
|
-
# DescribeEngineDefaultParameters and DescribeDBParameters actions.
|
11989
|
+
# `DescribeEngineDefaultParameters` and `DescribeDBParameters` actions.
|
11928
11990
|
#
|
11929
11991
|
# @note When making an API call, you may pass Parameter
|
11930
11992
|
# data as a hash:
|
@@ -12060,7 +12122,7 @@ module Aws::RDS
|
|
12060
12122
|
# @!attribute [rw] current_apply_date
|
12061
12123
|
# The effective date when the pending maintenance action is applied to
|
12062
12124
|
# the resource. This date takes into account opt-in requests received
|
12063
|
-
# from the ApplyPendingMaintenanceAction API, the
|
12125
|
+
# from the `ApplyPendingMaintenanceAction` API, the
|
12064
12126
|
# `AutoAppliedAfterDate`, and the `ForcedApplyDate`. This value is
|
12065
12127
|
# blank if an opt-in request has not been received and nothing has
|
12066
12128
|
# been specified as `AutoAppliedAfterDate` or `ForcedApplyDate`.
|
@@ -12103,7 +12165,7 @@ module Aws::RDS
|
|
12103
12165
|
include Aws::Structure
|
12104
12166
|
end
|
12105
12167
|
|
12106
|
-
# This data type is used as a response element in the ModifyDBInstance
|
12168
|
+
# This data type is used as a response element in the `ModifyDBInstance`
|
12107
12169
|
# action.
|
12108
12170
|
#
|
12109
12171
|
# @!attribute [rw] db_instance_class
|
@@ -12209,28 +12271,28 @@ module Aws::RDS
|
|
12209
12271
|
# You can set the processor features of the DB instance class for a DB
|
12210
12272
|
# instance when you call one of the following actions:
|
12211
12273
|
#
|
12212
|
-
# * CreateDBInstance
|
12274
|
+
# * `CreateDBInstance`
|
12213
12275
|
#
|
12214
|
-
# * ModifyDBInstance
|
12276
|
+
# * `ModifyDBInstance`
|
12215
12277
|
#
|
12216
|
-
# * RestoreDBInstanceFromDBSnapshot
|
12278
|
+
# * `RestoreDBInstanceFromDBSnapshot`
|
12217
12279
|
#
|
12218
|
-
# * RestoreDBInstanceFromS3
|
12280
|
+
# * `RestoreDBInstanceFromS3`
|
12219
12281
|
#
|
12220
|
-
# * RestoreDBInstanceToPointInTime
|
12282
|
+
# * `RestoreDBInstanceToPointInTime`
|
12221
12283
|
#
|
12222
12284
|
# You can view the valid processor values for a particular instance
|
12223
|
-
# class by calling the DescribeOrderableDBInstanceOptions action and
|
12285
|
+
# class by calling the `DescribeOrderableDBInstanceOptions` action and
|
12224
12286
|
# specifying the instance class for the `DBInstanceClass` parameter.
|
12225
12287
|
#
|
12226
12288
|
# In addition, you can use the following actions for DB instance class
|
12227
12289
|
# processor information:
|
12228
12290
|
#
|
12229
|
-
# * DescribeDBInstances
|
12291
|
+
# * `DescribeDBInstances`
|
12230
12292
|
#
|
12231
|
-
# * DescribeDBSnapshots
|
12293
|
+
# * `DescribeDBSnapshots`
|
12232
12294
|
#
|
12233
|
-
# * DescribeValidDBInstanceModifications
|
12295
|
+
# * `DescribeValidDBInstanceModifications`
|
12234
12296
|
#
|
12235
12297
|
# For more information, see [Configuring the Processor of the DB
|
12236
12298
|
# Instance Class][1] in the <i>Amazon RDS User Guide. </i>
|
@@ -12295,7 +12357,7 @@ module Aws::RDS
|
|
12295
12357
|
# Contains the details of an Amazon Aurora DB cluster.
|
12296
12358
|
#
|
12297
12359
|
# This data type is used as a response element in the
|
12298
|
-
# DescribeDBClusters
|
12360
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
12299
12361
|
# @return [Types::DBCluster]
|
12300
12362
|
#
|
12301
12363
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplicaDBClusterResult AWS API Documentation
|
@@ -12379,7 +12441,7 @@ module Aws::RDS
|
|
12379
12441
|
# Contains the details of an Amazon RDS DB instance.
|
12380
12442
|
#
|
12381
12443
|
# This data type is used as a response element in the
|
12382
|
-
# DescribeDBInstances action.
|
12444
|
+
# `DescribeDBInstances` action.
|
12383
12445
|
# @return [Types::DBInstance]
|
12384
12446
|
#
|
12385
12447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplicaResult AWS API Documentation
|
@@ -12443,8 +12505,8 @@ module Aws::RDS
|
|
12443
12505
|
|
12444
12506
|
# @!attribute [rw] reserved_db_instance
|
12445
12507
|
# This data type is used as a response element in the
|
12446
|
-
# DescribeReservedDBInstances and
|
12447
|
-
# actions.
|
12508
|
+
# `DescribeReservedDBInstances` and
|
12509
|
+
# `PurchaseReservedDBInstancesOffering` actions.
|
12448
12510
|
# @return [Types::ReservedDBInstance]
|
12449
12511
|
#
|
12450
12512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PurchaseReservedDBInstancesOfferingResult AWS API Documentation
|
@@ -12501,10 +12563,11 @@ module Aws::RDS
|
|
12501
12563
|
# @return [String]
|
12502
12564
|
#
|
12503
12565
|
# @!attribute [rw] force_failover
|
12504
|
-
#
|
12566
|
+
# A value that indicates whether the reboot is conducted through a
|
12567
|
+
# Multi-AZ failover.
|
12505
12568
|
#
|
12506
|
-
# Constraint: You can't
|
12507
|
-
# configured for
|
12569
|
+
# Constraint: You can't enable force failover if the instance is not
|
12570
|
+
# configured for Multi-AZ.
|
12508
12571
|
# @return [Boolean]
|
12509
12572
|
#
|
12510
12573
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstanceMessage AWS API Documentation
|
@@ -12519,7 +12582,7 @@ module Aws::RDS
|
|
12519
12582
|
# Contains the details of an Amazon RDS DB instance.
|
12520
12583
|
#
|
12521
12584
|
# This data type is used as a response element in the
|
12522
|
-
# DescribeDBInstances action.
|
12585
|
+
# `DescribeDBInstances` action.
|
12523
12586
|
# @return [Types::DBInstance]
|
12524
12587
|
#
|
12525
12588
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstanceResult AWS API Documentation
|
@@ -12530,8 +12593,8 @@ module Aws::RDS
|
|
12530
12593
|
end
|
12531
12594
|
|
12532
12595
|
# This data type is used as a response element in the
|
12533
|
-
# DescribeReservedDBInstances and
|
12534
|
-
# actions.
|
12596
|
+
# `DescribeReservedDBInstances` and
|
12597
|
+
# `DescribeReservedDBInstancesOfferings` actions.
|
12535
12598
|
#
|
12536
12599
|
# @!attribute [rw] recurring_charge_amount
|
12537
12600
|
# The amount of the recurring charge.
|
@@ -12642,7 +12705,7 @@ module Aws::RDS
|
|
12642
12705
|
# @!attribute [rw] feature_name
|
12643
12706
|
# The name of the feature for the DB instance that the IAM role is to
|
12644
12707
|
# be disassociated from. For the list of supported feature names, see
|
12645
|
-
# DBEngineVersion
|
12708
|
+
# `DBEngineVersion`.
|
12646
12709
|
# @return [String]
|
12647
12710
|
#
|
12648
12711
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveRoleFromDBInstanceMessage AWS API Documentation
|
@@ -12683,7 +12746,7 @@ module Aws::RDS
|
|
12683
12746
|
|
12684
12747
|
# @!attribute [rw] event_subscription
|
12685
12748
|
# Contains the results of a successful invocation of the
|
12686
|
-
# DescribeEventSubscriptions action.
|
12749
|
+
# `DescribeEventSubscriptions` action.
|
12687
12750
|
# @return [Types::EventSubscription]
|
12688
12751
|
#
|
12689
12752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveSourceIdentifierFromSubscriptionResult AWS API Documentation
|
@@ -12725,8 +12788,8 @@ module Aws::RDS
|
|
12725
12788
|
end
|
12726
12789
|
|
12727
12790
|
# This data type is used as a response element in the
|
12728
|
-
# DescribeReservedDBInstances and
|
12729
|
-
# actions.
|
12791
|
+
# `DescribeReservedDBInstances` and
|
12792
|
+
# `PurchaseReservedDBInstancesOffering` actions.
|
12730
12793
|
#
|
12731
12794
|
# @!attribute [rw] reserved_db_instance_id
|
12732
12795
|
# The unique identifier for the reservation.
|
@@ -12810,7 +12873,7 @@ module Aws::RDS
|
|
12810
12873
|
end
|
12811
12874
|
|
12812
12875
|
# Contains the result of a successful invocation of the
|
12813
|
-
# DescribeReservedDBInstances action.
|
12876
|
+
# `DescribeReservedDBInstances` action.
|
12814
12877
|
#
|
12815
12878
|
# @!attribute [rw] marker
|
12816
12879
|
# An optional pagination token provided by a previous request. If this
|
@@ -12831,7 +12894,7 @@ module Aws::RDS
|
|
12831
12894
|
end
|
12832
12895
|
|
12833
12896
|
# This data type is used as a response element in the
|
12834
|
-
# DescribeReservedDBInstancesOfferings action.
|
12897
|
+
# `DescribeReservedDBInstancesOfferings` action.
|
12835
12898
|
#
|
12836
12899
|
# @!attribute [rw] reserved_db_instances_offering_id
|
12837
12900
|
# The offering identifier.
|
@@ -12890,7 +12953,7 @@ module Aws::RDS
|
|
12890
12953
|
end
|
12891
12954
|
|
12892
12955
|
# Contains the result of a successful invocation of the
|
12893
|
-
# DescribeReservedDBInstancesOfferings action.
|
12956
|
+
# `DescribeReservedDBInstancesOfferings` action.
|
12894
12957
|
#
|
12895
12958
|
# @!attribute [rw] marker
|
12896
12959
|
# An optional pagination token provided by a previous request. If this
|
@@ -12938,16 +13001,16 @@ module Aws::RDS
|
|
12938
13001
|
# @return [String]
|
12939
13002
|
#
|
12940
13003
|
# @!attribute [rw] reset_all_parameters
|
12941
|
-
# A value that
|
12942
|
-
# cluster parameter group to their default values
|
12943
|
-
#
|
12944
|
-
#
|
13004
|
+
# A value that indicates whether to reset all parameters in the DB
|
13005
|
+
# cluster parameter group to their default values. You can't use this
|
13006
|
+
# parameter if there is a list of parameter names specified for the
|
13007
|
+
# `Parameters` parameter.
|
12945
13008
|
# @return [Boolean]
|
12946
13009
|
#
|
12947
13010
|
# @!attribute [rw] parameters
|
12948
13011
|
# A list of parameter names in the DB cluster parameter group to reset
|
12949
13012
|
# to the default values. You can't use this parameter if the
|
12950
|
-
# `ResetAllParameters` parameter is
|
13013
|
+
# `ResetAllParameters` parameter is enabled.
|
12951
13014
|
# @return [Array<Types::Parameter>]
|
12952
13015
|
#
|
12953
13016
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ResetDBClusterParameterGroupMessage AWS API Documentation
|
@@ -12993,10 +13056,9 @@ module Aws::RDS
|
|
12993
13056
|
# @return [String]
|
12994
13057
|
#
|
12995
13058
|
# @!attribute [rw] reset_all_parameters
|
12996
|
-
#
|
12997
|
-
#
|
12998
|
-
#
|
12999
|
-
# Default: `true`
|
13059
|
+
# A value that indicates whether to reset all parameters in the DB
|
13060
|
+
# parameter group to default values. By default, all parameters in the
|
13061
|
+
# DB parameter group are reset to default values.
|
13000
13062
|
# @return [Boolean]
|
13001
13063
|
#
|
13002
13064
|
# @!attribute [rw] parameters
|
@@ -13096,8 +13158,8 @@ module Aws::RDS
|
|
13096
13158
|
# }
|
13097
13159
|
#
|
13098
13160
|
# @!attribute [rw] availability_zones
|
13099
|
-
# A list of
|
13100
|
-
# cluster can be created
|
13161
|
+
# A list of Availability Zones (AZs) where instances in the restored
|
13162
|
+
# DB cluster can be created.
|
13101
13163
|
# @return [Array<String>]
|
13102
13164
|
#
|
13103
13165
|
# @!attribute [rw] backup_retention_period
|
@@ -13273,7 +13335,7 @@ module Aws::RDS
|
|
13273
13335
|
# @return [Array<Types::Tag>]
|
13274
13336
|
#
|
13275
13337
|
# @!attribute [rw] storage_encrypted
|
13276
|
-
#
|
13338
|
+
# A value that indicates whether the restored DB cluster is encrypted.
|
13277
13339
|
# @return [Boolean]
|
13278
13340
|
#
|
13279
13341
|
# @!attribute [rw] kms_key_id
|
@@ -13285,7 +13347,7 @@ module Aws::RDS
|
|
13285
13347
|
# cluster, then you can use the KMS key alias instead of the ARN for
|
13286
13348
|
# the KM encryption key.
|
13287
13349
|
#
|
13288
|
-
# If the
|
13350
|
+
# If the StorageEncrypted parameter is enabled, and you do not specify
|
13289
13351
|
# a value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
13290
13352
|
# default encryption key. AWS KMS creates the default encryption key
|
13291
13353
|
# for your AWS account. Your AWS account has a different default
|
@@ -13293,10 +13355,9 @@ module Aws::RDS
|
|
13293
13355
|
# @return [String]
|
13294
13356
|
#
|
13295
13357
|
# @!attribute [rw] enable_iam_database_authentication
|
13296
|
-
#
|
13297
|
-
# accounts to database accounts
|
13298
|
-
#
|
13299
|
-
# Default: `false`
|
13358
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
13359
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
13360
|
+
# mapping is disabled.
|
13300
13361
|
# @return [Boolean]
|
13301
13362
|
#
|
13302
13363
|
# @!attribute [rw] source_engine
|
@@ -13358,14 +13419,15 @@ module Aws::RDS
|
|
13358
13419
|
# @return [Array<String>]
|
13359
13420
|
#
|
13360
13421
|
# @!attribute [rw] deletion_protection
|
13361
|
-
#
|
13362
|
-
# The database can't be deleted when
|
13363
|
-
# default is
|
13422
|
+
# A value that indicates whether the DB cluster has deletion
|
13423
|
+
# protection enabled. The database can't be deleted when deletion
|
13424
|
+
# protection is enabled. By default, deletion protection is disabled.
|
13364
13425
|
# @return [Boolean]
|
13365
13426
|
#
|
13366
13427
|
# @!attribute [rw] copy_tags_to_snapshot
|
13367
|
-
#
|
13368
|
-
# the restored DB cluster
|
13428
|
+
# A value that indicates whether to copy all tags from the restored DB
|
13429
|
+
# cluster to snapshots of the restored DB cluster. The default is not
|
13430
|
+
# to copy them.
|
13369
13431
|
# @return [Boolean]
|
13370
13432
|
#
|
13371
13433
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3Message AWS API Documentation
|
@@ -13407,7 +13469,7 @@ module Aws::RDS
|
|
13407
13469
|
# Contains the details of an Amazon Aurora DB cluster.
|
13408
13470
|
#
|
13409
13471
|
# This data type is used as a response element in the
|
13410
|
-
# DescribeDBClusters
|
13472
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
13411
13473
|
# @return [Types::DBCluster]
|
13412
13474
|
#
|
13413
13475
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3Result AWS API Documentation
|
@@ -13455,8 +13517,8 @@ module Aws::RDS
|
|
13455
13517
|
# }
|
13456
13518
|
#
|
13457
13519
|
# @!attribute [rw] availability_zones
|
13458
|
-
# Provides the list of
|
13459
|
-
#
|
13520
|
+
# Provides the list of Availability Zones (AZs) where instances in the
|
13521
|
+
# restored DB cluster can be created.
|
13460
13522
|
# @return [Array<String>]
|
13461
13523
|
#
|
13462
13524
|
# @!attribute [rw] db_cluster_identifier
|
@@ -13558,10 +13620,9 @@ module Aws::RDS
|
|
13558
13620
|
# @return [String]
|
13559
13621
|
#
|
13560
13622
|
# @!attribute [rw] enable_iam_database_authentication
|
13561
|
-
#
|
13562
|
-
# accounts to database accounts
|
13563
|
-
#
|
13564
|
-
# Default: `false`
|
13623
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
13624
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
13625
|
+
# mapping is disabled.
|
13565
13626
|
# @return [Boolean]
|
13566
13627
|
#
|
13567
13628
|
# @!attribute [rw] backtrack_window
|
@@ -13617,14 +13678,15 @@ module Aws::RDS
|
|
13617
13678
|
# @return [String]
|
13618
13679
|
#
|
13619
13680
|
# @!attribute [rw] deletion_protection
|
13620
|
-
#
|
13621
|
-
# The database can't be deleted when
|
13622
|
-
# default is
|
13681
|
+
# A value that indicates whether the DB cluster has deletion
|
13682
|
+
# protection enabled. The database can't be deleted when deletion
|
13683
|
+
# protection is enabled. By default, deletion protection is disabled.
|
13623
13684
|
# @return [Boolean]
|
13624
13685
|
#
|
13625
13686
|
# @!attribute [rw] copy_tags_to_snapshot
|
13626
|
-
#
|
13627
|
-
# the restored DB cluster
|
13687
|
+
# A value that indicates whether to copy all tags from the restored DB
|
13688
|
+
# cluster to snapshots of the restored DB cluster. The default is not
|
13689
|
+
# to copy them.
|
13628
13690
|
# @return [Boolean]
|
13629
13691
|
#
|
13630
13692
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromSnapshotMessage AWS API Documentation
|
@@ -13657,7 +13719,7 @@ module Aws::RDS
|
|
13657
13719
|
# Contains the details of an Amazon Aurora DB cluster.
|
13658
13720
|
#
|
13659
13721
|
# This data type is used as a response element in the
|
13660
|
-
# DescribeDBClusters
|
13722
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
13661
13723
|
# @return [Types::DBCluster]
|
13662
13724
|
#
|
13663
13725
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromSnapshotResult AWS API Documentation
|
@@ -13747,18 +13809,19 @@ module Aws::RDS
|
|
13747
13809
|
# * Must be specified if `UseLatestRestorableTime` parameter is not
|
13748
13810
|
# provided
|
13749
13811
|
#
|
13750
|
-
# * Can't be specified if `UseLatestRestorableTime` parameter is
|
13812
|
+
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
13813
|
+
# enabled
|
13751
13814
|
#
|
13752
|
-
# * Can't be specified if `RestoreType` parameter is
|
13815
|
+
# * Can't be specified if the `RestoreType` parameter is
|
13816
|
+
# `copy-on-write`
|
13753
13817
|
#
|
13754
13818
|
# Example: `2015-03-07T23:45:00Z`
|
13755
13819
|
# @return [Time]
|
13756
13820
|
#
|
13757
13821
|
# @!attribute [rw] use_latest_restorable_time
|
13758
|
-
# A value that
|
13759
|
-
# latest restorable backup time,
|
13760
|
-
#
|
13761
|
-
# Default: `false`
|
13822
|
+
# A value that indicates whether to restore the DB cluster to the
|
13823
|
+
# latest restorable backup time. By default, the DB cluster is not
|
13824
|
+
# restored to the latest restorable backup time.
|
13762
13825
|
#
|
13763
13826
|
# Constraints: Can't be specified if `RestoreToTime` parameter is
|
13764
13827
|
# provided.
|
@@ -13828,10 +13891,9 @@ module Aws::RDS
|
|
13828
13891
|
# @return [String]
|
13829
13892
|
#
|
13830
13893
|
# @!attribute [rw] enable_iam_database_authentication
|
13831
|
-
#
|
13832
|
-
# accounts to database accounts
|
13833
|
-
#
|
13834
|
-
# Default: `false`
|
13894
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
13895
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
13896
|
+
# mapping is disabled.
|
13835
13897
|
# @return [Boolean]
|
13836
13898
|
#
|
13837
13899
|
# @!attribute [rw] backtrack_window
|
@@ -13877,14 +13939,15 @@ module Aws::RDS
|
|
13877
13939
|
# @return [String]
|
13878
13940
|
#
|
13879
13941
|
# @!attribute [rw] deletion_protection
|
13880
|
-
#
|
13881
|
-
# The database can't be deleted when
|
13882
|
-
# default is
|
13942
|
+
# A value that indicates whether the DB cluster has deletion
|
13943
|
+
# protection enabled. The database can't be deleted when deletion
|
13944
|
+
# protection is enabled. By default, deletion protection is disabled.
|
13883
13945
|
# @return [Boolean]
|
13884
13946
|
#
|
13885
13947
|
# @!attribute [rw] copy_tags_to_snapshot
|
13886
|
-
#
|
13887
|
-
# the restored DB cluster
|
13948
|
+
# A value that indicates whether to copy all tags from the restored DB
|
13949
|
+
# cluster to snapshots of the restored DB cluster. The default is not
|
13950
|
+
# to copy them.
|
13888
13951
|
# @return [Boolean]
|
13889
13952
|
#
|
13890
13953
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTimeMessage AWS API Documentation
|
@@ -13914,7 +13977,7 @@ module Aws::RDS
|
|
13914
13977
|
# Contains the details of an Amazon Aurora DB cluster.
|
13915
13978
|
#
|
13916
13979
|
# This data type is used as a response element in the
|
13917
|
-
# DescribeDBClusters
|
13980
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
13918
13981
|
# @return [Types::DBCluster]
|
13919
13982
|
#
|
13920
13983
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTimeResult AWS API Documentation
|
@@ -14017,12 +14080,12 @@ module Aws::RDS
|
|
14017
14080
|
# @return [Integer]
|
14018
14081
|
#
|
14019
14082
|
# @!attribute [rw] availability_zone
|
14020
|
-
# The
|
14083
|
+
# The Availability Zone (AZ) where the DB instance will be created.
|
14021
14084
|
#
|
14022
14085
|
# Default: A random, system-chosen Availability Zone.
|
14023
14086
|
#
|
14024
|
-
# Constraint: You can't specify the AvailabilityZone parameter if
|
14025
|
-
#
|
14087
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if
|
14088
|
+
# the DB instance is a Multi-AZ deployment.
|
14026
14089
|
#
|
14027
14090
|
# Example: `us-east-1a`
|
14028
14091
|
# @return [String]
|
@@ -14037,24 +14100,26 @@ module Aws::RDS
|
|
14037
14100
|
# @return [String]
|
14038
14101
|
#
|
14039
14102
|
# @!attribute [rw] multi_az
|
14040
|
-
#
|
14103
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
14104
|
+
# deployment.
|
14041
14105
|
#
|
14042
|
-
# Constraint: You can't specify the AvailabilityZone parameter if
|
14043
|
-
#
|
14106
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if
|
14107
|
+
# the DB instance is a Multi-AZ deployment.
|
14044
14108
|
# @return [Boolean]
|
14045
14109
|
#
|
14046
14110
|
# @!attribute [rw] publicly_accessible
|
14047
|
-
#
|
14048
|
-
#
|
14049
|
-
#
|
14050
|
-
#
|
14111
|
+
# A value that indicates whether the DB instance is publicly
|
14112
|
+
# accessible. When the DB instance is publicly accessible, it is an
|
14113
|
+
# Internet-facing instance with a publicly resolvable DNS name, which
|
14114
|
+
# resolves to a public IP address. When the DB instance is not
|
14115
|
+
# publicly accessible, it is an internal instance with a DNS name that
|
14051
14116
|
# resolves to a private IP address. For more information, see
|
14052
14117
|
# CreateDBInstance.
|
14053
14118
|
# @return [Boolean]
|
14054
14119
|
#
|
14055
14120
|
# @!attribute [rw] auto_minor_version_upgrade
|
14056
|
-
#
|
14057
|
-
# the DB instance during the maintenance window.
|
14121
|
+
# A value that indicates whether minor version upgrades are applied
|
14122
|
+
# automatically to the DB instance during the maintenance window.
|
14058
14123
|
# @return [Boolean]
|
14059
14124
|
#
|
14060
14125
|
# @!attribute [rw] license_model
|
@@ -14156,8 +14221,7 @@ module Aws::RDS
|
|
14156
14221
|
# If you specify `io1`, you must also include a value for the `Iops`
|
14157
14222
|
# parameter.
|
14158
14223
|
#
|
14159
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
14160
|
-
# `standard`
|
14224
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
14161
14225
|
# @return [String]
|
14162
14226
|
#
|
14163
14227
|
# @!attribute [rw] tde_credential_arn
|
@@ -14183,8 +14247,9 @@ module Aws::RDS
|
|
14183
14247
|
# @return [String]
|
14184
14248
|
#
|
14185
14249
|
# @!attribute [rw] copy_tags_to_snapshot
|
14186
|
-
#
|
14187
|
-
#
|
14250
|
+
# A value that indicates whether to copy all tags from the restored DB
|
14251
|
+
# instance to snapshots of the DB instance. By default, tags are not
|
14252
|
+
# copied.
|
14188
14253
|
# @return [Boolean]
|
14189
14254
|
#
|
14190
14255
|
# @!attribute [rw] domain_iam_role_name
|
@@ -14193,8 +14258,9 @@ module Aws::RDS
|
|
14193
14258
|
# @return [String]
|
14194
14259
|
#
|
14195
14260
|
# @!attribute [rw] enable_iam_database_authentication
|
14196
|
-
#
|
14197
|
-
# accounts to database accounts
|
14261
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
14262
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
14263
|
+
# mapping is disabled.
|
14198
14264
|
#
|
14199
14265
|
# You can enable IAM database authentication for the following
|
14200
14266
|
# database engines
|
@@ -14202,8 +14268,6 @@ module Aws::RDS
|
|
14202
14268
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
14203
14269
|
#
|
14204
14270
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
14205
|
-
#
|
14206
|
-
# Default: `false`
|
14207
14271
|
# @return [Boolean]
|
14208
14272
|
#
|
14209
14273
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
@@ -14223,8 +14287,8 @@ module Aws::RDS
|
|
14223
14287
|
# @return [Array<Types::ProcessorFeature>]
|
14224
14288
|
#
|
14225
14289
|
# @!attribute [rw] use_default_processor_features
|
14226
|
-
# A value that
|
14227
|
-
# uses its default processor features.
|
14290
|
+
# A value that indicates whether the DB instance class of the DB
|
14291
|
+
# instance uses its default processor features.
|
14228
14292
|
# @return [Boolean]
|
14229
14293
|
#
|
14230
14294
|
# @!attribute [rw] db_parameter_group_name
|
@@ -14244,10 +14308,10 @@ module Aws::RDS
|
|
14244
14308
|
# @return [String]
|
14245
14309
|
#
|
14246
14310
|
# @!attribute [rw] deletion_protection
|
14247
|
-
#
|
14248
|
-
# enabled. The database can't be deleted when
|
14249
|
-
#
|
14250
|
-
# DB Instance][1].
|
14311
|
+
# A value that indicates whether the DB instance has deletion
|
14312
|
+
# protection enabled. The database can't be deleted when deletion
|
14313
|
+
# protection is enabled. By default, deletion protection is disabled.
|
14314
|
+
# For more information, see [ Deleting a DB Instance][1].
|
14251
14315
|
#
|
14252
14316
|
#
|
14253
14317
|
#
|
@@ -14292,7 +14356,7 @@ module Aws::RDS
|
|
14292
14356
|
# Contains the details of an Amazon RDS DB instance.
|
14293
14357
|
#
|
14294
14358
|
# This data type is used as a response element in the
|
14295
|
-
# DescribeDBInstances action.
|
14359
|
+
# `DescribeDBInstances` action.
|
14296
14360
|
# @return [Types::DBInstance]
|
14297
14361
|
#
|
14298
14362
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshotResult AWS API Documentation
|
@@ -14363,7 +14427,7 @@ module Aws::RDS
|
|
14363
14427
|
#
|
14364
14428
|
# @!attribute [rw] db_name
|
14365
14429
|
# The name of the database to create when the DB instance is created.
|
14366
|
-
# Follow the naming rules specified in CreateDBInstance
|
14430
|
+
# Follow the naming rules specified in `CreateDBInstance`.
|
14367
14431
|
# @return [String]
|
14368
14432
|
#
|
14369
14433
|
# @!attribute [rw] db_instance_identifier
|
@@ -14384,7 +14448,7 @@ module Aws::RDS
|
|
14384
14448
|
# @!attribute [rw] allocated_storage
|
14385
14449
|
# The amount of storage (in gigabytes) to allocate initially for the
|
14386
14450
|
# DB instance. Follow the allocation rules specified in
|
14387
|
-
# CreateDBInstance
|
14451
|
+
# `CreateDBInstance`.
|
14388
14452
|
#
|
14389
14453
|
# <note markdown="1"> Be sure to allocate enough memory for your new DB instance so that
|
14390
14454
|
# the restore operation can succeed. You can also allocate additional
|
@@ -14453,8 +14517,8 @@ module Aws::RDS
|
|
14453
14517
|
#
|
14454
14518
|
# Example: `us-east-1d`
|
14455
14519
|
#
|
14456
|
-
# Constraint: The AvailabilityZone parameter can't be specified if
|
14457
|
-
# the
|
14520
|
+
# Constraint: The `AvailabilityZone` parameter can't be specified if
|
14521
|
+
# the DB instance is a Multi-AZ deployment. The specified Availability
|
14458
14522
|
# Zone must be in the same AWS Region as the current endpoint.
|
14459
14523
|
#
|
14460
14524
|
#
|
@@ -14497,7 +14561,7 @@ module Aws::RDS
|
|
14497
14561
|
# @!attribute [rw] backup_retention_period
|
14498
14562
|
# The number of days for which automated backups are retained. Setting
|
14499
14563
|
# this parameter to a positive number enables backups. For more
|
14500
|
-
# information, see CreateDBInstance
|
14564
|
+
# information, see `CreateDBInstance`.
|
14501
14565
|
# @return [Integer]
|
14502
14566
|
#
|
14503
14567
|
# @!attribute [rw] preferred_backup_window
|
@@ -14531,23 +14595,22 @@ module Aws::RDS
|
|
14531
14595
|
# @return [Integer]
|
14532
14596
|
#
|
14533
14597
|
# @!attribute [rw] multi_az
|
14534
|
-
#
|
14535
|
-
#
|
14536
|
-
# parameter.
|
14598
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
14599
|
+
# deployment. If the DB instance is a Multi-AZ deployment, you can't
|
14600
|
+
# set the `AvailabilityZone` parameter.
|
14537
14601
|
# @return [Boolean]
|
14538
14602
|
#
|
14539
14603
|
# @!attribute [rw] engine_version
|
14540
14604
|
# The version number of the database engine to use. Choose the latest
|
14541
14605
|
# minor version of your database engine. For information about engine
|
14542
|
-
# versions, see CreateDBInstance
|
14606
|
+
# versions, see `CreateDBInstance`, or call
|
14607
|
+
# `DescribeDBEngineVersions`.
|
14543
14608
|
# @return [String]
|
14544
14609
|
#
|
14545
14610
|
# @!attribute [rw] auto_minor_version_upgrade
|
14546
|
-
#
|
14547
|
-
# automatically to the DB instance during the maintenance window
|
14548
|
-
#
|
14549
|
-
#
|
14550
|
-
# Default: `true`
|
14611
|
+
# A value that indicates whether minor engine upgrades are applied
|
14612
|
+
# automatically to the DB instance during the maintenance window. By
|
14613
|
+
# default, minor engine upgrades are not applied automatically.
|
14551
14614
|
# @return [Boolean]
|
14552
14615
|
#
|
14553
14616
|
# @!attribute [rw] license_model
|
@@ -14573,10 +14636,11 @@ module Aws::RDS
|
|
14573
14636
|
# @return [String]
|
14574
14637
|
#
|
14575
14638
|
# @!attribute [rw] publicly_accessible
|
14576
|
-
#
|
14577
|
-
#
|
14578
|
-
#
|
14579
|
-
#
|
14639
|
+
# A value that indicates whether the DB instance is publicly
|
14640
|
+
# accessible. When the DB instance is publicly accessible, it is an
|
14641
|
+
# Internet-facing instance with a publicly resolvable DNS name, which
|
14642
|
+
# resolves to a public IP address. When the DB instance is not
|
14643
|
+
# publicly accessible, it is an internal instance with a DNS name that
|
14580
14644
|
# resolves to a private IP address. For more information, see
|
14581
14645
|
# CreateDBInstance.
|
14582
14646
|
# @return [Boolean]
|
@@ -14599,12 +14663,12 @@ module Aws::RDS
|
|
14599
14663
|
# If you specify `io1`, you must also include a value for the `Iops`
|
14600
14664
|
# parameter.
|
14601
14665
|
#
|
14602
|
-
# Default: `io1` if the `Iops` parameter is specified; otherwise
|
14603
|
-
# `standard`
|
14666
|
+
# Default: `io1` if the `Iops` parameter is specified; otherwise `gp2`
|
14604
14667
|
# @return [String]
|
14605
14668
|
#
|
14606
14669
|
# @!attribute [rw] storage_encrypted
|
14607
|
-
#
|
14670
|
+
# A value that indicates whether the new DB instance is encrypted or
|
14671
|
+
# not.
|
14608
14672
|
# @return [Boolean]
|
14609
14673
|
#
|
14610
14674
|
# @!attribute [rw] kms_key_id
|
@@ -14616,18 +14680,16 @@ module Aws::RDS
|
|
14616
14680
|
# instance, then you can use the KMS key alias instead of the ARN for
|
14617
14681
|
# the KM encryption key.
|
14618
14682
|
#
|
14619
|
-
# If the `StorageEncrypted` parameter is
|
14620
|
-
# a value for the `KmsKeyId` parameter, then Amazon RDS will
|
14621
|
-
# default encryption key. AWS KMS creates the default
|
14622
|
-
# for your AWS account. Your AWS account has a
|
14623
|
-
# encryption key for each AWS Region.
|
14683
|
+
# If the `StorageEncrypted` parameter is enabled, and you do not
|
14684
|
+
# specify a value for the `KmsKeyId` parameter, then Amazon RDS will
|
14685
|
+
# use your default encryption key. AWS KMS creates the default
|
14686
|
+
# encryption key for your AWS account. Your AWS account has a
|
14687
|
+
# different default encryption key for each AWS Region.
|
14624
14688
|
# @return [String]
|
14625
14689
|
#
|
14626
14690
|
# @!attribute [rw] copy_tags_to_snapshot
|
14627
|
-
#
|
14628
|
-
# the
|
14629
|
-
#
|
14630
|
-
# Default: false.
|
14691
|
+
# A value that indicates whether to copy all tags from the DB instance
|
14692
|
+
# to snapshots of the DB instance. By default, tags are not copied.
|
14631
14693
|
# @return [Boolean]
|
14632
14694
|
#
|
14633
14695
|
# @!attribute [rw] monitoring_interval
|
@@ -14659,10 +14721,9 @@ module Aws::RDS
|
|
14659
14721
|
# @return [String]
|
14660
14722
|
#
|
14661
14723
|
# @!attribute [rw] enable_iam_database_authentication
|
14662
|
-
#
|
14663
|
-
# accounts to database accounts
|
14664
|
-
#
|
14665
|
-
# Default: `false`
|
14724
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
14725
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
14726
|
+
# mapping is disabled.
|
14666
14727
|
# @return [Boolean]
|
14667
14728
|
#
|
14668
14729
|
# @!attribute [rw] source_engine
|
@@ -14692,8 +14753,8 @@ module Aws::RDS
|
|
14692
14753
|
# @return [String]
|
14693
14754
|
#
|
14694
14755
|
# @!attribute [rw] enable_performance_insights
|
14695
|
-
#
|
14696
|
-
#
|
14756
|
+
# A value that indicates whether to enable Performance Insights for
|
14757
|
+
# the DB instance.
|
14697
14758
|
#
|
14698
14759
|
# For more information, see [Using Amazon Performance Insights][1] in
|
14699
14760
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -14707,6 +14768,11 @@ module Aws::RDS
|
|
14707
14768
|
# The AWS KMS key identifier for encryption of Performance Insights
|
14708
14769
|
# data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key
|
14709
14770
|
# identifier, or the KMS key alias for the KMS encryption key.
|
14771
|
+
#
|
14772
|
+
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
14773
|
+
# then Amazon RDS uses your default encryption key. AWS KMS creates
|
14774
|
+
# the default encryption key for your AWS account. Your AWS account
|
14775
|
+
# has a different default encryption key for each AWS Region.
|
14710
14776
|
# @return [String]
|
14711
14777
|
#
|
14712
14778
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -14731,15 +14797,15 @@ module Aws::RDS
|
|
14731
14797
|
# @return [Array<Types::ProcessorFeature>]
|
14732
14798
|
#
|
14733
14799
|
# @!attribute [rw] use_default_processor_features
|
14734
|
-
# A value that
|
14735
|
-
# uses its default processor features.
|
14800
|
+
# A value that indicates whether the DB instance class of the DB
|
14801
|
+
# instance uses its default processor features.
|
14736
14802
|
# @return [Boolean]
|
14737
14803
|
#
|
14738
14804
|
# @!attribute [rw] deletion_protection
|
14739
|
-
#
|
14740
|
-
# enabled. The database can't be deleted when
|
14741
|
-
#
|
14742
|
-
# DB Instance][1].
|
14805
|
+
# A value that indicates whether the DB instance has deletion
|
14806
|
+
# protection enabled. The database can't be deleted when deletion
|
14807
|
+
# protection is enabled. By default, deletion protection is disabled.
|
14808
|
+
# For more information, see [ Deleting a DB Instance][1].
|
14743
14809
|
#
|
14744
14810
|
#
|
14745
14811
|
#
|
@@ -14799,7 +14865,7 @@ module Aws::RDS
|
|
14799
14865
|
# Contains the details of an Amazon RDS DB instance.
|
14800
14866
|
#
|
14801
14867
|
# This data type is used as a response element in the
|
14802
|
-
# DescribeDBInstances action.
|
14868
|
+
# `DescribeDBInstances` action.
|
14803
14869
|
# @return [Types::DBInstance]
|
14804
14870
|
#
|
14805
14871
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3Result AWS API Documentation
|
@@ -14888,18 +14954,18 @@ module Aws::RDS
|
|
14888
14954
|
#
|
14889
14955
|
# * Must be before the latest restorable time for the DB instance
|
14890
14956
|
#
|
14891
|
-
# * Can't be specified if UseLatestRestorableTime parameter is
|
14957
|
+
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
14958
|
+
# enabled
|
14892
14959
|
#
|
14893
14960
|
# Example: `2009-09-07T23:45:00Z`
|
14894
14961
|
# @return [Time]
|
14895
14962
|
#
|
14896
14963
|
# @!attribute [rw] use_latest_restorable_time
|
14897
|
-
#
|
14898
|
-
#
|
14964
|
+
# A value that indicates whether the DB instance is restored from the
|
14965
|
+
# latest backup time. By default, the DB instance is not restored from
|
14966
|
+
# the latest backup time.
|
14899
14967
|
#
|
14900
|
-
#
|
14901
|
-
#
|
14902
|
-
# Constraints: Can't be specified if RestoreTime parameter is
|
14968
|
+
# Constraints: Can't be specified if the `RestoreTime` parameter is
|
14903
14969
|
# provided.
|
14904
14970
|
# @return [Boolean]
|
14905
14971
|
#
|
@@ -14926,12 +14992,12 @@ module Aws::RDS
|
|
14926
14992
|
# @return [Integer]
|
14927
14993
|
#
|
14928
14994
|
# @!attribute [rw] availability_zone
|
14929
|
-
# The
|
14995
|
+
# The Availability Zone (AZ) where the DB instance will be created.
|
14930
14996
|
#
|
14931
14997
|
# Default: A random, system-chosen Availability Zone.
|
14932
14998
|
#
|
14933
|
-
# Constraint: You can't specify the AvailabilityZone parameter if
|
14934
|
-
#
|
14999
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if
|
15000
|
+
# the DB instance is a Multi-AZ deployment.
|
14935
15001
|
#
|
14936
15002
|
# Example: `us-east-1a`
|
14937
15003
|
# @return [String]
|
@@ -14946,24 +15012,26 @@ module Aws::RDS
|
|
14946
15012
|
# @return [String]
|
14947
15013
|
#
|
14948
15014
|
# @!attribute [rw] multi_az
|
14949
|
-
#
|
15015
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
15016
|
+
# deployment.
|
14950
15017
|
#
|
14951
|
-
# Constraint: You can't specify the AvailabilityZone parameter if
|
14952
|
-
#
|
15018
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if
|
15019
|
+
# the DB instance is a Multi-AZ deployment.
|
14953
15020
|
# @return [Boolean]
|
14954
15021
|
#
|
14955
15022
|
# @!attribute [rw] publicly_accessible
|
14956
|
-
#
|
14957
|
-
#
|
14958
|
-
#
|
14959
|
-
#
|
15023
|
+
# A value that indicates whether the DB instance is publicly
|
15024
|
+
# accessible. When the DB instance is publicly accessible, it is an
|
15025
|
+
# Internet-facing instance with a publicly resolvable DNS name, which
|
15026
|
+
# resolves to a public IP address. When the DB instance is not
|
15027
|
+
# publicly accessible, it is an internal instance with a DNS name that
|
14960
15028
|
# resolves to a private IP address. For more information, see
|
14961
15029
|
# CreateDBInstance.
|
14962
15030
|
# @return [Boolean]
|
14963
15031
|
#
|
14964
15032
|
# @!attribute [rw] auto_minor_version_upgrade
|
14965
|
-
#
|
14966
|
-
# the DB instance during the maintenance window.
|
15033
|
+
# A value that indicates whether minor version upgrades are applied
|
15034
|
+
# automatically to the DB instance during the maintenance window.
|
14967
15035
|
# @return [Boolean]
|
14968
15036
|
#
|
14969
15037
|
# @!attribute [rw] license_model
|
@@ -15038,8 +15106,9 @@ module Aws::RDS
|
|
15038
15106
|
# @return [String]
|
15039
15107
|
#
|
15040
15108
|
# @!attribute [rw] copy_tags_to_snapshot
|
15041
|
-
#
|
15042
|
-
#
|
15109
|
+
# A value that indicates whether to copy all tags from the restored DB
|
15110
|
+
# instance to snapshots of the DB instance. By default, tags are not
|
15111
|
+
# copied.
|
15043
15112
|
# @return [Boolean]
|
15044
15113
|
#
|
15045
15114
|
# @!attribute [rw] tags
|
@@ -15059,8 +15128,7 @@ module Aws::RDS
|
|
15059
15128
|
# If you specify `io1`, you must also include a value for the `Iops`
|
15060
15129
|
# parameter.
|
15061
15130
|
#
|
15062
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
15063
|
-
# `standard`
|
15131
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
15064
15132
|
# @return [String]
|
15065
15133
|
#
|
15066
15134
|
# @!attribute [rw] tde_credential_arn
|
@@ -15091,8 +15159,9 @@ module Aws::RDS
|
|
15091
15159
|
# @return [String]
|
15092
15160
|
#
|
15093
15161
|
# @!attribute [rw] enable_iam_database_authentication
|
15094
|
-
#
|
15095
|
-
# accounts to database accounts
|
15162
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
15163
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
15164
|
+
# mapping is disabled.
|
15096
15165
|
#
|
15097
15166
|
# You can enable IAM database authentication for the following
|
15098
15167
|
# database engines
|
@@ -15100,8 +15169,6 @@ module Aws::RDS
|
|
15100
15169
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
15101
15170
|
#
|
15102
15171
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
15103
|
-
#
|
15104
|
-
# Default: `false`
|
15105
15172
|
# @return [Boolean]
|
15106
15173
|
#
|
15107
15174
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
@@ -15121,8 +15188,8 @@ module Aws::RDS
|
|
15121
15188
|
# @return [Array<Types::ProcessorFeature>]
|
15122
15189
|
#
|
15123
15190
|
# @!attribute [rw] use_default_processor_features
|
15124
|
-
# A value that
|
15125
|
-
# uses its default processor features.
|
15191
|
+
# A value that indicates whether the DB instance class of the DB
|
15192
|
+
# instance uses its default processor features.
|
15126
15193
|
# @return [Boolean]
|
15127
15194
|
#
|
15128
15195
|
# @!attribute [rw] db_parameter_group_name
|
@@ -15142,10 +15209,10 @@ module Aws::RDS
|
|
15142
15209
|
# @return [String]
|
15143
15210
|
#
|
15144
15211
|
# @!attribute [rw] deletion_protection
|
15145
|
-
#
|
15146
|
-
# enabled. The database can't be deleted when
|
15147
|
-
#
|
15148
|
-
# DB Instance][1].
|
15212
|
+
# A value that indicates whether the DB instance has deletion
|
15213
|
+
# protection enabled. The database can't be deleted when deletion
|
15214
|
+
# protection is enabled. By default, deletion protection is disabled.
|
15215
|
+
# For more information, see [ Deleting a DB Instance][1].
|
15149
15216
|
#
|
15150
15217
|
#
|
15151
15218
|
#
|
@@ -15197,7 +15264,7 @@ module Aws::RDS
|
|
15197
15264
|
# Contains the details of an Amazon RDS DB instance.
|
15198
15265
|
#
|
15199
15266
|
# This data type is used as a response element in the
|
15200
|
-
# DescribeDBInstances action.
|
15267
|
+
# `DescribeDBInstances` action.
|
15201
15268
|
# @return [Types::DBInstance]
|
15202
15269
|
#
|
15203
15270
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTimeResult AWS API Documentation
|
@@ -15284,7 +15351,7 @@ module Aws::RDS
|
|
15284
15351
|
# Contains the details for an Amazon RDS DB security group.
|
15285
15352
|
#
|
15286
15353
|
# This data type is used as a response element in the
|
15287
|
-
# DescribeDBSecurityGroups action.
|
15354
|
+
# `DescribeDBSecurityGroups` action.
|
15288
15355
|
# @return [Types::DBSecurityGroup]
|
15289
15356
|
#
|
15290
15357
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RevokeDBSecurityGroupIngressResult AWS API Documentation
|
@@ -15318,8 +15385,8 @@ module Aws::RDS
|
|
15318
15385
|
# The minimum capacity for an Aurora DB cluster in `serverless` DB
|
15319
15386
|
# engine mode.
|
15320
15387
|
#
|
15321
|
-
# Valid capacity values are `2`, `4`, `8`, `16`, `32`, `64`,
|
15322
|
-
# and `256`.
|
15388
|
+
# Valid capacity values are `1`, `2`, `4`, `8`, `16`, `32`, `64`,
|
15389
|
+
# `128`, and `256`.
|
15323
15390
|
#
|
15324
15391
|
# The minimum capacity must be less than or equal to the maximum
|
15325
15392
|
# capacity.
|
@@ -15329,15 +15396,15 @@ module Aws::RDS
|
|
15329
15396
|
# The maximum capacity for an Aurora DB cluster in `serverless` DB
|
15330
15397
|
# engine mode.
|
15331
15398
|
#
|
15332
|
-
# Valid capacity values are `2`, `4`, `8`, `16`, `32`, `64`,
|
15333
|
-
# and `256`.
|
15399
|
+
# Valid capacity values are `1`, `2`, `4`, `8`, `16`, `32`, `64`,
|
15400
|
+
# `128`, and `256`.
|
15334
15401
|
#
|
15335
15402
|
# The maximum capacity must be greater than or equal to the minimum
|
15336
15403
|
# capacity.
|
15337
15404
|
# @return [Integer]
|
15338
15405
|
#
|
15339
15406
|
# @!attribute [rw] auto_pause
|
15340
|
-
# A value that
|
15407
|
+
# A value that indicates whether to allow or disallow automatic pause
|
15341
15408
|
# for an Aurora DB cluster in `serverless` DB engine mode. A DB
|
15342
15409
|
# cluster can be paused only when it's idle (it has no connections).
|
15343
15410
|
#
|
@@ -15357,11 +15424,14 @@ module Aws::RDS
|
|
15357
15424
|
# The action to take when the timeout is reached, either
|
15358
15425
|
# `ForceApplyCapacityChange` or `RollbackCapacityChange`.
|
15359
15426
|
#
|
15360
|
-
# `ForceApplyCapacityChange
|
15361
|
-
#
|
15427
|
+
# `ForceApplyCapacityChange` sets the capacity to the specified value
|
15428
|
+
# as soon as possible.
|
15362
15429
|
#
|
15363
|
-
# `RollbackCapacityChange
|
15364
|
-
# point is not found in the timeout period.
|
15430
|
+
# `RollbackCapacityChange`, the default, ignores the capacity change
|
15431
|
+
# if a scaling point is not found in the timeout period.
|
15432
|
+
#
|
15433
|
+
# If you specify `ForceApplyCapacityChange`, connections that prevent
|
15434
|
+
# Aurora Serverless from finding a scaling point might be dropped.
|
15365
15435
|
#
|
15366
15436
|
# For more information, see [ Autoscaling for Aurora Serverless][1] in
|
15367
15437
|
# the *Amazon Aurora User Guide*.
|
@@ -15433,7 +15503,7 @@ module Aws::RDS
|
|
15433
15503
|
end
|
15434
15504
|
|
15435
15505
|
# Contains an AWS Region name as the result of a successful call to the
|
15436
|
-
# DescribeSourceRegions action.
|
15506
|
+
# `DescribeSourceRegions` action.
|
15437
15507
|
#
|
15438
15508
|
# @!attribute [rw] region_name
|
15439
15509
|
# The name of the source AWS Region.
|
@@ -15457,7 +15527,7 @@ module Aws::RDS
|
|
15457
15527
|
end
|
15458
15528
|
|
15459
15529
|
# Contains the result of a successful invocation of the
|
15460
|
-
# DescribeSourceRegions action.
|
15530
|
+
# `DescribeSourceRegions` action.
|
15461
15531
|
#
|
15462
15532
|
# @!attribute [rw] marker
|
15463
15533
|
# An optional pagination token provided by a previous request. If this
|
@@ -15502,7 +15572,7 @@ module Aws::RDS
|
|
15502
15572
|
# Contains the details of an Amazon Aurora DB cluster.
|
15503
15573
|
#
|
15504
15574
|
# This data type is used as a response element in the
|
15505
|
-
# DescribeDBClusters
|
15575
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
15506
15576
|
# @return [Types::DBCluster]
|
15507
15577
|
#
|
15508
15578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBClusterResult AWS API Documentation
|
@@ -15534,7 +15604,7 @@ module Aws::RDS
|
|
15534
15604
|
# Contains the details of an Amazon RDS DB instance.
|
15535
15605
|
#
|
15536
15606
|
# This data type is used as a response element in the
|
15537
|
-
# DescribeDBInstances action.
|
15607
|
+
# `DescribeDBInstances` action.
|
15538
15608
|
# @return [Types::DBInstance]
|
15539
15609
|
#
|
15540
15610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstanceResult AWS API Documentation
|
@@ -15567,7 +15637,7 @@ module Aws::RDS
|
|
15567
15637
|
# Contains the details of an Amazon Aurora DB cluster.
|
15568
15638
|
#
|
15569
15639
|
# This data type is used as a response element in the
|
15570
|
-
# DescribeDBClusters
|
15640
|
+
# `DescribeDBClusters`, `StopDBCluster`, and `StartDBCluster` actions.
|
15571
15641
|
# @return [Types::DBCluster]
|
15572
15642
|
#
|
15573
15643
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBClusterResult AWS API Documentation
|
@@ -15606,7 +15676,7 @@ module Aws::RDS
|
|
15606
15676
|
# Contains the details of an Amazon RDS DB instance.
|
15607
15677
|
#
|
15608
15678
|
# This data type is used as a response element in the
|
15609
|
-
# DescribeDBInstances action.
|
15679
|
+
# `DescribeDBInstances` action.
|
15610
15680
|
# @return [Types::DBInstance]
|
15611
15681
|
#
|
15612
15682
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstanceResult AWS API Documentation
|
@@ -15617,7 +15687,7 @@ module Aws::RDS
|
|
15617
15687
|
end
|
15618
15688
|
|
15619
15689
|
# This data type is used as a response element in the
|
15620
|
-
# DescribeDBSubnetGroups action.
|
15690
|
+
# `DescribeDBSubnetGroups` action.
|
15621
15691
|
#
|
15622
15692
|
# @!attribute [rw] subnet_identifier
|
15623
15693
|
# Specifies the identifier of the subnet.
|
@@ -15626,11 +15696,8 @@ module Aws::RDS
|
|
15626
15696
|
# @!attribute [rw] subnet_availability_zone
|
15627
15697
|
# Contains Availability Zone information.
|
15628
15698
|
#
|
15629
|
-
# This data type is used as an element in the
|
15630
|
-
#
|
15631
|
-
# * OrderableDBInstanceOption
|
15632
|
-
#
|
15633
|
-
# ^
|
15699
|
+
# This data type is used as an element in the
|
15700
|
+
# `OrderableDBInstanceOption` data type.
|
15634
15701
|
# @return [Types::AvailabilityZone]
|
15635
15702
|
#
|
15636
15703
|
# @!attribute [rw] subnet_status
|
@@ -15694,9 +15761,9 @@ module Aws::RDS
|
|
15694
15761
|
include Aws::Structure
|
15695
15762
|
end
|
15696
15763
|
|
15697
|
-
# A time zone associated with a DBInstance or a DBSnapshot
|
15698
|
-
# type is an element in the response to the DescribeDBInstances
|
15699
|
-
# DescribeDBSnapshots
|
15764
|
+
# A time zone associated with a `DBInstance` or a `DBSnapshot`. This
|
15765
|
+
# data type is an element in the response to the `DescribeDBInstances`,
|
15766
|
+
# the `DescribeDBSnapshots`, and the `DescribeDBEngineVersions` actions.
|
15700
15767
|
#
|
15701
15768
|
# @!attribute [rw] timezone_name
|
15702
15769
|
# The name of the time zone.
|
@@ -15727,7 +15794,7 @@ module Aws::RDS
|
|
15727
15794
|
#
|
15728
15795
|
# @!attribute [rw] auto_upgrade
|
15729
15796
|
# A value that indicates whether the target version is applied to any
|
15730
|
-
# source DB instances that have AutoMinorVersionUpgrade set to true.
|
15797
|
+
# source DB instances that have `AutoMinorVersionUpgrade` set to true.
|
15731
15798
|
# @return [Boolean]
|
15732
15799
|
#
|
15733
15800
|
# @!attribute [rw] is_major_version_upgrade
|
@@ -15748,8 +15815,8 @@ module Aws::RDS
|
|
15748
15815
|
|
15749
15816
|
# Information about valid modifications that you can make to your DB
|
15750
15817
|
# instance. Contains the result of a successful call to the
|
15751
|
-
# DescribeValidDBInstanceModifications action. You can use this
|
15752
|
-
# information when you call ModifyDBInstance
|
15818
|
+
# `DescribeValidDBInstanceModifications` action. You can use this
|
15819
|
+
# information when you call `ModifyDBInstance`.
|
15753
15820
|
#
|
15754
15821
|
# @!attribute [rw] storage
|
15755
15822
|
# Valid storage options for your DB instance.
|
@@ -15769,7 +15836,7 @@ module Aws::RDS
|
|
15769
15836
|
|
15770
15837
|
# Information about valid modifications that you can make to your DB
|
15771
15838
|
# instance. Contains the result of a successful call to the
|
15772
|
-
# DescribeValidDBInstanceModifications action.
|
15839
|
+
# `DescribeValidDBInstanceModifications` action.
|
15773
15840
|
#
|
15774
15841
|
# @!attribute [rw] storage_type
|
15775
15842
|
# The valid storage types for your DB instance. For example, gp2, io1.
|