@aws-sdk/client-rds 3.40.0 → 3.45.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +44 -0
- package/dist-cjs/RDS.js +15 -0
- package/dist-cjs/commands/RebootDBClusterCommand.js +36 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoints.js +10 -1
- package/dist-cjs/models/models_1.js +14 -2
- package/dist-cjs/protocols/Aws_query.js +248 -4
- package/dist-es/RDS.js +15 -0
- package/dist-es/commands/RebootDBClusterCommand.js +39 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoints.js +10 -1
- package/dist-es/models/models_1.js +8 -0
- package/dist-es/protocols/Aws_query.js +250 -0
- package/dist-types/RDS.d.ts +199 -118
- package/dist-types/RDSClient.d.ts +3 -2
- package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +2 -7
- package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +1 -1
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +1 -1
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +2 -2
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/CancelExportTaskCommand.d.ts +1 -1
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +1 -4
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +12 -8
- package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/CopyOptionGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomAvailabilityZoneCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +6 -10
- package/dist-types/commands/CreateDBClusterCommand.d.ts +12 -9
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +4 -4
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +12 -6
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +9 -5
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBProxyCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/CreateOptionGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCustomAvailabilityZoneCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +7 -4
- package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +7 -3
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +7 -3
- package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBProxyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/DeleteInstallationMediaCommand.d.ts +1 -1
- package/dist-types/commands/DeleteOptionGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeCustomAvailabilityZonesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +7 -3
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +7 -3
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +1 -4
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +8 -4
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +10 -5
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBProxiesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +2 -2
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +2 -2
- package/dist-types/commands/DescribeInstallationMediaCommand.d.ts +1 -1
- package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +2 -2
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +1 -1
- package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +1 -1
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +17 -9
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/ImportInstallationMediaCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ModifyCertificatesCommand.d.ts +1 -1
- package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +1 -1
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +2 -2
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +12 -8
- package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +10 -6
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +1 -4
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBProxyCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +2 -2
- package/dist-types/commands/ModifyOptionGroupCommand.d.ts +1 -1
- package/dist-types/commands/PromoteReadReplicaCommand.d.ts +1 -1
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +1 -4
- package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +1 -1
- package/dist-types/commands/RebootDBClusterCommand.d.ts +52 -0
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +1 -1
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +2 -2
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +12 -5
- package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +1 -1
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +8 -5
- package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +2 -2
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +9 -6
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +9 -5
- package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +1 -1
- package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +1 -1
- package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +1 -1
- package/dist-types/commands/StartActivityStreamCommand.d.ts +1 -1
- package/dist-types/commands/StartDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -1
- package/dist-types/commands/StartDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/StartExportTaskCommand.d.ts +1 -1
- package/dist-types/commands/StopActivityStreamCommand.d.ts +1 -1
- package/dist-types/commands/StopDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -1
- package/dist-types/commands/StopDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +477 -170
- package/dist-types/models/models_1.d.ts +670 -122
- package/dist-types/protocols/Aws_query.d.ts +3 -0
- package/dist-types/ts3.4/RDS.d.ts +5 -0
- package/dist-types/ts3.4/RDSClient.d.ts +3 -2
- package/dist-types/ts3.4/commands/RebootDBClusterCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +50 -0
- package/dist-types/ts3.4/models/models_1.d.ts +58 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +3 -0
- package/package.json +7 -7
|
@@ -989,6 +989,11 @@ export interface DescribeExportTasksMessage {
|
|
|
989
989
|
* </li>
|
|
990
990
|
* <li>
|
|
991
991
|
* <p>
|
|
992
|
+
* <code>in_progress</code>
|
|
993
|
+
* </p>
|
|
994
|
+
* </li>
|
|
995
|
+
* <li>
|
|
996
|
+
* <p>
|
|
992
997
|
* <code>starting</code>
|
|
993
998
|
* </p>
|
|
994
999
|
* </li>
|
|
@@ -1875,6 +1880,15 @@ export interface OrderableDBInstanceOption {
|
|
|
1875
1880
|
* <p>A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.</p>
|
|
1876
1881
|
*/
|
|
1877
1882
|
SupportsGlobalDatabases?: boolean;
|
|
1883
|
+
/**
|
|
1884
|
+
* <p>Whether DB instances can be configured as a Multi-AZ DB cluster.</p>
|
|
1885
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1886
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1887
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1888
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
1889
|
+
* </p>
|
|
1890
|
+
*/
|
|
1891
|
+
SupportsClusters?: boolean;
|
|
1878
1892
|
}
|
|
1879
1893
|
export declare namespace OrderableDBInstanceOption {
|
|
1880
1894
|
/**
|
|
@@ -2718,9 +2732,10 @@ export interface FailoverDBClusterMessage {
|
|
|
2718
2732
|
*/
|
|
2719
2733
|
DBClusterIdentifier: string | undefined;
|
|
2720
2734
|
/**
|
|
2721
|
-
* <p>The name of the instance to promote to the primary instance.</p>
|
|
2722
|
-
* <p>
|
|
2723
|
-
*
|
|
2735
|
+
* <p>The name of the DB instance to promote to the primary DB instance.</p>
|
|
2736
|
+
* <p>Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,
|
|
2737
|
+
* for example <code>mydbcluster-replica1</code>.</p>
|
|
2738
|
+
* <p>This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.</p>
|
|
2724
2739
|
*/
|
|
2725
2740
|
TargetDBInstanceIdentifier?: string;
|
|
2726
2741
|
}
|
|
@@ -2732,11 +2747,28 @@ export declare namespace FailoverDBClusterMessage {
|
|
|
2732
2747
|
}
|
|
2733
2748
|
export interface FailoverDBClusterResult {
|
|
2734
2749
|
/**
|
|
2735
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
2736
|
-
* </p>
|
|
2737
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
2738
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
2750
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
2739
2751
|
* </p>
|
|
2752
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
2753
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
2754
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
2755
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
2756
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
2757
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
2758
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
2759
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
2760
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
2761
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
2762
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
2763
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
2764
|
+
* </p>
|
|
2765
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
2766
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
2767
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
2768
|
+
* </p>
|
|
2769
|
+
* <note>
|
|
2770
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
2771
|
+
* </note>
|
|
2740
2772
|
*/
|
|
2741
2773
|
DBCluster?: DBCluster;
|
|
2742
2774
|
}
|
|
@@ -3119,6 +3151,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3119
3151
|
* <p>The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.</p>
|
|
3120
3152
|
* <p>Constraints: This identifier must match the identifier of an existing DB
|
|
3121
3153
|
* cluster.</p>
|
|
3154
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3122
3155
|
*/
|
|
3123
3156
|
DBClusterIdentifier: string | undefined;
|
|
3124
3157
|
/**
|
|
@@ -3137,6 +3170,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3137
3170
|
* </ul>
|
|
3138
3171
|
* <p>Example: <code>my-cluster2</code>
|
|
3139
3172
|
* </p>
|
|
3173
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3140
3174
|
*/
|
|
3141
3175
|
NewDBClusterIdentifier?: string;
|
|
3142
3176
|
/**
|
|
@@ -3152,10 +3186,11 @@ export interface ModifyDBClusterMessage {
|
|
|
3152
3186
|
* and <code>NewDBClusterIdentifier</code> values are applied during the next maintenance window. All other changes are
|
|
3153
3187
|
* applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p>
|
|
3154
3188
|
* <p>By default, this parameter is disabled.</p>
|
|
3189
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3155
3190
|
*/
|
|
3156
3191
|
ApplyImmediately?: boolean;
|
|
3157
3192
|
/**
|
|
3158
|
-
* <p>The number of days for which automated backups are retained.
|
|
3193
|
+
* <p>The number of days for which automated backups are retained. Specify a minimum value of 1.</p>
|
|
3159
3194
|
* <p>Default: 1</p>
|
|
3160
3195
|
* <p>Constraints:</p>
|
|
3161
3196
|
* <ul>
|
|
@@ -3163,14 +3198,17 @@ export interface ModifyDBClusterMessage {
|
|
|
3163
3198
|
* <p>Must be a value from 1 to 35</p>
|
|
3164
3199
|
* </li>
|
|
3165
3200
|
* </ul>
|
|
3201
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3166
3202
|
*/
|
|
3167
3203
|
BackupRetentionPeriod?: number;
|
|
3168
3204
|
/**
|
|
3169
3205
|
* <p>The name of the DB cluster parameter group to use for the DB cluster.</p>
|
|
3206
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3170
3207
|
*/
|
|
3171
3208
|
DBClusterParameterGroupName?: string;
|
|
3172
3209
|
/**
|
|
3173
3210
|
* <p>A list of VPC security groups that the DB cluster will belong to.</p>
|
|
3211
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3174
3212
|
*/
|
|
3175
3213
|
VpcSecurityGroupIds?: string[];
|
|
3176
3214
|
/**
|
|
@@ -3178,22 +3216,18 @@ export interface ModifyDBClusterMessage {
|
|
|
3178
3216
|
* <p>Constraints: Value must be <code>1150-65535</code>
|
|
3179
3217
|
* </p>
|
|
3180
3218
|
* <p>Default: The same port as the original DB cluster.</p>
|
|
3219
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3181
3220
|
*/
|
|
3182
3221
|
Port?: number;
|
|
3183
3222
|
/**
|
|
3184
3223
|
* <p>The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".</p>
|
|
3185
3224
|
* <p>Constraints: Must contain from 8 to 41 characters.</p>
|
|
3225
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3186
3226
|
*/
|
|
3187
3227
|
MasterUserPassword?: string;
|
|
3188
3228
|
/**
|
|
3189
|
-
* <p>A value that indicates that the DB cluster should be associated with the specified option group
|
|
3190
|
-
*
|
|
3191
|
-
* is applied during the next maintenance window
|
|
3192
|
-
* unless the <code>ApplyImmediately</code> is enabled for this request. If the parameter change results in an option group that
|
|
3193
|
-
* enables OEM, this change can cause a brief (sub-second) period during which new connections
|
|
3194
|
-
* are rejected but existing connections are not interrupted.
|
|
3195
|
-
* </p>
|
|
3196
|
-
* <p>Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.</p>
|
|
3229
|
+
* <p>A value that indicates that the DB cluster should be associated with the specified option group.</p>
|
|
3230
|
+
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
3197
3231
|
*/
|
|
3198
3232
|
OptionGroupName?: string;
|
|
3199
3233
|
/**
|
|
@@ -3222,6 +3256,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3222
3256
|
* <p>Must be at least 30 minutes.</p>
|
|
3223
3257
|
* </li>
|
|
3224
3258
|
* </ul>
|
|
3259
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3225
3260
|
*/
|
|
3226
3261
|
PreferredBackupWindow?: string;
|
|
3227
3262
|
/**
|
|
@@ -3236,24 +3271,23 @@ export interface ModifyDBClusterMessage {
|
|
|
3236
3271
|
* </p>
|
|
3237
3272
|
* <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p>
|
|
3238
3273
|
* <p>Constraints: Minimum 30-minute window.</p>
|
|
3274
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3239
3275
|
*/
|
|
3240
3276
|
PreferredMaintenanceWindow?: string;
|
|
3241
3277
|
/**
|
|
3242
3278
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
3243
|
-
* Management (IAM) accounts to database accounts. By default, mapping
|
|
3244
|
-
*
|
|
3279
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
3280
|
+
* enabled.</p>
|
|
3245
3281
|
* <p>For more information, see
|
|
3246
3282
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
3247
3283
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>
|
|
3248
3284
|
* </p>
|
|
3285
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3249
3286
|
*/
|
|
3250
3287
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
3251
3288
|
/**
|
|
3252
3289
|
* <p>The target backtrack window, in seconds. To disable backtracking, set this value to
|
|
3253
3290
|
* 0.</p>
|
|
3254
|
-
* <note>
|
|
3255
|
-
* <p>Currently, Backtrack is only supported for Aurora MySQL DB clusters.</p>
|
|
3256
|
-
* </note>
|
|
3257
3291
|
* <p>Default: 0</p>
|
|
3258
3292
|
* <p>Constraints:</p>
|
|
3259
3293
|
* <ul>
|
|
@@ -3261,28 +3295,39 @@ export interface ModifyDBClusterMessage {
|
|
|
3261
3295
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
3262
3296
|
* </li>
|
|
3263
3297
|
* </ul>
|
|
3298
|
+
* <p>Valid for: Aurora MySQL DB clusters only</p>
|
|
3264
3299
|
*/
|
|
3265
3300
|
BacktrackWindow?: number;
|
|
3266
3301
|
/**
|
|
3267
3302
|
* <p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.</p>
|
|
3303
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3268
3304
|
*/
|
|
3269
3305
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
|
3270
3306
|
/**
|
|
3271
3307
|
* <p>The version number of the database engine to which you want to upgrade.
|
|
3272
3308
|
* Changing this parameter results in an outage. The change is applied during
|
|
3273
3309
|
* the next maintenance window unless <code>ApplyImmediately</code> is enabled.</p>
|
|
3274
|
-
* <p>To list all of the available engine versions for
|
|
3310
|
+
* <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p>
|
|
3275
3311
|
* <p>
|
|
3276
3312
|
* <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
|
|
3277
3313
|
* </p>
|
|
3278
|
-
* <p>To list all of the available engine versions for
|
|
3314
|
+
* <p>To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:</p>
|
|
3279
3315
|
* <p>
|
|
3280
3316
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
3281
3317
|
* </p>
|
|
3282
|
-
* <p>To list all of the available engine versions for
|
|
3318
|
+
* <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p>
|
|
3283
3319
|
* <p>
|
|
3284
3320
|
* <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"</code>
|
|
3285
3321
|
* </p>
|
|
3322
|
+
* <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p>
|
|
3323
|
+
* <p>
|
|
3324
|
+
* <code>aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
3325
|
+
* </p>
|
|
3326
|
+
* <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p>
|
|
3327
|
+
* <p>
|
|
3328
|
+
* <code>aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"</code>
|
|
3329
|
+
* </p>
|
|
3330
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3286
3331
|
*/
|
|
3287
3332
|
EngineVersion?: string;
|
|
3288
3333
|
/**
|
|
@@ -3290,6 +3335,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3290
3335
|
* <p>Constraints: You must allow major version upgrades when specifying a value for the
|
|
3291
3336
|
* <code>EngineVersion</code> parameter that is a different major version than the DB
|
|
3292
3337
|
* cluster's current version.</p>
|
|
3338
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3293
3339
|
*/
|
|
3294
3340
|
AllowMajorVersionUpgrade?: boolean;
|
|
3295
3341
|
/**
|
|
@@ -3310,6 +3356,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3310
3356
|
* the <code>AllowMajorVersionUpgrade</code> parameter.</p>
|
|
3311
3357
|
* </li>
|
|
3312
3358
|
* </ul>
|
|
3359
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3313
3360
|
*/
|
|
3314
3361
|
DBInstanceParameterGroupName?: string;
|
|
3315
3362
|
/**
|
|
@@ -3320,21 +3367,24 @@ export interface ModifyDBClusterMessage {
|
|
|
3320
3367
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html">Kerberos Authentication</a>
|
|
3321
3368
|
* in the <i>Amazon Aurora User Guide</i>.
|
|
3322
3369
|
* </p>
|
|
3370
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3323
3371
|
*/
|
|
3324
3372
|
Domain?: string;
|
|
3325
3373
|
/**
|
|
3326
3374
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
3375
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3327
3376
|
*/
|
|
3328
3377
|
DomainIAMRoleName?: string;
|
|
3329
3378
|
/**
|
|
3330
3379
|
* <p>The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in <code>serverless</code> DB engine mode.</p>
|
|
3380
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3331
3381
|
*/
|
|
3332
3382
|
ScalingConfiguration?: ScalingConfiguration;
|
|
3333
3383
|
/**
|
|
3334
3384
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
3335
3385
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
3336
|
-
* deletion protection
|
|
3337
|
-
* </p>
|
|
3386
|
+
* deletion protection isn't enabled.</p>
|
|
3387
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3338
3388
|
*/
|
|
3339
3389
|
DeletionProtection?: boolean;
|
|
3340
3390
|
/**
|
|
@@ -3345,11 +3395,13 @@ export interface ModifyDBClusterMessage {
|
|
|
3345
3395
|
* from inside the RDS console with the query editor.</p>
|
|
3346
3396
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using the Data API for Aurora Serverless</a> in the
|
|
3347
3397
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
3398
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3348
3399
|
*/
|
|
3349
3400
|
EnableHttpEndpoint?: boolean;
|
|
3350
3401
|
/**
|
|
3351
3402
|
* <p>A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
|
3352
3403
|
* The default is not to copy them.</p>
|
|
3404
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3353
3405
|
*/
|
|
3354
3406
|
CopyTagsToSnapshot?: boolean;
|
|
3355
3407
|
/**
|
|
@@ -3361,8 +3413,96 @@ export interface ModifyDBClusterMessage {
|
|
|
3361
3413
|
* this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is
|
|
3362
3414
|
* demoted by the <a>FailoverGlobalCluster</a> API operation, but it does nothing until then.
|
|
3363
3415
|
* </p>
|
|
3416
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3364
3417
|
*/
|
|
3365
3418
|
EnableGlobalWriteForwarding?: boolean;
|
|
3419
|
+
/**
|
|
3420
|
+
* <p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
|
3421
|
+
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p>
|
|
3422
|
+
* <p>For the full list of DB instance classes and availability for your engine, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i>
|
|
3423
|
+
* </p>
|
|
3424
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3425
|
+
*/
|
|
3426
|
+
DBClusterInstanceClass?: string;
|
|
3427
|
+
/**
|
|
3428
|
+
* <p>The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.</p>
|
|
3429
|
+
* <p>Type: Integer</p>
|
|
3430
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3431
|
+
*/
|
|
3432
|
+
AllocatedStorage?: number;
|
|
3433
|
+
/**
|
|
3434
|
+
* <p>Specifies the storage type to be associated with the DB cluster.</p>
|
|
3435
|
+
* <p>
|
|
3436
|
+
* Valid values: <code>standard | gp2 | io1</code>
|
|
3437
|
+
* </p>
|
|
3438
|
+
* <p>
|
|
3439
|
+
* If you specify <code>io1</code>, you must also include a value for the
|
|
3440
|
+
* <code>Iops</code> parameter.
|
|
3441
|
+
* </p>
|
|
3442
|
+
* <p>
|
|
3443
|
+
* Default: <code>io1</code> if the <code>Iops</code> parameter
|
|
3444
|
+
* is specified, otherwise <code>gp2</code>
|
|
3445
|
+
* </p>
|
|
3446
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3447
|
+
*/
|
|
3448
|
+
StorageType?: string;
|
|
3449
|
+
/**
|
|
3450
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated
|
|
3451
|
+
* for each DB instance in the Multi-AZ DB cluster.</p>
|
|
3452
|
+
* <p>For information about valid Iops values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>.
|
|
3453
|
+
* </p>
|
|
3454
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p>
|
|
3455
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3456
|
+
*/
|
|
3457
|
+
Iops?: number;
|
|
3458
|
+
/**
|
|
3459
|
+
* <p>A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
|
|
3460
|
+
* By default, minor engine upgrades are applied automatically.</p>
|
|
3461
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3462
|
+
*/
|
|
3463
|
+
AutoMinorVersionUpgrade?: boolean;
|
|
3464
|
+
/**
|
|
3465
|
+
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
|
3466
|
+
* To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.</p>
|
|
3467
|
+
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code>
|
|
3468
|
+
* to a value other than 0.</p>
|
|
3469
|
+
* <p>Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code>
|
|
3470
|
+
* </p>
|
|
3471
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3472
|
+
*/
|
|
3473
|
+
MonitoringInterval?: number;
|
|
3474
|
+
/**
|
|
3475
|
+
* <p>The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An
|
|
3476
|
+
* example is <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role,
|
|
3477
|
+
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To
|
|
3478
|
+
* create an IAM role for Amazon RDS Enhanced Monitoring</a> in the <i>Amazon RDS User Guide.</i>
|
|
3479
|
+
* </p>
|
|
3480
|
+
* <p>If <code>MonitoringInterval</code> is set to a value other than 0, supply a <code>MonitoringRoleArn</code> value.</p>
|
|
3481
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3482
|
+
*/
|
|
3483
|
+
MonitoringRoleArn?: string;
|
|
3484
|
+
/**
|
|
3485
|
+
* <p>A value that indicates whether to turn on Performance Insights for the DB cluster.</p>
|
|
3486
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
|
|
3487
|
+
* Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.
|
|
3488
|
+
* </p>
|
|
3489
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3490
|
+
*/
|
|
3491
|
+
EnablePerformanceInsights?: boolean;
|
|
3492
|
+
/**
|
|
3493
|
+
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
|
|
3494
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
3495
|
+
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
3496
|
+
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
3497
|
+
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
3498
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3499
|
+
*/
|
|
3500
|
+
PerformanceInsightsKMSKeyId?: string;
|
|
3501
|
+
/**
|
|
3502
|
+
* <p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p>
|
|
3503
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3504
|
+
*/
|
|
3505
|
+
PerformanceInsightsRetentionPeriod?: number;
|
|
3366
3506
|
}
|
|
3367
3507
|
export declare namespace ModifyDBClusterMessage {
|
|
3368
3508
|
/**
|
|
@@ -3372,11 +3512,28 @@ export declare namespace ModifyDBClusterMessage {
|
|
|
3372
3512
|
}
|
|
3373
3513
|
export interface ModifyDBClusterResult {
|
|
3374
3514
|
/**
|
|
3375
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
3376
|
-
* </p>
|
|
3377
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
3378
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
3515
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
3379
3516
|
* </p>
|
|
3517
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
3518
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
3519
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
3520
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
3521
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
3522
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
3523
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
3524
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
3525
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
3526
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
3527
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
3528
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
3529
|
+
* </p>
|
|
3530
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
3531
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
3532
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
3533
|
+
* </p>
|
|
3534
|
+
* <note>
|
|
3535
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
3536
|
+
* </note>
|
|
3380
3537
|
*/
|
|
3381
3538
|
DBCluster?: DBCluster;
|
|
3382
3539
|
}
|
|
@@ -3590,7 +3747,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3590
3747
|
*/
|
|
3591
3748
|
AllocatedStorage?: number;
|
|
3592
3749
|
/**
|
|
3593
|
-
* <p>The new compute and memory capacity of the DB instance, for example
|
|
3750
|
+
* <p>The new compute and memory capacity of the DB instance, for example db.m4.large.
|
|
3594
3751
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
|
|
3595
3752
|
* For the full list of DB instance classes,
|
|
3596
3753
|
* and availability for your engine, see
|
|
@@ -4071,9 +4228,12 @@ export interface ModifyDBInstanceMessage {
|
|
|
4071
4228
|
/**
|
|
4072
4229
|
* <p>A value that indicates whether the DB instance is publicly accessible.
|
|
4073
4230
|
* </p>
|
|
4074
|
-
* <p>When the DB
|
|
4075
|
-
*
|
|
4076
|
-
*
|
|
4231
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
4232
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
4233
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
4234
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
4235
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
4236
|
+
* it.</p>
|
|
4077
4237
|
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
|
|
4078
4238
|
* <p>
|
|
4079
4239
|
* <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a
|
|
@@ -4112,8 +4272,8 @@ export interface ModifyDBInstanceMessage {
|
|
|
4112
4272
|
*/
|
|
4113
4273
|
PromotionTier?: number;
|
|
4114
4274
|
/**
|
|
4115
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
4116
|
-
*
|
|
4275
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
4276
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
4117
4277
|
* <p>This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB
|
|
4118
4278
|
* cluster.</p>
|
|
4119
4279
|
* <p>For more information about IAM database authentication, see
|
|
@@ -4168,7 +4328,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
4168
4328
|
/**
|
|
4169
4329
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
4170
4330
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
4171
|
-
* deletion protection
|
|
4331
|
+
* deletion protection isn't enabled. For more information, see
|
|
4172
4332
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
4173
4333
|
* Deleting a DB Instance</a>.
|
|
4174
4334
|
* </p>
|
|
@@ -4265,7 +4425,11 @@ export interface ModifyDBInstanceResult {
|
|
|
4265
4425
|
/**
|
|
4266
4426
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
4267
4427
|
* </p>
|
|
4268
|
-
* <p>This data type is used as a response element in the <code>
|
|
4428
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
4429
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
4430
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
4431
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
4432
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
4269
4433
|
* </p>
|
|
4270
4434
|
*/
|
|
4271
4435
|
DBInstance?: DBInstance;
|
|
@@ -5008,7 +5172,11 @@ export interface PromoteReadReplicaResult {
|
|
|
5008
5172
|
/**
|
|
5009
5173
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
5010
5174
|
* </p>
|
|
5011
|
-
* <p>This data type is used as a response element in the <code>
|
|
5175
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
5176
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
5177
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
5178
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
5179
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
5012
5180
|
* </p>
|
|
5013
5181
|
*/
|
|
5014
5182
|
DBInstance?: DBInstance;
|
|
@@ -5045,11 +5213,28 @@ export declare namespace PromoteReadReplicaDBClusterMessage {
|
|
|
5045
5213
|
}
|
|
5046
5214
|
export interface PromoteReadReplicaDBClusterResult {
|
|
5047
5215
|
/**
|
|
5048
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
5049
|
-
* </p>
|
|
5050
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
5051
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
5216
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
5052
5217
|
* </p>
|
|
5218
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
5219
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5220
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
5221
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
5222
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
5223
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
5224
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5225
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
5226
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
5227
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
5228
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
5229
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5230
|
+
* </p>
|
|
5231
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
5232
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
5233
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
5234
|
+
* </p>
|
|
5235
|
+
* <note>
|
|
5236
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
5237
|
+
* </note>
|
|
5053
5238
|
*/
|
|
5054
5239
|
DBCluster?: DBCluster;
|
|
5055
5240
|
}
|
|
@@ -5136,6 +5321,57 @@ export declare namespace ReservedDBInstanceQuotaExceededFault {
|
|
|
5136
5321
|
*/
|
|
5137
5322
|
const filterSensitiveLog: (obj: ReservedDBInstanceQuotaExceededFault) => any;
|
|
5138
5323
|
}
|
|
5324
|
+
export interface RebootDBClusterMessage {
|
|
5325
|
+
/**
|
|
5326
|
+
* <p>The DB cluster identifier. This parameter is stored as a lowercase string.</p>
|
|
5327
|
+
* <p>Constraints:</p>
|
|
5328
|
+
* <ul>
|
|
5329
|
+
* <li>
|
|
5330
|
+
* <p>Must match the identifier of an existing DBCluster.</p>
|
|
5331
|
+
* </li>
|
|
5332
|
+
* </ul>
|
|
5333
|
+
*/
|
|
5334
|
+
DBClusterIdentifier: string | undefined;
|
|
5335
|
+
}
|
|
5336
|
+
export declare namespace RebootDBClusterMessage {
|
|
5337
|
+
/**
|
|
5338
|
+
* @internal
|
|
5339
|
+
*/
|
|
5340
|
+
const filterSensitiveLog: (obj: RebootDBClusterMessage) => any;
|
|
5341
|
+
}
|
|
5342
|
+
export interface RebootDBClusterResult {
|
|
5343
|
+
/**
|
|
5344
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
5345
|
+
* </p>
|
|
5346
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
5347
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5348
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
5349
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
5350
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
5351
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
5352
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5353
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
5354
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
5355
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
5356
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
5357
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5358
|
+
* </p>
|
|
5359
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
5360
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
5361
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
5362
|
+
* </p>
|
|
5363
|
+
* <note>
|
|
5364
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
5365
|
+
* </note>
|
|
5366
|
+
*/
|
|
5367
|
+
DBCluster?: DBCluster;
|
|
5368
|
+
}
|
|
5369
|
+
export declare namespace RebootDBClusterResult {
|
|
5370
|
+
/**
|
|
5371
|
+
* @internal
|
|
5372
|
+
*/
|
|
5373
|
+
const filterSensitiveLog: (obj: RebootDBClusterResult) => any;
|
|
5374
|
+
}
|
|
5139
5375
|
/**
|
|
5140
5376
|
* <p></p>
|
|
5141
5377
|
*/
|
|
@@ -5168,7 +5404,11 @@ export interface RebootDBInstanceResult {
|
|
|
5168
5404
|
/**
|
|
5169
5405
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
5170
5406
|
* </p>
|
|
5171
|
-
* <p>This data type is used as a response element in the <code>
|
|
5407
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
5408
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
5409
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
5410
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
5411
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
5172
5412
|
* </p>
|
|
5173
5413
|
*/
|
|
5174
5414
|
DBInstance?: DBInstance;
|
|
@@ -5703,7 +5943,8 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5703
5943
|
KmsKeyId?: string;
|
|
5704
5944
|
/**
|
|
5705
5945
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
5706
|
-
* Management (IAM) accounts to database accounts. By default, mapping
|
|
5946
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
5947
|
+
* enabled.</p>
|
|
5707
5948
|
*
|
|
5708
5949
|
* <p>For more information, see
|
|
5709
5950
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
@@ -5766,7 +6007,7 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5766
6007
|
/**
|
|
5767
6008
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
5768
6009
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
5769
|
-
* deletion protection
|
|
6010
|
+
* deletion protection isn't enabled.
|
|
5770
6011
|
* </p>
|
|
5771
6012
|
*/
|
|
5772
6013
|
DeletionProtection?: boolean;
|
|
@@ -5798,11 +6039,28 @@ export declare namespace RestoreDBClusterFromS3Message {
|
|
|
5798
6039
|
}
|
|
5799
6040
|
export interface RestoreDBClusterFromS3Result {
|
|
5800
6041
|
/**
|
|
5801
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
5802
|
-
* </p>
|
|
5803
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
5804
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
6042
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
5805
6043
|
* </p>
|
|
6044
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
6045
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6046
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
6047
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
6048
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
6049
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
6050
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6051
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
6052
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
6053
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
6054
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
6055
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6056
|
+
* </p>
|
|
6057
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
6058
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
6059
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
6060
|
+
* </p>
|
|
6061
|
+
* <note>
|
|
6062
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
6063
|
+
* </note>
|
|
5806
6064
|
*/
|
|
5807
6065
|
DBCluster?: DBCluster;
|
|
5808
6066
|
}
|
|
@@ -5847,6 +6105,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5847
6105
|
/**
|
|
5848
6106
|
* <p>Provides the list of Availability Zones (AZs) where instances in the restored DB
|
|
5849
6107
|
* cluster can be created.</p>
|
|
6108
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
5850
6109
|
*/
|
|
5851
6110
|
AvailabilityZones?: string[];
|
|
5852
6111
|
/**
|
|
@@ -5866,6 +6125,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5866
6125
|
* </ul>
|
|
5867
6126
|
* <p>Example: <code>my-snapshot-id</code>
|
|
5868
6127
|
* </p>
|
|
6128
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5869
6129
|
*/
|
|
5870
6130
|
DBClusterIdentifier: string | undefined;
|
|
5871
6131
|
/**
|
|
@@ -5878,41 +6138,63 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5878
6138
|
* <p>Must match the identifier of an existing Snapshot.</p>
|
|
5879
6139
|
* </li>
|
|
5880
6140
|
* </ul>
|
|
6141
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5881
6142
|
*/
|
|
5882
6143
|
SnapshotIdentifier: string | undefined;
|
|
5883
6144
|
/**
|
|
5884
6145
|
* <p>The database engine to use for the new DB cluster.</p>
|
|
5885
6146
|
* <p>Default: The same as source</p>
|
|
5886
6147
|
* <p>Constraint: Must be compatible with the engine of the source</p>
|
|
6148
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5887
6149
|
*/
|
|
5888
6150
|
Engine: string | undefined;
|
|
5889
6151
|
/**
|
|
5890
6152
|
* <p>The version of the database engine to use for the new DB cluster.</p>
|
|
5891
|
-
* <p>To list all of the available engine versions for
|
|
6153
|
+
* <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p>
|
|
5892
6154
|
* <p>
|
|
5893
6155
|
* <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
|
|
5894
6156
|
* </p>
|
|
5895
|
-
* <p>To list all of the available engine versions for
|
|
6157
|
+
* <p>To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:</p>
|
|
5896
6158
|
* <p>
|
|
5897
6159
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
5898
6160
|
* </p>
|
|
5899
|
-
* <p>To list all of the available engine versions for
|
|
6161
|
+
* <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p>
|
|
5900
6162
|
* <p>
|
|
5901
6163
|
* <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"</code>
|
|
5902
6164
|
* </p>
|
|
5903
|
-
* <
|
|
5904
|
-
*
|
|
5905
|
-
*
|
|
6165
|
+
* <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p>
|
|
6166
|
+
* <p>
|
|
6167
|
+
* <code>aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
6168
|
+
* </p>
|
|
6169
|
+
* <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p>
|
|
6170
|
+
* <p>
|
|
6171
|
+
* <code>aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"</code>
|
|
6172
|
+
* </p>
|
|
5906
6173
|
* <p>
|
|
5907
6174
|
* <b>Aurora MySQL</b>
|
|
5908
6175
|
* </p>
|
|
5909
|
-
* <p>
|
|
6176
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html">MySQL on Amazon RDS Versions</a> in the
|
|
6177
|
+
* <i>Amazon Aurora User Guide.</i>
|
|
5910
6178
|
* </p>
|
|
5911
6179
|
* <p>
|
|
5912
6180
|
* <b>Aurora PostgreSQL</b>
|
|
5913
6181
|
* </p>
|
|
5914
|
-
* <p>
|
|
6182
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html">Amazon Aurora PostgreSQL releases and engine versions</a> in the
|
|
6183
|
+
* <i>Amazon Aurora User Guide.</i>
|
|
6184
|
+
* </p>
|
|
6185
|
+
* <p>
|
|
6186
|
+
* <b>MySQL</b>
|
|
6187
|
+
* </p>
|
|
6188
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt">MySQL on Amazon RDS Versions</a> in the
|
|
6189
|
+
* <i>Amazon RDS User Guide.</i>
|
|
6190
|
+
* </p>
|
|
6191
|
+
* <p>
|
|
6192
|
+
* <b>PostgreSQL</b>
|
|
6193
|
+
* </p>
|
|
6194
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts">Amazon RDS for PostgreSQL versions and extensions</a> in the
|
|
6195
|
+
* <i>Amazon RDS User Guide.</i>
|
|
5915
6196
|
* </p>
|
|
6197
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5916
6198
|
*/
|
|
5917
6199
|
EngineVersion?: string;
|
|
5918
6200
|
/**
|
|
@@ -5920,6 +6202,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5920
6202
|
* <p>Constraints: This value must be <code>1150-65535</code>
|
|
5921
6203
|
* </p>
|
|
5922
6204
|
* <p>Default: The same port as the original DB cluster.</p>
|
|
6205
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5923
6206
|
*/
|
|
5924
6207
|
Port?: number;
|
|
5925
6208
|
/**
|
|
@@ -5927,22 +6210,27 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5927
6210
|
* <p>Constraints: If supplied, must match the name of an existing DB subnet group.</p>
|
|
5928
6211
|
* <p>Example: <code>mySubnetgroup</code>
|
|
5929
6212
|
* </p>
|
|
6213
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5930
6214
|
*/
|
|
5931
6215
|
DBSubnetGroupName?: string;
|
|
5932
6216
|
/**
|
|
5933
6217
|
* <p>The database name for the restored DB cluster.</p>
|
|
6218
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5934
6219
|
*/
|
|
5935
6220
|
DatabaseName?: string;
|
|
5936
6221
|
/**
|
|
5937
6222
|
* <p>The name of the option group to use for the restored DB cluster.</p>
|
|
6223
|
+
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
5938
6224
|
*/
|
|
5939
6225
|
OptionGroupName?: string;
|
|
5940
6226
|
/**
|
|
5941
6227
|
* <p>A list of VPC security groups that the new DB cluster will belong to.</p>
|
|
6228
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5942
6229
|
*/
|
|
5943
6230
|
VpcSecurityGroupIds?: string[];
|
|
5944
6231
|
/**
|
|
5945
6232
|
* <p>The tags to be assigned to the restored DB cluster.</p>
|
|
6233
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5946
6234
|
*/
|
|
5947
6235
|
Tags?: Tag[];
|
|
5948
6236
|
/**
|
|
@@ -5965,16 +6253,18 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5965
6253
|
* isn't encrypted.</p>
|
|
5966
6254
|
* </li>
|
|
5967
6255
|
* </ul>
|
|
6256
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5968
6257
|
*/
|
|
5969
6258
|
KmsKeyId?: string;
|
|
5970
6259
|
/**
|
|
5971
6260
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
5972
|
-
* Management (IAM) accounts to database accounts. By default, mapping
|
|
5973
|
-
*
|
|
6261
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
6262
|
+
* enabled.</p>
|
|
5974
6263
|
* <p>For more information, see
|
|
5975
6264
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
5976
6265
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5977
6266
|
* </p>
|
|
6267
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
5978
6268
|
*/
|
|
5979
6269
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
5980
6270
|
/**
|
|
@@ -5990,13 +6280,15 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5990
6280
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
5991
6281
|
* </li>
|
|
5992
6282
|
* </ul>
|
|
6283
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
5993
6284
|
*/
|
|
5994
6285
|
BacktrackWindow?: number;
|
|
5995
6286
|
/**
|
|
5996
6287
|
* <p>The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
|
5997
|
-
* The values in the list depend on the DB engine being used
|
|
5998
|
-
*
|
|
5999
|
-
*
|
|
6288
|
+
* The values in the list depend on the DB engine being used.</p>
|
|
6289
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon
|
|
6290
|
+
* Aurora User Guide</i>.</p>
|
|
6291
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6000
6292
|
*/
|
|
6001
6293
|
EnableCloudwatchLogsExports?: string[];
|
|
6002
6294
|
/**
|
|
@@ -6004,10 +6296,12 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
6004
6296
|
* <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p>
|
|
6005
6297
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html">
|
|
6006
6298
|
* CreateDBCluster</a>.</p>
|
|
6299
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6007
6300
|
*/
|
|
6008
6301
|
EngineMode?: string;
|
|
6009
6302
|
/**
|
|
6010
6303
|
* <p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>
|
|
6304
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6011
6305
|
*/
|
|
6012
6306
|
ScalingConfiguration?: ScalingConfiguration;
|
|
6013
6307
|
/**
|
|
@@ -6029,17 +6323,19 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
6029
6323
|
* <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
|
|
6030
6324
|
* </li>
|
|
6031
6325
|
* </ul>
|
|
6326
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6032
6327
|
*/
|
|
6033
6328
|
DBClusterParameterGroupName?: string;
|
|
6034
6329
|
/**
|
|
6035
6330
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
6036
6331
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6037
|
-
* deletion protection
|
|
6038
|
-
* </p>
|
|
6332
|
+
* deletion protection isn't enabled.</p>
|
|
6333
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6039
6334
|
*/
|
|
6040
6335
|
DeletionProtection?: boolean;
|
|
6041
6336
|
/**
|
|
6042
6337
|
* <p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p>
|
|
6338
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6043
6339
|
*/
|
|
6044
6340
|
CopyTagsToSnapshot?: boolean;
|
|
6045
6341
|
/**
|
|
@@ -6047,14 +6343,78 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
6047
6343
|
* The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL
|
|
6048
6344
|
* Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.</p>
|
|
6049
6345
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html">
|
|
6050
|
-
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i
|
|
6051
|
-
*
|
|
6346
|
+
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
6347
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6052
6348
|
*/
|
|
6053
6349
|
Domain?: string;
|
|
6054
6350
|
/**
|
|
6055
6351
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
6352
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6056
6353
|
*/
|
|
6057
6354
|
DomainIAMRoleName?: string;
|
|
6355
|
+
/**
|
|
6356
|
+
* <p>The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
|
6357
|
+
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p>
|
|
6358
|
+
* <p>For the full list of DB instance classes, and availability for your engine, see
|
|
6359
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i>
|
|
6360
|
+
* </p>
|
|
6361
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6362
|
+
*/
|
|
6363
|
+
DBClusterInstanceClass?: string;
|
|
6364
|
+
/**
|
|
6365
|
+
* <p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p>
|
|
6366
|
+
* <p>
|
|
6367
|
+
* Valid values: <code>standard | gp2 | io1</code>
|
|
6368
|
+
* </p>
|
|
6369
|
+
* <p>
|
|
6370
|
+
* If you specify <code>io1</code>, you must also include a value for the
|
|
6371
|
+
* <code>Iops</code> parameter.
|
|
6372
|
+
* </p>
|
|
6373
|
+
* <p>
|
|
6374
|
+
* Default: <code>io1</code> if the <code>Iops</code> parameter
|
|
6375
|
+
* is specified, otherwise <code>gp2</code>
|
|
6376
|
+
* </p>
|
|
6377
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6378
|
+
*/
|
|
6379
|
+
StorageType?: string;
|
|
6380
|
+
/**
|
|
6381
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for
|
|
6382
|
+
* each DB instance in the Multi-AZ DB cluster.</p>
|
|
6383
|
+
* <p>For information about valid Iops values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>.
|
|
6384
|
+
* </p>
|
|
6385
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.</p>
|
|
6386
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6387
|
+
*/
|
|
6388
|
+
Iops?: number;
|
|
6389
|
+
/**
|
|
6390
|
+
* <p>A value that indicates whether the DB cluster is publicly accessible.</p>
|
|
6391
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
6392
|
+
* from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC.
|
|
6393
|
+
* Access to the DB cluster is ultimately controlled by the security group it uses.
|
|
6394
|
+
* That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.</p>
|
|
6395
|
+
* <p>When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.</p>
|
|
6396
|
+
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
|
|
6397
|
+
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6398
|
+
* <ul>
|
|
6399
|
+
* <li>
|
|
6400
|
+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6401
|
+
* </li>
|
|
6402
|
+
* <li>
|
|
6403
|
+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6404
|
+
* </li>
|
|
6405
|
+
* </ul>
|
|
6406
|
+
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6407
|
+
* <ul>
|
|
6408
|
+
* <li>
|
|
6409
|
+
* <p>If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6410
|
+
* </li>
|
|
6411
|
+
* <li>
|
|
6412
|
+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6413
|
+
* </li>
|
|
6414
|
+
* </ul>
|
|
6415
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6416
|
+
*/
|
|
6417
|
+
PubliclyAccessible?: boolean;
|
|
6058
6418
|
}
|
|
6059
6419
|
export declare namespace RestoreDBClusterFromSnapshotMessage {
|
|
6060
6420
|
/**
|
|
@@ -6064,11 +6424,28 @@ export declare namespace RestoreDBClusterFromSnapshotMessage {
|
|
|
6064
6424
|
}
|
|
6065
6425
|
export interface RestoreDBClusterFromSnapshotResult {
|
|
6066
6426
|
/**
|
|
6067
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
6068
|
-
* </p>
|
|
6069
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
6070
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
6427
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
6071
6428
|
* </p>
|
|
6429
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
6430
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6431
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
6432
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
6433
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
6434
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
6435
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6436
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
6437
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
6438
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
6439
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
6440
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6441
|
+
* </p>
|
|
6442
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
6443
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
6444
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
6445
|
+
* </p>
|
|
6446
|
+
* <note>
|
|
6447
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
6448
|
+
* </note>
|
|
6072
6449
|
*/
|
|
6073
6450
|
DBCluster?: DBCluster;
|
|
6074
6451
|
}
|
|
@@ -6096,6 +6473,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6096
6473
|
* <p>Can't end with a hyphen or contain two consecutive hyphens</p>
|
|
6097
6474
|
* </li>
|
|
6098
6475
|
* </ul>
|
|
6476
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6099
6477
|
*/
|
|
6100
6478
|
DBClusterIdentifier: string | undefined;
|
|
6101
6479
|
/**
|
|
@@ -6115,6 +6493,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6115
6493
|
* <p>Constraints: You can't specify <code>copy-on-write</code> if the engine version of the source DB cluster is earlier than 1.11.</p>
|
|
6116
6494
|
* <p>If you don't specify a <code>RestoreType</code> value, then the new DB cluster is
|
|
6117
6495
|
* restored as a full copy of the source DB cluster.</p>
|
|
6496
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6118
6497
|
*/
|
|
6119
6498
|
RestoreType?: string;
|
|
6120
6499
|
/**
|
|
@@ -6125,6 +6504,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6125
6504
|
* <p>Must match the identifier of an existing DBCluster.</p>
|
|
6126
6505
|
* </li>
|
|
6127
6506
|
* </ul>
|
|
6507
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6128
6508
|
*/
|
|
6129
6509
|
SourceDBClusterIdentifier: string | undefined;
|
|
6130
6510
|
/**
|
|
@@ -6148,6 +6528,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6148
6528
|
* </ul>
|
|
6149
6529
|
* <p>Example: <code>2015-03-07T23:45:00Z</code>
|
|
6150
6530
|
* </p>
|
|
6531
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6151
6532
|
*/
|
|
6152
6533
|
RestoreToTime?: Date;
|
|
6153
6534
|
/**
|
|
@@ -6156,6 +6537,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6156
6537
|
* restorable backup time.
|
|
6157
6538
|
* </p>
|
|
6158
6539
|
* <p>Constraints: Can't be specified if <code>RestoreToTime</code> parameter is provided.</p>
|
|
6540
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6159
6541
|
*/
|
|
6160
6542
|
UseLatestRestorableTime?: boolean;
|
|
6161
6543
|
/**
|
|
@@ -6163,6 +6545,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6163
6545
|
* <p>Constraints: A value from <code>1150-65535</code>.
|
|
6164
6546
|
* </p>
|
|
6165
6547
|
* <p>Default: The default port for the engine.</p>
|
|
6548
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6166
6549
|
*/
|
|
6167
6550
|
Port?: number;
|
|
6168
6551
|
/**
|
|
@@ -6170,14 +6553,17 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6170
6553
|
* <p>Constraints: If supplied, must match the name of an existing DBSubnetGroup.</p>
|
|
6171
6554
|
* <p>Example: <code>mySubnetgroup</code>
|
|
6172
6555
|
* </p>
|
|
6556
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6173
6557
|
*/
|
|
6174
6558
|
DBSubnetGroupName?: string;
|
|
6175
6559
|
/**
|
|
6176
6560
|
* <p>The name of the option group for the new DB cluster.</p>
|
|
6561
|
+
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
6177
6562
|
*/
|
|
6178
6563
|
OptionGroupName?: string;
|
|
6179
6564
|
/**
|
|
6180
6565
|
* <p>A list of VPC security groups that the new DB cluster belongs to.</p>
|
|
6566
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6181
6567
|
*/
|
|
6182
6568
|
VpcSecurityGroupIds?: string[];
|
|
6183
6569
|
/**
|
|
@@ -6202,27 +6588,25 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6202
6588
|
* <p>If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.</p>
|
|
6203
6589
|
* </li>
|
|
6204
6590
|
* </ul>
|
|
6205
|
-
*
|
|
6206
6591
|
* <p>If <code>DBClusterIdentifier</code> refers to a DB cluster that isn't encrypted, then the restore request
|
|
6207
6592
|
* is rejected.</p>
|
|
6593
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6208
6594
|
*/
|
|
6209
6595
|
KmsKeyId?: string;
|
|
6210
6596
|
/**
|
|
6211
6597
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
6212
|
-
* Management (IAM) accounts to database accounts. By default, mapping
|
|
6213
|
-
*
|
|
6598
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
6599
|
+
* enabled.</p>
|
|
6214
6600
|
* <p>For more information, see
|
|
6215
6601
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
6216
6602
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6217
6603
|
* </p>
|
|
6604
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6218
6605
|
*/
|
|
6219
6606
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
6220
6607
|
/**
|
|
6221
6608
|
* <p>The target backtrack window, in seconds. To disable backtracking, set this value to
|
|
6222
6609
|
* 0.</p>
|
|
6223
|
-
* <note>
|
|
6224
|
-
* <p>Currently, Backtrack is only supported for Aurora MySQL DB clusters.</p>
|
|
6225
|
-
* </note>
|
|
6226
6610
|
* <p>Default: 0</p>
|
|
6227
6611
|
* <p>Constraints:</p>
|
|
6228
6612
|
* <ul>
|
|
@@ -6230,12 +6614,14 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6230
6614
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
6231
6615
|
* </li>
|
|
6232
6616
|
* </ul>
|
|
6617
|
+
* <p>Valid for: Aurora MySQL DB clusters only</p>
|
|
6233
6618
|
*/
|
|
6234
6619
|
BacktrackWindow?: number;
|
|
6235
6620
|
/**
|
|
6236
6621
|
* <p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values
|
|
6237
|
-
* in the list depend on the DB engine being used
|
|
6238
|
-
*
|
|
6622
|
+
* in the list depend on the DB engine being used.</p>
|
|
6623
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
6624
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6239
6625
|
*/
|
|
6240
6626
|
EnableCloudwatchLogsExports?: string[];
|
|
6241
6627
|
/**
|
|
@@ -6256,17 +6642,19 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6256
6642
|
* <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
|
|
6257
6643
|
* </li>
|
|
6258
6644
|
* </ul>
|
|
6645
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6259
6646
|
*/
|
|
6260
6647
|
DBClusterParameterGroupName?: string;
|
|
6261
6648
|
/**
|
|
6262
6649
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
6263
6650
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6264
|
-
* deletion protection
|
|
6265
|
-
* </p>
|
|
6651
|
+
* deletion protection isn't enabled.</p>
|
|
6652
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6266
6653
|
*/
|
|
6267
6654
|
DeletionProtection?: boolean;
|
|
6268
6655
|
/**
|
|
6269
6656
|
* <p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p>
|
|
6657
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6270
6658
|
*/
|
|
6271
6659
|
CopyTagsToSnapshot?: boolean;
|
|
6272
6660
|
/**
|
|
@@ -6278,14 +6666,17 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6278
6666
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html">Kerberos Authentication</a>
|
|
6279
6667
|
* in the <i>Amazon Aurora User Guide</i>.
|
|
6280
6668
|
* </p>
|
|
6669
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6281
6670
|
*/
|
|
6282
6671
|
Domain?: string;
|
|
6283
6672
|
/**
|
|
6284
6673
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
6674
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6285
6675
|
*/
|
|
6286
6676
|
DomainIAMRoleName?: string;
|
|
6287
6677
|
/**
|
|
6288
6678
|
* <p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>
|
|
6679
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6289
6680
|
*/
|
|
6290
6681
|
ScalingConfiguration?: ScalingConfiguration;
|
|
6291
6682
|
/**
|
|
@@ -6294,8 +6685,74 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6294
6685
|
* from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone
|
|
6295
6686
|
* that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or
|
|
6296
6687
|
* an encrypted provisioned cluster.</p>
|
|
6688
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6297
6689
|
*/
|
|
6298
6690
|
EngineMode?: string;
|
|
6691
|
+
/**
|
|
6692
|
+
* <p>The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,
|
|
6693
|
+
* for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services
|
|
6694
|
+
* Regions, or for all database engines.</p>
|
|
6695
|
+
* <p>For the full list of DB instance classes, and availability for your engine, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB instance class</a> in the <i>Amazon RDS User Guide.</i>
|
|
6696
|
+
* </p>
|
|
6697
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6698
|
+
*/
|
|
6699
|
+
DBClusterInstanceClass?: string;
|
|
6700
|
+
/**
|
|
6701
|
+
* <p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p>
|
|
6702
|
+
* <p>
|
|
6703
|
+
* Valid values: <code>standard | gp2 | io1</code>
|
|
6704
|
+
* </p>
|
|
6705
|
+
* <p>
|
|
6706
|
+
* If you specify <code>io1</code>, also include a value for the
|
|
6707
|
+
* <code>Iops</code> parameter.
|
|
6708
|
+
* </p>
|
|
6709
|
+
* <p>
|
|
6710
|
+
* Default: <code>io1</code> if the <code>Iops</code> parameter
|
|
6711
|
+
* is specified, otherwise <code>gp2</code>
|
|
6712
|
+
* </p>
|
|
6713
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6714
|
+
*/
|
|
6715
|
+
StorageType?: string;
|
|
6716
|
+
/**
|
|
6717
|
+
* <p>A value that indicates whether the DB cluster is publicly accessible.</p>
|
|
6718
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
6719
|
+
* from within the DB cluster's virtual private cloud (VPC). It resolves
|
|
6720
|
+
* to the public IP address from outside of the DB cluster's VPC.
|
|
6721
|
+
* Access to the DB cluster is ultimately controlled by the security group it uses.
|
|
6722
|
+
* That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.</p>
|
|
6723
|
+
* <p>When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.</p>
|
|
6724
|
+
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
|
|
6725
|
+
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6726
|
+
* <ul>
|
|
6727
|
+
* <li>
|
|
6728
|
+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6729
|
+
* </li>
|
|
6730
|
+
* <li>
|
|
6731
|
+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6732
|
+
* </li>
|
|
6733
|
+
* </ul>
|
|
6734
|
+
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6735
|
+
* <ul>
|
|
6736
|
+
* <li>
|
|
6737
|
+
* <p>If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6738
|
+
* </li>
|
|
6739
|
+
* <li>
|
|
6740
|
+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6741
|
+
* </li>
|
|
6742
|
+
* </ul>
|
|
6743
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6744
|
+
*/
|
|
6745
|
+
PubliclyAccessible?: boolean;
|
|
6746
|
+
/**
|
|
6747
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for
|
|
6748
|
+
* each DB instance in the Multi-AZ DB cluster.</p>
|
|
6749
|
+
* <p>For information about valid <code>Iops</code> values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS">Amazon RDS Provisioned IOPS storage to improve performance</a> in the <i>Amazon RDS User Guide</i>.
|
|
6750
|
+
* </p>
|
|
6751
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
|
|
6752
|
+
* </p>
|
|
6753
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6754
|
+
*/
|
|
6755
|
+
Iops?: number;
|
|
6299
6756
|
}
|
|
6300
6757
|
export declare namespace RestoreDBClusterToPointInTimeMessage {
|
|
6301
6758
|
/**
|
|
@@ -6305,11 +6762,28 @@ export declare namespace RestoreDBClusterToPointInTimeMessage {
|
|
|
6305
6762
|
}
|
|
6306
6763
|
export interface RestoreDBClusterToPointInTimeResult {
|
|
6307
6764
|
/**
|
|
6308
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
6309
|
-
* </p>
|
|
6310
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
6311
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
6765
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
6312
6766
|
* </p>
|
|
6767
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
6768
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6769
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
6770
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
6771
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
6772
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
6773
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6774
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
6775
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
6776
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
6777
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
6778
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6779
|
+
* </p>
|
|
6780
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
6781
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
6782
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
6783
|
+
* </p>
|
|
6784
|
+
* <note>
|
|
6785
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
6786
|
+
* </note>
|
|
6313
6787
|
*/
|
|
6314
6788
|
DBCluster?: DBCluster;
|
|
6315
6789
|
}
|
|
@@ -6356,7 +6830,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6356
6830
|
*/
|
|
6357
6831
|
DBSnapshotIdentifier: string | undefined;
|
|
6358
6832
|
/**
|
|
6359
|
-
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
6833
|
+
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.
|
|
6360
6834
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
|
|
6361
6835
|
* For the full list of DB instance classes,
|
|
6362
6836
|
* and availability for your engine, see
|
|
@@ -6395,9 +6869,10 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6395
6869
|
MultiAZ?: boolean;
|
|
6396
6870
|
/**
|
|
6397
6871
|
* <p>A value that indicates whether the DB instance is publicly accessible.</p>
|
|
6398
|
-
* <p>When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address
|
|
6399
|
-
*
|
|
6400
|
-
*
|
|
6872
|
+
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
6873
|
+
* from within the DB instance's virtual private cloud (VPC).
|
|
6874
|
+
* It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled
|
|
6875
|
+
* by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
|
|
6401
6876
|
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
|
|
6402
6877
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
6403
6878
|
*/
|
|
@@ -6624,7 +7099,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6624
7099
|
/**
|
|
6625
7100
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
6626
7101
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6627
|
-
* deletion protection
|
|
7102
|
+
* deletion protection isn't enabled. For more information, see
|
|
6628
7103
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
6629
7104
|
* Deleting a DB Instance</a>.
|
|
6630
7105
|
* </p>
|
|
@@ -6664,6 +7139,13 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6664
7139
|
* <p>This setting is required for RDS Custom.</p>
|
|
6665
7140
|
*/
|
|
6666
7141
|
CustomIamInstanceProfile?: string;
|
|
7142
|
+
/**
|
|
7143
|
+
* <p>Specifies where automated backups and manual snapshots are stored for the restored DB instance.</p>
|
|
7144
|
+
* <p>Possible values are <code>outposts</code> (Amazon Web Services Outposts) and <code>region</code> (Amazon Web Services Region). The default is <code>region</code>.</p>
|
|
7145
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working
|
|
7146
|
+
* with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
7147
|
+
*/
|
|
7148
|
+
BackupTarget?: string;
|
|
6667
7149
|
}
|
|
6668
7150
|
export declare namespace RestoreDBInstanceFromDBSnapshotMessage {
|
|
6669
7151
|
/**
|
|
@@ -6675,7 +7157,11 @@ export interface RestoreDBInstanceFromDBSnapshotResult {
|
|
|
6675
7157
|
/**
|
|
6676
7158
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
6677
7159
|
* </p>
|
|
6678
|
-
* <p>This data type is used as a response element in the <code>
|
|
7160
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
7161
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
7162
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
7163
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
7164
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
6679
7165
|
* </p>
|
|
6680
7166
|
*/
|
|
6681
7167
|
DBInstance?: DBInstance;
|
|
@@ -6730,7 +7216,7 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6730
7216
|
AllocatedStorage?: number;
|
|
6731
7217
|
/**
|
|
6732
7218
|
* <p>The compute and memory capacity of the DB instance,
|
|
6733
|
-
* for example
|
|
7219
|
+
* for example db.m4.large.
|
|
6734
7220
|
* Not all DB instance classes are available in all Amazon Web Services Regions,
|
|
6735
7221
|
* or for all database engines.
|
|
6736
7222
|
* For the full list of DB instance classes,
|
|
@@ -6919,9 +7405,11 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6919
7405
|
OptionGroupName?: string;
|
|
6920
7406
|
/**
|
|
6921
7407
|
* <p>A value that indicates whether the DB instance is publicly accessible.</p>
|
|
6922
|
-
* <p>When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address
|
|
6923
|
-
*
|
|
6924
|
-
*
|
|
7408
|
+
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
7409
|
+
* from within the DB instance's virtual private cloud (VPC).
|
|
7410
|
+
* It resolves to the public IP address from outside of the DB instance's VPC.
|
|
7411
|
+
* Access to the DB instance is ultimately controlled by the security group it uses.
|
|
7412
|
+
* That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
|
|
6925
7413
|
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
|
|
6926
7414
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
6927
7415
|
*/
|
|
@@ -6998,8 +7486,8 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6998
7486
|
*/
|
|
6999
7487
|
MonitoringRoleArn?: string;
|
|
7000
7488
|
/**
|
|
7001
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
7002
|
-
*
|
|
7489
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
7490
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
7003
7491
|
*
|
|
7004
7492
|
* <p>For more information about IAM database authentication, see
|
|
7005
7493
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
@@ -7078,7 +7566,7 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
7078
7566
|
/**
|
|
7079
7567
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
7080
7568
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
7081
|
-
* deletion protection
|
|
7569
|
+
* deletion protection isn't enabled. For more information, see
|
|
7082
7570
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
7083
7571
|
* Deleting a DB Instance</a>.
|
|
7084
7572
|
* </p>
|
|
@@ -7103,7 +7591,11 @@ export interface RestoreDBInstanceFromS3Result {
|
|
|
7103
7591
|
/**
|
|
7104
7592
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7105
7593
|
* </p>
|
|
7106
|
-
* <p>This data type is used as a response element in the <code>
|
|
7594
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
7595
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
7596
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
7597
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
7598
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7107
7599
|
* </p>
|
|
7108
7600
|
*/
|
|
7109
7601
|
DBInstance?: DBInstance;
|
|
@@ -7187,12 +7679,12 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7187
7679
|
*/
|
|
7188
7680
|
UseLatestRestorableTime?: boolean;
|
|
7189
7681
|
/**
|
|
7190
|
-
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
7191
|
-
*
|
|
7192
|
-
*
|
|
7193
|
-
*
|
|
7194
|
-
*
|
|
7195
|
-
*
|
|
7682
|
+
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
7683
|
+
* db.m4.large. Not all DB instance classes are available in all Amazon Web Services
|
|
7684
|
+
* Regions, or for all database engines. For the full list of DB instance classes, and
|
|
7685
|
+
* availability for your engine, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB Instance
|
|
7686
|
+
* Class</a> in the <i>Amazon RDS User Guide.</i>
|
|
7687
|
+
* </p>
|
|
7196
7688
|
* <p>Default: The same DBInstanceClass as the original DB instance.</p>
|
|
7197
7689
|
*/
|
|
7198
7690
|
DBInstanceClass?: string;
|
|
@@ -7227,9 +7719,12 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7227
7719
|
MultiAZ?: boolean;
|
|
7228
7720
|
/**
|
|
7229
7721
|
* <p>A value that indicates whether the DB instance is publicly accessible.</p>
|
|
7230
|
-
* <p>When the DB
|
|
7231
|
-
*
|
|
7232
|
-
*
|
|
7722
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
7723
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
7724
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
7725
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
7726
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
7727
|
+
* it.</p>
|
|
7233
7728
|
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
|
|
7234
7729
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
7235
7730
|
*/
|
|
@@ -7399,8 +7894,8 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7399
7894
|
*/
|
|
7400
7895
|
DomainIAMRoleName?: string;
|
|
7401
7896
|
/**
|
|
7402
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
7403
|
-
*
|
|
7897
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
7898
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
7404
7899
|
*
|
|
7405
7900
|
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7406
7901
|
*
|
|
@@ -7452,7 +7947,7 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7452
7947
|
/**
|
|
7453
7948
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
7454
7949
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
7455
|
-
* deletion protection
|
|
7950
|
+
* deletion protection isn't enabled. For more information, see
|
|
7456
7951
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
7457
7952
|
* Deleting a DB Instance</a>.
|
|
7458
7953
|
* </p>
|
|
@@ -7511,6 +8006,13 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7511
8006
|
* <p>This setting is required for RDS Custom.</p>
|
|
7512
8007
|
*/
|
|
7513
8008
|
CustomIamInstanceProfile?: string;
|
|
8009
|
+
/**
|
|
8010
|
+
* <p>Specifies where automated backups and manual snapshots are stored for the restored DB instance.</p>
|
|
8011
|
+
* <p>Possible values are <code>outposts</code> (Amazon Web Services Outposts) and <code>region</code> (Amazon Web Services Region). The default is <code>region</code>.</p>
|
|
8012
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working
|
|
8013
|
+
* with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
8014
|
+
*/
|
|
8015
|
+
BackupTarget?: string;
|
|
7514
8016
|
}
|
|
7515
8017
|
export declare namespace RestoreDBInstanceToPointInTimeMessage {
|
|
7516
8018
|
/**
|
|
@@ -7522,7 +8024,11 @@ export interface RestoreDBInstanceToPointInTimeResult {
|
|
|
7522
8024
|
/**
|
|
7523
8025
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7524
8026
|
* </p>
|
|
7525
|
-
* <p>This data type is used as a response element in the <code>
|
|
8027
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
8028
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
8029
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
8030
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
8031
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7526
8032
|
* </p>
|
|
7527
8033
|
*/
|
|
7528
8034
|
DBInstance?: DBInstance;
|
|
@@ -7682,11 +8188,28 @@ export declare namespace StartDBClusterMessage {
|
|
|
7682
8188
|
}
|
|
7683
8189
|
export interface StartDBClusterResult {
|
|
7684
8190
|
/**
|
|
7685
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
7686
|
-
* </p>
|
|
7687
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
7688
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
8191
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
7689
8192
|
* </p>
|
|
8193
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
8194
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8195
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
8196
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
8197
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
8198
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
8199
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8200
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
8201
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
8202
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
8203
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
8204
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
8205
|
+
* </p>
|
|
8206
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
8207
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
8208
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
8209
|
+
* </p>
|
|
8210
|
+
* <note>
|
|
8211
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
8212
|
+
* </note>
|
|
7690
8213
|
*/
|
|
7691
8214
|
DBCluster?: DBCluster;
|
|
7692
8215
|
}
|
|
@@ -7714,7 +8237,11 @@ export interface StartDBInstanceResult {
|
|
|
7714
8237
|
/**
|
|
7715
8238
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7716
8239
|
* </p>
|
|
7717
|
-
* <p>This data type is used as a response element in the <code>
|
|
8240
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
8241
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
8242
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
8243
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
8244
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7718
8245
|
* </p>
|
|
7719
8246
|
*/
|
|
7720
8247
|
DBInstance?: DBInstance;
|
|
@@ -7989,11 +8516,28 @@ export declare namespace StopDBClusterMessage {
|
|
|
7989
8516
|
}
|
|
7990
8517
|
export interface StopDBClusterResult {
|
|
7991
8518
|
/**
|
|
7992
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
7993
|
-
* </p>
|
|
7994
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
7995
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
8519
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
7996
8520
|
* </p>
|
|
8521
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
8522
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8523
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
8524
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
8525
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
8526
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
8527
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8528
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
8529
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
8530
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
8531
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
8532
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
8533
|
+
* </p>
|
|
8534
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
8535
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
8536
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
8537
|
+
* </p>
|
|
8538
|
+
* <note>
|
|
8539
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
8540
|
+
* </note>
|
|
7997
8541
|
*/
|
|
7998
8542
|
DBCluster?: DBCluster;
|
|
7999
8543
|
}
|
|
@@ -8027,7 +8571,11 @@ export interface StopDBInstanceResult {
|
|
|
8027
8571
|
/**
|
|
8028
8572
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
8029
8573
|
* </p>
|
|
8030
|
-
* <p>This data type is used as a response element in the <code>
|
|
8574
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
8575
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
8576
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
8577
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
8578
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
8031
8579
|
* </p>
|
|
8032
8580
|
*/
|
|
8033
8581
|
DBInstance?: DBInstance;
|