@aws-sdk/client-rds 3.41.0 → 3.46.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 +51 -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 +9 -0
- package/dist-cjs/models/models_1.js +14 -2
- package/dist-cjs/protocols/Aws_query.js +248 -4
- package/dist-cjs/runtimeConfig.js +0 -2
- 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 +9 -0
- package/dist-es/models/models_1.js +8 -0
- package/dist-es/protocols/Aws_query.js +250 -0
- package/dist-es/runtimeConfig.js +0 -2
- package/dist-types/RDS.d.ts +199 -118
- package/dist-types/RDSClient.d.ts +3 -2
- package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +1 -6
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +1 -1
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +0 -3
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +11 -7
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +5 -9
- package/dist-types/commands/CreateDBClusterCommand.d.ts +11 -8
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +3 -3
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -5
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +8 -4
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +6 -3
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +6 -2
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +6 -2
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +6 -2
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +6 -2
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +0 -3
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +7 -3
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +9 -4
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +1 -1
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +16 -8
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +11 -7
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +9 -5
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +0 -3
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +0 -3
- package/dist-types/commands/RebootDBClusterCommand.d.ts +52 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +11 -4
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +7 -4
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +1 -1
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +8 -5
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +8 -4
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +546 -196
- package/dist-types/models/models_1.d.ts +690 -151
- 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 +38 -45
|
@@ -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>
|
|
@@ -1599,7 +1604,7 @@ export interface DescribeOrderableDBInstanceOptionsMessage {
|
|
|
1599
1604
|
* </li>
|
|
1600
1605
|
* <li>
|
|
1601
1606
|
* <p>
|
|
1602
|
-
* <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora)</p>
|
|
1607
|
+
* <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
|
|
1603
1608
|
* </li>
|
|
1604
1609
|
* <li>
|
|
1605
1610
|
* <p>
|
|
@@ -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
|
}
|
|
@@ -3050,7 +3082,7 @@ export interface ModifyCustomDBEngineVersionMessage {
|
|
|
3050
3082
|
Engine: string | undefined;
|
|
3051
3083
|
/**
|
|
3052
3084
|
* <p>The custom engine version (CEV) that you want to modify. This option is required for
|
|
3053
|
-
* RDS Custom, but optional for Amazon RDS. The combination of <code>Engine</code> and
|
|
3085
|
+
* RDS Custom for Oracle, but optional for Amazon RDS. The combination of <code>Engine</code> and
|
|
3054
3086
|
* <code>EngineVersion</code> is unique per customer per Amazon Web Services Region.</p>
|
|
3055
3087
|
*/
|
|
3056
3088
|
EngineVersion: string | undefined;
|
|
@@ -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 and MySQL 8.0-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,94 @@ 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>io1</code>
|
|
3437
|
+
* </p>
|
|
3438
|
+
* <p>
|
|
3439
|
+
* When specified, a value for the <code>Iops</code> parameter is required.
|
|
3440
|
+
* </p>
|
|
3441
|
+
* <p>
|
|
3442
|
+
* Default: <code>io1</code>
|
|
3443
|
+
* </p>
|
|
3444
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3445
|
+
*/
|
|
3446
|
+
StorageType?: string;
|
|
3447
|
+
/**
|
|
3448
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated
|
|
3449
|
+
* for each DB instance in the Multi-AZ DB cluster.</p>
|
|
3450
|
+
* <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>.
|
|
3451
|
+
* </p>
|
|
3452
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p>
|
|
3453
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3454
|
+
*/
|
|
3455
|
+
Iops?: number;
|
|
3456
|
+
/**
|
|
3457
|
+
* <p>A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
|
|
3458
|
+
* By default, minor engine upgrades are applied automatically.</p>
|
|
3459
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3460
|
+
*/
|
|
3461
|
+
AutoMinorVersionUpgrade?: boolean;
|
|
3462
|
+
/**
|
|
3463
|
+
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
|
3464
|
+
* To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.</p>
|
|
3465
|
+
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code>
|
|
3466
|
+
* to a value other than 0.</p>
|
|
3467
|
+
* <p>Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code>
|
|
3468
|
+
* </p>
|
|
3469
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3470
|
+
*/
|
|
3471
|
+
MonitoringInterval?: number;
|
|
3472
|
+
/**
|
|
3473
|
+
* <p>The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An
|
|
3474
|
+
* example is <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role,
|
|
3475
|
+
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To
|
|
3476
|
+
* create an IAM role for Amazon RDS Enhanced Monitoring</a> in the <i>Amazon RDS User Guide.</i>
|
|
3477
|
+
* </p>
|
|
3478
|
+
* <p>If <code>MonitoringInterval</code> is set to a value other than 0, supply a <code>MonitoringRoleArn</code> value.</p>
|
|
3479
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3480
|
+
*/
|
|
3481
|
+
MonitoringRoleArn?: string;
|
|
3482
|
+
/**
|
|
3483
|
+
* <p>A value that indicates whether to turn on Performance Insights for the DB cluster.</p>
|
|
3484
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
|
|
3485
|
+
* Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.
|
|
3486
|
+
* </p>
|
|
3487
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3488
|
+
*/
|
|
3489
|
+
EnablePerformanceInsights?: boolean;
|
|
3490
|
+
/**
|
|
3491
|
+
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
|
|
3492
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
3493
|
+
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
3494
|
+
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
3495
|
+
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
3496
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3497
|
+
*/
|
|
3498
|
+
PerformanceInsightsKMSKeyId?: string;
|
|
3499
|
+
/**
|
|
3500
|
+
* <p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p>
|
|
3501
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3502
|
+
*/
|
|
3503
|
+
PerformanceInsightsRetentionPeriod?: number;
|
|
3366
3504
|
}
|
|
3367
3505
|
export declare namespace ModifyDBClusterMessage {
|
|
3368
3506
|
/**
|
|
@@ -3372,11 +3510,28 @@ export declare namespace ModifyDBClusterMessage {
|
|
|
3372
3510
|
}
|
|
3373
3511
|
export interface ModifyDBClusterResult {
|
|
3374
3512
|
/**
|
|
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.
|
|
3513
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
3379
3514
|
* </p>
|
|
3515
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
3516
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
3517
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
3518
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
3519
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
3520
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
3521
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
3522
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
3523
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
3524
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
3525
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
3526
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
3527
|
+
* </p>
|
|
3528
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
3529
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
3530
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
3531
|
+
* </p>
|
|
3532
|
+
* <note>
|
|
3533
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
3534
|
+
* </note>
|
|
3380
3535
|
*/
|
|
3381
3536
|
DBCluster?: DBCluster;
|
|
3382
3537
|
}
|
|
@@ -3590,7 +3745,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3590
3745
|
*/
|
|
3591
3746
|
AllocatedStorage?: number;
|
|
3592
3747
|
/**
|
|
3593
|
-
* <p>The new compute and memory capacity of the DB instance, for example
|
|
3748
|
+
* <p>The new compute and memory capacity of the DB instance, for example db.m4.large.
|
|
3594
3749
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
|
|
3595
3750
|
* For the full list of DB instance classes,
|
|
3596
3751
|
* and availability for your engine, see
|
|
@@ -3600,7 +3755,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3600
3755
|
* The change is applied during the next maintenance window,
|
|
3601
3756
|
* unless <code>ApplyImmediately</code> is enabled for this request.
|
|
3602
3757
|
* </p>
|
|
3603
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3758
|
+
* <p>This setting doesn't apply to RDS Custom for Oracle.</p>
|
|
3604
3759
|
* <p>Default: Uses existing setting</p>
|
|
3605
3760
|
*/
|
|
3606
3761
|
DBInstanceClass?: string;
|
|
@@ -3652,19 +3807,14 @@ export interface ModifyDBInstanceMessage {
|
|
|
3652
3807
|
*/
|
|
3653
3808
|
VpcSecurityGroupIds?: string[];
|
|
3654
3809
|
/**
|
|
3655
|
-
* <p>A value that indicates whether the modifications in this request and
|
|
3656
|
-
*
|
|
3657
|
-
* as soon as possible, regardless of the
|
|
3658
|
-
* <code>PreferredMaintenanceWindow</code> setting for the DB instance. By default, this parameter is
|
|
3659
|
-
* disabled.
|
|
3660
|
-
* </p>
|
|
3810
|
+
* <p>A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible,
|
|
3811
|
+
* regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. By default, this parameter is disabled.</p>
|
|
3661
3812
|
* <p>
|
|
3662
|
-
* If this parameter is disabled, changes to the
|
|
3663
|
-
*
|
|
3664
|
-
*
|
|
3665
|
-
*
|
|
3666
|
-
*
|
|
3667
|
-
* or disabling <code>ApplyImmediately</code> for each modified parameter and to determine when the changes are applied.
|
|
3813
|
+
* If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage
|
|
3814
|
+
* and are applied on the next call to <a>RebootDBInstance</a>, or the next failure reboot. Review the table of parameters in
|
|
3815
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html">Modifying a DB Instance</a> in the
|
|
3816
|
+
* <i>Amazon RDS User Guide</i> to see the impact of enabling or disabling <code>ApplyImmediately</code> for each modified parameter and to
|
|
3817
|
+
* determine when the changes are applied.
|
|
3668
3818
|
* </p>
|
|
3669
3819
|
*/
|
|
3670
3820
|
ApplyImmediately?: boolean;
|
|
@@ -3751,7 +3901,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3751
3901
|
* <ul>
|
|
3752
3902
|
* <li>
|
|
3753
3903
|
* <p>It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to
|
|
3754
|
-
* read replicas. It can't be set to 0 or 35 for an RDS Custom DB instance.</p>
|
|
3904
|
+
* read replicas. It can't be set to 0 or 35 for an RDS Custom for Oracle DB instance.</p>
|
|
3755
3905
|
* </li>
|
|
3756
3906
|
* <li>
|
|
3757
3907
|
* <p>It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or
|
|
@@ -3837,7 +3987,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3837
3987
|
* default minor version if the current minor version is lower.
|
|
3838
3988
|
* For information about valid engine versions, see <code>CreateDBInstance</code>,
|
|
3839
3989
|
* or call <code>DescribeDBEngineVersions</code>.</p>
|
|
3840
|
-
* <p>In RDS Custom, this parameter is supported for read replicas only if they are in the
|
|
3990
|
+
* <p>In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
|
|
3841
3991
|
* <code>PATCH_DB_FAILURE</code> lifecycle.
|
|
3842
3992
|
* </p>
|
|
3843
3993
|
*/
|
|
@@ -4071,9 +4221,12 @@ export interface ModifyDBInstanceMessage {
|
|
|
4071
4221
|
/**
|
|
4072
4222
|
* <p>A value that indicates whether the DB instance is publicly accessible.
|
|
4073
4223
|
* </p>
|
|
4074
|
-
* <p>When the DB
|
|
4075
|
-
*
|
|
4076
|
-
*
|
|
4224
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
4225
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
4226
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
4227
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
4228
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
4229
|
+
* it.</p>
|
|
4077
4230
|
* <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
4231
|
* <p>
|
|
4079
4232
|
* <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a
|
|
@@ -4081,7 +4234,6 @@ export interface ModifyDBInstanceMessage {
|
|
|
4081
4234
|
* </p>
|
|
4082
4235
|
* <p>Changes to the <code>PubliclyAccessible</code> parameter are applied immediately regardless
|
|
4083
4236
|
* of the value of the <code>ApplyImmediately</code> parameter.</p>
|
|
4084
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4085
4237
|
*/
|
|
4086
4238
|
PubliclyAccessible?: boolean;
|
|
4087
4239
|
/**
|
|
@@ -4112,8 +4264,8 @@ export interface ModifyDBInstanceMessage {
|
|
|
4112
4264
|
*/
|
|
4113
4265
|
PromotionTier?: number;
|
|
4114
4266
|
/**
|
|
4115
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
4116
|
-
*
|
|
4267
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
4268
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
4117
4269
|
* <p>This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB
|
|
4118
4270
|
* cluster.</p>
|
|
4119
4271
|
* <p>For more information about IAM database authentication, see
|
|
@@ -4168,7 +4320,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
4168
4320
|
/**
|
|
4169
4321
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
4170
4322
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
4171
|
-
* deletion protection
|
|
4323
|
+
* deletion protection isn't enabled. For more information, see
|
|
4172
4324
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
4173
4325
|
* Deleting a DB Instance</a>.
|
|
4174
4326
|
* </p>
|
|
@@ -4265,7 +4417,11 @@ export interface ModifyDBInstanceResult {
|
|
|
4265
4417
|
/**
|
|
4266
4418
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
4267
4419
|
* </p>
|
|
4268
|
-
* <p>This data type is used as a response element in the <code>
|
|
4420
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
4421
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
4422
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
4423
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
4424
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
4269
4425
|
* </p>
|
|
4270
4426
|
*/
|
|
4271
4427
|
DBInstance?: DBInstance;
|
|
@@ -4310,17 +4466,20 @@ export interface ModifyDBParameterGroupMessage {
|
|
|
4310
4466
|
DBParameterGroupName: string | undefined;
|
|
4311
4467
|
/**
|
|
4312
4468
|
* <p>An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and
|
|
4313
|
-
* application method
|
|
4469
|
+
* application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.</p>
|
|
4314
4470
|
* <p>Valid Values (for the application method): <code>immediate | pending-reboot</code>
|
|
4315
4471
|
* </p>
|
|
4472
|
+
* <p>You can use the <code>immediate</code> value with dynamic parameters only. You can use the <code>pending-reboot</code> value for both dynamic
|
|
4473
|
+
* and static parameters.</p>
|
|
4474
|
+
* <p>When the application method is <code>immediate</code>, changes to dynamic parameters are applied immediately to the DB instances associated with
|
|
4475
|
+
* the parameter group.</p>
|
|
4476
|
+
* <p>When the application method is <code>pending-reboot</code>, changes to dynamic and static parameters are applied after a reboot without failover
|
|
4477
|
+
* to the DB instances associated with the parameter group.</p>
|
|
4316
4478
|
* <note>
|
|
4317
|
-
* <p>You can use
|
|
4318
|
-
* <code>pending-reboot</code> value for both dynamic and static parameters.</p>
|
|
4319
|
-
* <p>When the application method is <code>immediate</code>, changes to dynamic parameters are applied immediately
|
|
4320
|
-
* to the DB instances associated with the parameter group. When the application method is <code>pending-reboot</code>,
|
|
4321
|
-
* changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the
|
|
4322
|
-
* parameter group.</p>
|
|
4479
|
+
* <p>You can't use <code>pending-reboot</code> with dynamic parameters on RDS for SQL Server DB instances. Use <code>immediate</code>.</p>
|
|
4323
4480
|
* </note>
|
|
4481
|
+
* <p>For more information on modifying DB parameters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html">Working
|
|
4482
|
+
* with DB parameter groups</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
4324
4483
|
*/
|
|
4325
4484
|
Parameters: Parameter[] | undefined;
|
|
4326
4485
|
}
|
|
@@ -4823,7 +4982,7 @@ export interface ModifyGlobalClusterMessage {
|
|
|
4823
4982
|
* <p>
|
|
4824
4983
|
* <code>aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'</code>
|
|
4825
4984
|
* </p>
|
|
4826
|
-
* <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), use the following command:</p>
|
|
4985
|
+
* <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:</p>
|
|
4827
4986
|
* <p>
|
|
4828
4987
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'</code>
|
|
4829
4988
|
* </p>
|
|
@@ -5008,7 +5167,11 @@ export interface PromoteReadReplicaResult {
|
|
|
5008
5167
|
/**
|
|
5009
5168
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
5010
5169
|
* </p>
|
|
5011
|
-
* <p>This data type is used as a response element in the <code>
|
|
5170
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
5171
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
5172
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
5173
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
5174
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
5012
5175
|
* </p>
|
|
5013
5176
|
*/
|
|
5014
5177
|
DBInstance?: DBInstance;
|
|
@@ -5045,11 +5208,28 @@ export declare namespace PromoteReadReplicaDBClusterMessage {
|
|
|
5045
5208
|
}
|
|
5046
5209
|
export interface PromoteReadReplicaDBClusterResult {
|
|
5047
5210
|
/**
|
|
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.
|
|
5211
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
5052
5212
|
* </p>
|
|
5213
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
5214
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5215
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
5216
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
5217
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
5218
|
+
* <p>For a Multi-AZ 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>RebootDBCluster</code>,
|
|
5221
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
5222
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
5223
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
5224
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5225
|
+
* </p>
|
|
5226
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
5227
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
5228
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
5229
|
+
* </p>
|
|
5230
|
+
* <note>
|
|
5231
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
5232
|
+
* </note>
|
|
5053
5233
|
*/
|
|
5054
5234
|
DBCluster?: DBCluster;
|
|
5055
5235
|
}
|
|
@@ -5136,6 +5316,57 @@ export declare namespace ReservedDBInstanceQuotaExceededFault {
|
|
|
5136
5316
|
*/
|
|
5137
5317
|
const filterSensitiveLog: (obj: ReservedDBInstanceQuotaExceededFault) => any;
|
|
5138
5318
|
}
|
|
5319
|
+
export interface RebootDBClusterMessage {
|
|
5320
|
+
/**
|
|
5321
|
+
* <p>The DB cluster identifier. This parameter is stored as a lowercase string.</p>
|
|
5322
|
+
* <p>Constraints:</p>
|
|
5323
|
+
* <ul>
|
|
5324
|
+
* <li>
|
|
5325
|
+
* <p>Must match the identifier of an existing DBCluster.</p>
|
|
5326
|
+
* </li>
|
|
5327
|
+
* </ul>
|
|
5328
|
+
*/
|
|
5329
|
+
DBClusterIdentifier: string | undefined;
|
|
5330
|
+
}
|
|
5331
|
+
export declare namespace RebootDBClusterMessage {
|
|
5332
|
+
/**
|
|
5333
|
+
* @internal
|
|
5334
|
+
*/
|
|
5335
|
+
const filterSensitiveLog: (obj: RebootDBClusterMessage) => any;
|
|
5336
|
+
}
|
|
5337
|
+
export interface RebootDBClusterResult {
|
|
5338
|
+
/**
|
|
5339
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
5340
|
+
* </p>
|
|
5341
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
5342
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5343
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
5344
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
5345
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
5346
|
+
* <p>For a Multi-AZ 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>RebootDBCluster</code>,
|
|
5349
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
5350
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
5351
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
5352
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5353
|
+
* </p>
|
|
5354
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
5355
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
5356
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
5357
|
+
* </p>
|
|
5358
|
+
* <note>
|
|
5359
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
5360
|
+
* </note>
|
|
5361
|
+
*/
|
|
5362
|
+
DBCluster?: DBCluster;
|
|
5363
|
+
}
|
|
5364
|
+
export declare namespace RebootDBClusterResult {
|
|
5365
|
+
/**
|
|
5366
|
+
* @internal
|
|
5367
|
+
*/
|
|
5368
|
+
const filterSensitiveLog: (obj: RebootDBClusterResult) => any;
|
|
5369
|
+
}
|
|
5139
5370
|
/**
|
|
5140
5371
|
* <p></p>
|
|
5141
5372
|
*/
|
|
@@ -5168,7 +5399,11 @@ export interface RebootDBInstanceResult {
|
|
|
5168
5399
|
/**
|
|
5169
5400
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
5170
5401
|
* </p>
|
|
5171
|
-
* <p>This data type is used as a response element in the <code>
|
|
5402
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
5403
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
5404
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
5405
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
5406
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
5172
5407
|
* </p>
|
|
5173
5408
|
*/
|
|
5174
5409
|
DBInstance?: DBInstance;
|
|
@@ -5574,7 +5809,7 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5574
5809
|
DBSubnetGroupName?: string;
|
|
5575
5810
|
/**
|
|
5576
5811
|
* <p>The name of the database engine to be used for this DB cluster.</p>
|
|
5577
|
-
* <p>Valid Values: <code>aurora</code> (for MySQL 5.6-compatible Aurora), <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), and <code>aurora-postgresql</code>
|
|
5812
|
+
* <p>Valid Values: <code>aurora</code> (for MySQL 5.6-compatible Aurora), <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), and <code>aurora-postgresql</code>
|
|
5578
5813
|
* </p>
|
|
5579
5814
|
*/
|
|
5580
5815
|
Engine: string | undefined;
|
|
@@ -5584,7 +5819,7 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5584
5819
|
* <p>
|
|
5585
5820
|
* <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
|
|
5586
5821
|
* </p>
|
|
5587
|
-
* <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), use the following command:</p>
|
|
5822
|
+
* <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:</p>
|
|
5588
5823
|
* <p>
|
|
5589
5824
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
5590
5825
|
* </p>
|
|
@@ -5595,7 +5830,7 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5595
5830
|
* <p>
|
|
5596
5831
|
* <b>Aurora MySQL</b>
|
|
5597
5832
|
* </p>
|
|
5598
|
-
* <p>Example: <code>5.6.10a</code>, <code>5.6.mysql_aurora.1.19.2</code>, <code>5.7.12</code>, <code>5.7.mysql_aurora.2.04.5</code>
|
|
5833
|
+
* <p>Example: <code>5.6.10a</code>, <code>5.6.mysql_aurora.1.19.2</code>, <code>5.7.12</code>, <code>5.7.mysql_aurora.2.04.5</code>, <code>8.0.mysql_aurora.3.01.0</code>
|
|
5599
5834
|
* </p>
|
|
5600
5835
|
* <p>
|
|
5601
5836
|
* <b>Aurora PostgreSQL</b>
|
|
@@ -5703,7 +5938,8 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5703
5938
|
KmsKeyId?: string;
|
|
5704
5939
|
/**
|
|
5705
5940
|
* <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
|
|
5941
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
5942
|
+
* enabled.</p>
|
|
5707
5943
|
*
|
|
5708
5944
|
* <p>For more information, see
|
|
5709
5945
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
@@ -5766,7 +6002,7 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5766
6002
|
/**
|
|
5767
6003
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
5768
6004
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
5769
|
-
* deletion protection
|
|
6005
|
+
* deletion protection isn't enabled.
|
|
5770
6006
|
* </p>
|
|
5771
6007
|
*/
|
|
5772
6008
|
DeletionProtection?: boolean;
|
|
@@ -5798,11 +6034,28 @@ export declare namespace RestoreDBClusterFromS3Message {
|
|
|
5798
6034
|
}
|
|
5799
6035
|
export interface RestoreDBClusterFromS3Result {
|
|
5800
6036
|
/**
|
|
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.
|
|
6037
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
5805
6038
|
* </p>
|
|
6039
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
6040
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6041
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
6042
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
6043
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
6044
|
+
* <p>For a Multi-AZ 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>RebootDBCluster</code>,
|
|
6047
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
6048
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
6049
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
6050
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6051
|
+
* </p>
|
|
6052
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
6053
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
6054
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
6055
|
+
* </p>
|
|
6056
|
+
* <note>
|
|
6057
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
6058
|
+
* </note>
|
|
5806
6059
|
*/
|
|
5807
6060
|
DBCluster?: DBCluster;
|
|
5808
6061
|
}
|
|
@@ -5847,6 +6100,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5847
6100
|
/**
|
|
5848
6101
|
* <p>Provides the list of Availability Zones (AZs) where instances in the restored DB
|
|
5849
6102
|
* cluster can be created.</p>
|
|
6103
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
5850
6104
|
*/
|
|
5851
6105
|
AvailabilityZones?: string[];
|
|
5852
6106
|
/**
|
|
@@ -5866,6 +6120,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5866
6120
|
* </ul>
|
|
5867
6121
|
* <p>Example: <code>my-snapshot-id</code>
|
|
5868
6122
|
* </p>
|
|
6123
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5869
6124
|
*/
|
|
5870
6125
|
DBClusterIdentifier: string | undefined;
|
|
5871
6126
|
/**
|
|
@@ -5878,41 +6133,63 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5878
6133
|
* <p>Must match the identifier of an existing Snapshot.</p>
|
|
5879
6134
|
* </li>
|
|
5880
6135
|
* </ul>
|
|
6136
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5881
6137
|
*/
|
|
5882
6138
|
SnapshotIdentifier: string | undefined;
|
|
5883
6139
|
/**
|
|
5884
6140
|
* <p>The database engine to use for the new DB cluster.</p>
|
|
5885
6141
|
* <p>Default: The same as source</p>
|
|
5886
6142
|
* <p>Constraint: Must be compatible with the engine of the source</p>
|
|
6143
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5887
6144
|
*/
|
|
5888
6145
|
Engine: string | undefined;
|
|
5889
6146
|
/**
|
|
5890
6147
|
* <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
|
|
6148
|
+
* <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p>
|
|
5892
6149
|
* <p>
|
|
5893
6150
|
* <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
|
|
5894
6151
|
* </p>
|
|
5895
|
-
* <p>To list all of the available engine versions for
|
|
6152
|
+
* <p>To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:</p>
|
|
5896
6153
|
* <p>
|
|
5897
6154
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
5898
6155
|
* </p>
|
|
5899
|
-
* <p>To list all of the available engine versions for
|
|
6156
|
+
* <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p>
|
|
5900
6157
|
* <p>
|
|
5901
6158
|
* <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"</code>
|
|
5902
6159
|
* </p>
|
|
5903
|
-
* <
|
|
5904
|
-
*
|
|
5905
|
-
*
|
|
6160
|
+
* <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p>
|
|
6161
|
+
* <p>
|
|
6162
|
+
* <code>aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
6163
|
+
* </p>
|
|
6164
|
+
* <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p>
|
|
6165
|
+
* <p>
|
|
6166
|
+
* <code>aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"</code>
|
|
6167
|
+
* </p>
|
|
5906
6168
|
* <p>
|
|
5907
6169
|
* <b>Aurora MySQL</b>
|
|
5908
6170
|
* </p>
|
|
5909
|
-
* <p>
|
|
6171
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html">MySQL on Amazon RDS Versions</a> in the
|
|
6172
|
+
* <i>Amazon Aurora User Guide.</i>
|
|
5910
6173
|
* </p>
|
|
5911
6174
|
* <p>
|
|
5912
6175
|
* <b>Aurora PostgreSQL</b>
|
|
5913
6176
|
* </p>
|
|
5914
|
-
* <p>
|
|
6177
|
+
* <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
|
|
6178
|
+
* <i>Amazon Aurora User Guide.</i>
|
|
6179
|
+
* </p>
|
|
6180
|
+
* <p>
|
|
6181
|
+
* <b>MySQL</b>
|
|
6182
|
+
* </p>
|
|
6183
|
+
* <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
|
|
6184
|
+
* <i>Amazon RDS User Guide.</i>
|
|
6185
|
+
* </p>
|
|
6186
|
+
* <p>
|
|
6187
|
+
* <b>PostgreSQL</b>
|
|
5915
6188
|
* </p>
|
|
6189
|
+
* <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
|
|
6190
|
+
* <i>Amazon RDS User Guide.</i>
|
|
6191
|
+
* </p>
|
|
6192
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5916
6193
|
*/
|
|
5917
6194
|
EngineVersion?: string;
|
|
5918
6195
|
/**
|
|
@@ -5920,6 +6197,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5920
6197
|
* <p>Constraints: This value must be <code>1150-65535</code>
|
|
5921
6198
|
* </p>
|
|
5922
6199
|
* <p>Default: The same port as the original DB cluster.</p>
|
|
6200
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5923
6201
|
*/
|
|
5924
6202
|
Port?: number;
|
|
5925
6203
|
/**
|
|
@@ -5927,22 +6205,27 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5927
6205
|
* <p>Constraints: If supplied, must match the name of an existing DB subnet group.</p>
|
|
5928
6206
|
* <p>Example: <code>mySubnetgroup</code>
|
|
5929
6207
|
* </p>
|
|
6208
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5930
6209
|
*/
|
|
5931
6210
|
DBSubnetGroupName?: string;
|
|
5932
6211
|
/**
|
|
5933
6212
|
* <p>The database name for the restored DB cluster.</p>
|
|
6213
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5934
6214
|
*/
|
|
5935
6215
|
DatabaseName?: string;
|
|
5936
6216
|
/**
|
|
5937
6217
|
* <p>The name of the option group to use for the restored DB cluster.</p>
|
|
6218
|
+
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
5938
6219
|
*/
|
|
5939
6220
|
OptionGroupName?: string;
|
|
5940
6221
|
/**
|
|
5941
6222
|
* <p>A list of VPC security groups that the new DB cluster will belong to.</p>
|
|
6223
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5942
6224
|
*/
|
|
5943
6225
|
VpcSecurityGroupIds?: string[];
|
|
5944
6226
|
/**
|
|
5945
6227
|
* <p>The tags to be assigned to the restored DB cluster.</p>
|
|
6228
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5946
6229
|
*/
|
|
5947
6230
|
Tags?: Tag[];
|
|
5948
6231
|
/**
|
|
@@ -5965,16 +6248,18 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5965
6248
|
* isn't encrypted.</p>
|
|
5966
6249
|
* </li>
|
|
5967
6250
|
* </ul>
|
|
6251
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5968
6252
|
*/
|
|
5969
6253
|
KmsKeyId?: string;
|
|
5970
6254
|
/**
|
|
5971
6255
|
* <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
|
-
*
|
|
6256
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
6257
|
+
* enabled.</p>
|
|
5974
6258
|
* <p>For more information, see
|
|
5975
6259
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
5976
6260
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5977
6261
|
* </p>
|
|
6262
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
5978
6263
|
*/
|
|
5979
6264
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
5980
6265
|
/**
|
|
@@ -5990,13 +6275,15 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5990
6275
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
5991
6276
|
* </li>
|
|
5992
6277
|
* </ul>
|
|
6278
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
5993
6279
|
*/
|
|
5994
6280
|
BacktrackWindow?: number;
|
|
5995
6281
|
/**
|
|
5996
6282
|
* <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
|
-
*
|
|
6283
|
+
* The values in the list depend on the DB engine being used.</p>
|
|
6284
|
+
* <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
|
|
6285
|
+
* Aurora User Guide</i>.</p>
|
|
6286
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6000
6287
|
*/
|
|
6001
6288
|
EnableCloudwatchLogsExports?: string[];
|
|
6002
6289
|
/**
|
|
@@ -6004,10 +6291,12 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
6004
6291
|
* <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p>
|
|
6005
6292
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html">
|
|
6006
6293
|
* CreateDBCluster</a>.</p>
|
|
6294
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6007
6295
|
*/
|
|
6008
6296
|
EngineMode?: string;
|
|
6009
6297
|
/**
|
|
6010
6298
|
* <p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>
|
|
6299
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6011
6300
|
*/
|
|
6012
6301
|
ScalingConfiguration?: ScalingConfiguration;
|
|
6013
6302
|
/**
|
|
@@ -6029,17 +6318,19 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
6029
6318
|
* <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
|
|
6030
6319
|
* </li>
|
|
6031
6320
|
* </ul>
|
|
6321
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6032
6322
|
*/
|
|
6033
6323
|
DBClusterParameterGroupName?: string;
|
|
6034
6324
|
/**
|
|
6035
6325
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
6036
6326
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6037
|
-
* deletion protection
|
|
6038
|
-
* </p>
|
|
6327
|
+
* deletion protection isn't enabled.</p>
|
|
6328
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6039
6329
|
*/
|
|
6040
6330
|
DeletionProtection?: boolean;
|
|
6041
6331
|
/**
|
|
6042
6332
|
* <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>
|
|
6333
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6043
6334
|
*/
|
|
6044
6335
|
CopyTagsToSnapshot?: boolean;
|
|
6045
6336
|
/**
|
|
@@ -6047,14 +6338,76 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
6047
6338
|
* The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL
|
|
6048
6339
|
* Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.</p>
|
|
6049
6340
|
* <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
|
-
*
|
|
6341
|
+
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
6342
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6052
6343
|
*/
|
|
6053
6344
|
Domain?: string;
|
|
6054
6345
|
/**
|
|
6055
6346
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
6347
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6056
6348
|
*/
|
|
6057
6349
|
DomainIAMRoleName?: string;
|
|
6350
|
+
/**
|
|
6351
|
+
* <p>The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
|
6352
|
+
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p>
|
|
6353
|
+
* <p>For the full list of DB instance classes, and availability for your engine, see
|
|
6354
|
+
* <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>
|
|
6355
|
+
* </p>
|
|
6356
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6357
|
+
*/
|
|
6358
|
+
DBClusterInstanceClass?: string;
|
|
6359
|
+
/**
|
|
6360
|
+
* <p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p>
|
|
6361
|
+
* <p>
|
|
6362
|
+
* Valid values: <code>io1</code>
|
|
6363
|
+
* </p>
|
|
6364
|
+
* <p>
|
|
6365
|
+
* When specified, a value for the <code>Iops</code> parameter is required.
|
|
6366
|
+
* </p>
|
|
6367
|
+
* <p>
|
|
6368
|
+
* Default: <code>io1</code>
|
|
6369
|
+
* </p>
|
|
6370
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6371
|
+
*/
|
|
6372
|
+
StorageType?: string;
|
|
6373
|
+
/**
|
|
6374
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for
|
|
6375
|
+
* each DB instance in the Multi-AZ DB cluster.</p>
|
|
6376
|
+
* <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>.
|
|
6377
|
+
* </p>
|
|
6378
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.</p>
|
|
6379
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6380
|
+
*/
|
|
6381
|
+
Iops?: number;
|
|
6382
|
+
/**
|
|
6383
|
+
* <p>A value that indicates whether the DB cluster is publicly accessible.</p>
|
|
6384
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
6385
|
+
* 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.
|
|
6386
|
+
* Access to the DB cluster is ultimately controlled by the security group it uses.
|
|
6387
|
+
* That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.</p>
|
|
6388
|
+
* <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>
|
|
6389
|
+
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
|
|
6390
|
+
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6391
|
+
* <ul>
|
|
6392
|
+
* <li>
|
|
6393
|
+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6394
|
+
* </li>
|
|
6395
|
+
* <li>
|
|
6396
|
+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6397
|
+
* </li>
|
|
6398
|
+
* </ul>
|
|
6399
|
+
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6400
|
+
* <ul>
|
|
6401
|
+
* <li>
|
|
6402
|
+
* <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>
|
|
6403
|
+
* </li>
|
|
6404
|
+
* <li>
|
|
6405
|
+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6406
|
+
* </li>
|
|
6407
|
+
* </ul>
|
|
6408
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6409
|
+
*/
|
|
6410
|
+
PubliclyAccessible?: boolean;
|
|
6058
6411
|
}
|
|
6059
6412
|
export declare namespace RestoreDBClusterFromSnapshotMessage {
|
|
6060
6413
|
/**
|
|
@@ -6064,11 +6417,28 @@ export declare namespace RestoreDBClusterFromSnapshotMessage {
|
|
|
6064
6417
|
}
|
|
6065
6418
|
export interface RestoreDBClusterFromSnapshotResult {
|
|
6066
6419
|
/**
|
|
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.
|
|
6420
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
6071
6421
|
* </p>
|
|
6422
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
6423
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6424
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
6425
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
6426
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
6427
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
6428
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6429
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
6430
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
6431
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
6432
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
6433
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6434
|
+
* </p>
|
|
6435
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
6436
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
6437
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
6438
|
+
* </p>
|
|
6439
|
+
* <note>
|
|
6440
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
6441
|
+
* </note>
|
|
6072
6442
|
*/
|
|
6073
6443
|
DBCluster?: DBCluster;
|
|
6074
6444
|
}
|
|
@@ -6096,6 +6466,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6096
6466
|
* <p>Can't end with a hyphen or contain two consecutive hyphens</p>
|
|
6097
6467
|
* </li>
|
|
6098
6468
|
* </ul>
|
|
6469
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6099
6470
|
*/
|
|
6100
6471
|
DBClusterIdentifier: string | undefined;
|
|
6101
6472
|
/**
|
|
@@ -6115,6 +6486,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6115
6486
|
* <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
6487
|
* <p>If you don't specify a <code>RestoreType</code> value, then the new DB cluster is
|
|
6117
6488
|
* restored as a full copy of the source DB cluster.</p>
|
|
6489
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6118
6490
|
*/
|
|
6119
6491
|
RestoreType?: string;
|
|
6120
6492
|
/**
|
|
@@ -6125,6 +6497,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6125
6497
|
* <p>Must match the identifier of an existing DBCluster.</p>
|
|
6126
6498
|
* </li>
|
|
6127
6499
|
* </ul>
|
|
6500
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6128
6501
|
*/
|
|
6129
6502
|
SourceDBClusterIdentifier: string | undefined;
|
|
6130
6503
|
/**
|
|
@@ -6148,6 +6521,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6148
6521
|
* </ul>
|
|
6149
6522
|
* <p>Example: <code>2015-03-07T23:45:00Z</code>
|
|
6150
6523
|
* </p>
|
|
6524
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6151
6525
|
*/
|
|
6152
6526
|
RestoreToTime?: Date;
|
|
6153
6527
|
/**
|
|
@@ -6156,6 +6530,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6156
6530
|
* restorable backup time.
|
|
6157
6531
|
* </p>
|
|
6158
6532
|
* <p>Constraints: Can't be specified if <code>RestoreToTime</code> parameter is provided.</p>
|
|
6533
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6159
6534
|
*/
|
|
6160
6535
|
UseLatestRestorableTime?: boolean;
|
|
6161
6536
|
/**
|
|
@@ -6163,6 +6538,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6163
6538
|
* <p>Constraints: A value from <code>1150-65535</code>.
|
|
6164
6539
|
* </p>
|
|
6165
6540
|
* <p>Default: The default port for the engine.</p>
|
|
6541
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6166
6542
|
*/
|
|
6167
6543
|
Port?: number;
|
|
6168
6544
|
/**
|
|
@@ -6170,14 +6546,17 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6170
6546
|
* <p>Constraints: If supplied, must match the name of an existing DBSubnetGroup.</p>
|
|
6171
6547
|
* <p>Example: <code>mySubnetgroup</code>
|
|
6172
6548
|
* </p>
|
|
6549
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6173
6550
|
*/
|
|
6174
6551
|
DBSubnetGroupName?: string;
|
|
6175
6552
|
/**
|
|
6176
6553
|
* <p>The name of the option group for the new DB cluster.</p>
|
|
6554
|
+
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
6177
6555
|
*/
|
|
6178
6556
|
OptionGroupName?: string;
|
|
6179
6557
|
/**
|
|
6180
6558
|
* <p>A list of VPC security groups that the new DB cluster belongs to.</p>
|
|
6559
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6181
6560
|
*/
|
|
6182
6561
|
VpcSecurityGroupIds?: string[];
|
|
6183
6562
|
/**
|
|
@@ -6202,27 +6581,25 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6202
6581
|
* <p>If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.</p>
|
|
6203
6582
|
* </li>
|
|
6204
6583
|
* </ul>
|
|
6205
|
-
*
|
|
6206
6584
|
* <p>If <code>DBClusterIdentifier</code> refers to a DB cluster that isn't encrypted, then the restore request
|
|
6207
6585
|
* is rejected.</p>
|
|
6586
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6208
6587
|
*/
|
|
6209
6588
|
KmsKeyId?: string;
|
|
6210
6589
|
/**
|
|
6211
6590
|
* <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
|
-
*
|
|
6591
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
6592
|
+
* enabled.</p>
|
|
6214
6593
|
* <p>For more information, see
|
|
6215
6594
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
6216
6595
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6217
6596
|
* </p>
|
|
6597
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6218
6598
|
*/
|
|
6219
6599
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
6220
6600
|
/**
|
|
6221
6601
|
* <p>The target backtrack window, in seconds. To disable backtracking, set this value to
|
|
6222
6602
|
* 0.</p>
|
|
6223
|
-
* <note>
|
|
6224
|
-
* <p>Currently, Backtrack is only supported for Aurora MySQL DB clusters.</p>
|
|
6225
|
-
* </note>
|
|
6226
6603
|
* <p>Default: 0</p>
|
|
6227
6604
|
* <p>Constraints:</p>
|
|
6228
6605
|
* <ul>
|
|
@@ -6230,12 +6607,14 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6230
6607
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
6231
6608
|
* </li>
|
|
6232
6609
|
* </ul>
|
|
6610
|
+
* <p>Valid for: Aurora MySQL DB clusters only</p>
|
|
6233
6611
|
*/
|
|
6234
6612
|
BacktrackWindow?: number;
|
|
6235
6613
|
/**
|
|
6236
6614
|
* <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
|
-
*
|
|
6615
|
+
* in the list depend on the DB engine being used.</p>
|
|
6616
|
+
* <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>
|
|
6617
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6239
6618
|
*/
|
|
6240
6619
|
EnableCloudwatchLogsExports?: string[];
|
|
6241
6620
|
/**
|
|
@@ -6256,17 +6635,19 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6256
6635
|
* <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
|
|
6257
6636
|
* </li>
|
|
6258
6637
|
* </ul>
|
|
6638
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6259
6639
|
*/
|
|
6260
6640
|
DBClusterParameterGroupName?: string;
|
|
6261
6641
|
/**
|
|
6262
6642
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
6263
6643
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6264
|
-
* deletion protection
|
|
6265
|
-
* </p>
|
|
6644
|
+
* deletion protection isn't enabled.</p>
|
|
6645
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6266
6646
|
*/
|
|
6267
6647
|
DeletionProtection?: boolean;
|
|
6268
6648
|
/**
|
|
6269
6649
|
* <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>
|
|
6650
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6270
6651
|
*/
|
|
6271
6652
|
CopyTagsToSnapshot?: boolean;
|
|
6272
6653
|
/**
|
|
@@ -6278,14 +6659,17 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6278
6659
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html">Kerberos Authentication</a>
|
|
6279
6660
|
* in the <i>Amazon Aurora User Guide</i>.
|
|
6280
6661
|
* </p>
|
|
6662
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6281
6663
|
*/
|
|
6282
6664
|
Domain?: string;
|
|
6283
6665
|
/**
|
|
6284
6666
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
6667
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6285
6668
|
*/
|
|
6286
6669
|
DomainIAMRoleName?: string;
|
|
6287
6670
|
/**
|
|
6288
6671
|
* <p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>
|
|
6672
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6289
6673
|
*/
|
|
6290
6674
|
ScalingConfiguration?: ScalingConfiguration;
|
|
6291
6675
|
/**
|
|
@@ -6294,8 +6678,72 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6294
6678
|
* from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone
|
|
6295
6679
|
* that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or
|
|
6296
6680
|
* an encrypted provisioned cluster.</p>
|
|
6681
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6297
6682
|
*/
|
|
6298
6683
|
EngineMode?: string;
|
|
6684
|
+
/**
|
|
6685
|
+
* <p>The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,
|
|
6686
|
+
* for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services
|
|
6687
|
+
* Regions, or for all database engines.</p>
|
|
6688
|
+
* <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>
|
|
6689
|
+
* </p>
|
|
6690
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6691
|
+
*/
|
|
6692
|
+
DBClusterInstanceClass?: string;
|
|
6693
|
+
/**
|
|
6694
|
+
* <p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p>
|
|
6695
|
+
* <p>
|
|
6696
|
+
* Valid values: <code>io1</code>
|
|
6697
|
+
* </p>
|
|
6698
|
+
* <p>
|
|
6699
|
+
* When specified, a value for the <code>Iops</code> parameter is required.
|
|
6700
|
+
* </p>
|
|
6701
|
+
* <p>
|
|
6702
|
+
* Default: <code>io1</code>
|
|
6703
|
+
* </p>
|
|
6704
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6705
|
+
*/
|
|
6706
|
+
StorageType?: string;
|
|
6707
|
+
/**
|
|
6708
|
+
* <p>A value that indicates whether the DB cluster is publicly accessible.</p>
|
|
6709
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
6710
|
+
* from within the DB cluster's virtual private cloud (VPC). It resolves
|
|
6711
|
+
* to the public IP address from outside of the DB cluster's VPC.
|
|
6712
|
+
* Access to the DB cluster is ultimately controlled by the security group it uses.
|
|
6713
|
+
* That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.</p>
|
|
6714
|
+
* <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>
|
|
6715
|
+
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
|
|
6716
|
+
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6717
|
+
* <ul>
|
|
6718
|
+
* <li>
|
|
6719
|
+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6720
|
+
* </li>
|
|
6721
|
+
* <li>
|
|
6722
|
+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6723
|
+
* </li>
|
|
6724
|
+
* </ul>
|
|
6725
|
+
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6726
|
+
* <ul>
|
|
6727
|
+
* <li>
|
|
6728
|
+
* <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>
|
|
6729
|
+
* </li>
|
|
6730
|
+
* <li>
|
|
6731
|
+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6732
|
+
* </li>
|
|
6733
|
+
* </ul>
|
|
6734
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6735
|
+
*/
|
|
6736
|
+
PubliclyAccessible?: boolean;
|
|
6737
|
+
/**
|
|
6738
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for
|
|
6739
|
+
* each DB instance in the Multi-AZ DB cluster.</p>
|
|
6740
|
+
* <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>.
|
|
6741
|
+
* </p>
|
|
6742
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
|
|
6743
|
+
* </p>
|
|
6744
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6745
|
+
*/
|
|
6746
|
+
Iops?: number;
|
|
6299
6747
|
}
|
|
6300
6748
|
export declare namespace RestoreDBClusterToPointInTimeMessage {
|
|
6301
6749
|
/**
|
|
@@ -6305,11 +6753,28 @@ export declare namespace RestoreDBClusterToPointInTimeMessage {
|
|
|
6305
6753
|
}
|
|
6306
6754
|
export interface RestoreDBClusterToPointInTimeResult {
|
|
6307
6755
|
/**
|
|
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.
|
|
6756
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
6312
6757
|
* </p>
|
|
6758
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
6759
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6760
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
6761
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
6762
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
6763
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
6764
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6765
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
6766
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
6767
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
6768
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
6769
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6770
|
+
* </p>
|
|
6771
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
6772
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
6773
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
6774
|
+
* </p>
|
|
6775
|
+
* <note>
|
|
6776
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
6777
|
+
* </note>
|
|
6313
6778
|
*/
|
|
6314
6779
|
DBCluster?: DBCluster;
|
|
6315
6780
|
}
|
|
@@ -6356,7 +6821,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6356
6821
|
*/
|
|
6357
6822
|
DBSnapshotIdentifier: string | undefined;
|
|
6358
6823
|
/**
|
|
6359
|
-
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
6824
|
+
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.
|
|
6360
6825
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
|
|
6361
6826
|
* For the full list of DB instance classes,
|
|
6362
6827
|
* and availability for your engine, see
|
|
@@ -6395,9 +6860,10 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6395
6860
|
MultiAZ?: boolean;
|
|
6396
6861
|
/**
|
|
6397
6862
|
* <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
|
-
*
|
|
6863
|
+
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
6864
|
+
* from within the DB instance's virtual private cloud (VPC).
|
|
6865
|
+
* It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled
|
|
6866
|
+
* 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
6867
|
* <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
6868
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
6403
6869
|
*/
|
|
@@ -6624,7 +7090,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6624
7090
|
/**
|
|
6625
7091
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
6626
7092
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6627
|
-
* deletion protection
|
|
7093
|
+
* deletion protection isn't enabled. For more information, see
|
|
6628
7094
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
6629
7095
|
* Deleting a DB Instance</a>.
|
|
6630
7096
|
* </p>
|
|
@@ -6664,6 +7130,13 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6664
7130
|
* <p>This setting is required for RDS Custom.</p>
|
|
6665
7131
|
*/
|
|
6666
7132
|
CustomIamInstanceProfile?: string;
|
|
7133
|
+
/**
|
|
7134
|
+
* <p>Specifies where automated backups and manual snapshots are stored for the restored DB instance.</p>
|
|
7135
|
+
* <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>
|
|
7136
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working
|
|
7137
|
+
* with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
7138
|
+
*/
|
|
7139
|
+
BackupTarget?: string;
|
|
6667
7140
|
}
|
|
6668
7141
|
export declare namespace RestoreDBInstanceFromDBSnapshotMessage {
|
|
6669
7142
|
/**
|
|
@@ -6675,7 +7148,11 @@ export interface RestoreDBInstanceFromDBSnapshotResult {
|
|
|
6675
7148
|
/**
|
|
6676
7149
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
6677
7150
|
* </p>
|
|
6678
|
-
* <p>This data type is used as a response element in the <code>
|
|
7151
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
7152
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
7153
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
7154
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
7155
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
6679
7156
|
* </p>
|
|
6680
7157
|
*/
|
|
6681
7158
|
DBInstance?: DBInstance;
|
|
@@ -6730,7 +7207,7 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6730
7207
|
AllocatedStorage?: number;
|
|
6731
7208
|
/**
|
|
6732
7209
|
* <p>The compute and memory capacity of the DB instance,
|
|
6733
|
-
* for example
|
|
7210
|
+
* for example db.m4.large.
|
|
6734
7211
|
* Not all DB instance classes are available in all Amazon Web Services Regions,
|
|
6735
7212
|
* or for all database engines.
|
|
6736
7213
|
* For the full list of DB instance classes,
|
|
@@ -6919,9 +7396,11 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6919
7396
|
OptionGroupName?: string;
|
|
6920
7397
|
/**
|
|
6921
7398
|
* <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
|
-
*
|
|
7399
|
+
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
7400
|
+
* from within the DB instance's virtual private cloud (VPC).
|
|
7401
|
+
* It resolves to the public IP address from outside of the DB instance's VPC.
|
|
7402
|
+
* Access to the DB instance is ultimately controlled by the security group it uses.
|
|
7403
|
+
* That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
|
|
6925
7404
|
* <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
7405
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
6927
7406
|
*/
|
|
@@ -6998,8 +7477,8 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6998
7477
|
*/
|
|
6999
7478
|
MonitoringRoleArn?: string;
|
|
7000
7479
|
/**
|
|
7001
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
7002
|
-
*
|
|
7480
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
7481
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
7003
7482
|
*
|
|
7004
7483
|
* <p>For more information about IAM database authentication, see
|
|
7005
7484
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
@@ -7078,7 +7557,7 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
7078
7557
|
/**
|
|
7079
7558
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
7080
7559
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
7081
|
-
* deletion protection
|
|
7560
|
+
* deletion protection isn't enabled. For more information, see
|
|
7082
7561
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
7083
7562
|
* Deleting a DB Instance</a>.
|
|
7084
7563
|
* </p>
|
|
@@ -7103,7 +7582,11 @@ export interface RestoreDBInstanceFromS3Result {
|
|
|
7103
7582
|
/**
|
|
7104
7583
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7105
7584
|
* </p>
|
|
7106
|
-
* <p>This data type is used as a response element in the <code>
|
|
7585
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
7586
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
7587
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
7588
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
7589
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7107
7590
|
* </p>
|
|
7108
7591
|
*/
|
|
7109
7592
|
DBInstance?: DBInstance;
|
|
@@ -7187,12 +7670,12 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7187
7670
|
*/
|
|
7188
7671
|
UseLatestRestorableTime?: boolean;
|
|
7189
7672
|
/**
|
|
7190
|
-
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
7191
|
-
*
|
|
7192
|
-
*
|
|
7193
|
-
*
|
|
7194
|
-
*
|
|
7195
|
-
*
|
|
7673
|
+
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
7674
|
+
* db.m4.large. Not all DB instance classes are available in all Amazon Web Services
|
|
7675
|
+
* Regions, or for all database engines. For the full list of DB instance classes, and
|
|
7676
|
+
* availability for your engine, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB Instance
|
|
7677
|
+
* Class</a> in the <i>Amazon RDS User Guide.</i>
|
|
7678
|
+
* </p>
|
|
7196
7679
|
* <p>Default: The same DBInstanceClass as the original DB instance.</p>
|
|
7197
7680
|
*/
|
|
7198
7681
|
DBInstanceClass?: string;
|
|
@@ -7227,9 +7710,12 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7227
7710
|
MultiAZ?: boolean;
|
|
7228
7711
|
/**
|
|
7229
7712
|
* <p>A value that indicates whether the DB instance is publicly accessible.</p>
|
|
7230
|
-
* <p>When the DB
|
|
7231
|
-
*
|
|
7232
|
-
*
|
|
7713
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
7714
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
7715
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
7716
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
7717
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
7718
|
+
* it.</p>
|
|
7233
7719
|
* <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
7720
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
7235
7721
|
*/
|
|
@@ -7399,8 +7885,8 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7399
7885
|
*/
|
|
7400
7886
|
DomainIAMRoleName?: string;
|
|
7401
7887
|
/**
|
|
7402
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
7403
|
-
*
|
|
7888
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
7889
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
7404
7890
|
*
|
|
7405
7891
|
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7406
7892
|
*
|
|
@@ -7452,7 +7938,7 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7452
7938
|
/**
|
|
7453
7939
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
7454
7940
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
7455
|
-
* deletion protection
|
|
7941
|
+
* deletion protection isn't enabled. For more information, see
|
|
7456
7942
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
7457
7943
|
* Deleting a DB Instance</a>.
|
|
7458
7944
|
* </p>
|
|
@@ -7511,6 +7997,13 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7511
7997
|
* <p>This setting is required for RDS Custom.</p>
|
|
7512
7998
|
*/
|
|
7513
7999
|
CustomIamInstanceProfile?: string;
|
|
8000
|
+
/**
|
|
8001
|
+
* <p>Specifies where automated backups and manual snapshots are stored for the restored DB instance.</p>
|
|
8002
|
+
* <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>
|
|
8003
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working
|
|
8004
|
+
* with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
8005
|
+
*/
|
|
8006
|
+
BackupTarget?: string;
|
|
7514
8007
|
}
|
|
7515
8008
|
export declare namespace RestoreDBInstanceToPointInTimeMessage {
|
|
7516
8009
|
/**
|
|
@@ -7522,7 +8015,11 @@ export interface RestoreDBInstanceToPointInTimeResult {
|
|
|
7522
8015
|
/**
|
|
7523
8016
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7524
8017
|
* </p>
|
|
7525
|
-
* <p>This data type is used as a response element in the <code>
|
|
8018
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
8019
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
8020
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
8021
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
8022
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7526
8023
|
* </p>
|
|
7527
8024
|
*/
|
|
7528
8025
|
DBInstance?: DBInstance;
|
|
@@ -7682,11 +8179,28 @@ export declare namespace StartDBClusterMessage {
|
|
|
7682
8179
|
}
|
|
7683
8180
|
export interface StartDBClusterResult {
|
|
7684
8181
|
/**
|
|
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.
|
|
8182
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
7689
8183
|
* </p>
|
|
8184
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
8185
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8186
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
8187
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
8188
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
8189
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
8190
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8191
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
8192
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
8193
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
8194
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
8195
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
8196
|
+
* </p>
|
|
8197
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
8198
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
8199
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
8200
|
+
* </p>
|
|
8201
|
+
* <note>
|
|
8202
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
8203
|
+
* </note>
|
|
7690
8204
|
*/
|
|
7691
8205
|
DBCluster?: DBCluster;
|
|
7692
8206
|
}
|
|
@@ -7714,7 +8228,11 @@ export interface StartDBInstanceResult {
|
|
|
7714
8228
|
/**
|
|
7715
8229
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7716
8230
|
* </p>
|
|
7717
|
-
* <p>This data type is used as a response element in the <code>
|
|
8231
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
8232
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
8233
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
8234
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
8235
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7718
8236
|
* </p>
|
|
7719
8237
|
*/
|
|
7720
8238
|
DBInstance?: DBInstance;
|
|
@@ -7989,11 +8507,28 @@ export declare namespace StopDBClusterMessage {
|
|
|
7989
8507
|
}
|
|
7990
8508
|
export interface StopDBClusterResult {
|
|
7991
8509
|
/**
|
|
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.
|
|
8510
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
7996
8511
|
* </p>
|
|
8512
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
8513
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8514
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
8515
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
8516
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
8517
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
8518
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8519
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
8520
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
8521
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
8522
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
8523
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
8524
|
+
* </p>
|
|
8525
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
8526
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
8527
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
8528
|
+
* </p>
|
|
8529
|
+
* <note>
|
|
8530
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
8531
|
+
* </note>
|
|
7997
8532
|
*/
|
|
7998
8533
|
DBCluster?: DBCluster;
|
|
7999
8534
|
}
|
|
@@ -8027,7 +8562,11 @@ export interface StopDBInstanceResult {
|
|
|
8027
8562
|
/**
|
|
8028
8563
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
8029
8564
|
* </p>
|
|
8030
|
-
* <p>This data type is used as a response element in the <code>
|
|
8565
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
8566
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
8567
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
8568
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
8569
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
8031
8570
|
* </p>
|
|
8032
8571
|
*/
|
|
8033
8572
|
DBInstance?: DBInstance;
|