@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
|
@@ -156,7 +156,7 @@ export interface AddRoleToDBClusterMessage {
|
|
|
156
156
|
DBClusterIdentifier: string | undefined;
|
|
157
157
|
/**
|
|
158
158
|
* <p>The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB
|
|
159
|
-
* cluster, for example
|
|
159
|
+
* cluster, for example <code>arn:aws:iam::123456789012:role/AuroraAccessRole</code>.</p>
|
|
160
160
|
*/
|
|
161
161
|
RoleArn: string | undefined;
|
|
162
162
|
/**
|
|
@@ -1470,7 +1470,24 @@ export interface DBClusterSnapshot {
|
|
|
1470
1470
|
*/
|
|
1471
1471
|
AllocatedStorage?: number;
|
|
1472
1472
|
/**
|
|
1473
|
-
* <p>Specifies the status of this DB cluster snapshot
|
|
1473
|
+
* <p>Specifies the status of this DB cluster snapshot. Valid statuses are the following:</p>
|
|
1474
|
+
* <ul>
|
|
1475
|
+
* <li>
|
|
1476
|
+
* <p>
|
|
1477
|
+
* <code>available</code>
|
|
1478
|
+
* </p>
|
|
1479
|
+
* </li>
|
|
1480
|
+
* <li>
|
|
1481
|
+
* <p>
|
|
1482
|
+
* <code>copying</code>
|
|
1483
|
+
* </p>
|
|
1484
|
+
* </li>
|
|
1485
|
+
* <li>
|
|
1486
|
+
* <p>
|
|
1487
|
+
* <code>creating</code>
|
|
1488
|
+
* </p>
|
|
1489
|
+
* </li>
|
|
1490
|
+
* </ul>
|
|
1474
1491
|
*/
|
|
1475
1492
|
Status?: string;
|
|
1476
1493
|
/**
|
|
@@ -2143,6 +2160,10 @@ export interface DBSnapshot {
|
|
|
2143
2160
|
* <p>Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.</p>
|
|
2144
2161
|
*/
|
|
2145
2162
|
OriginalSnapshotCreateTime?: Date;
|
|
2163
|
+
/**
|
|
2164
|
+
* <p>Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.</p>
|
|
2165
|
+
*/
|
|
2166
|
+
SnapshotTarget?: string;
|
|
2146
2167
|
}
|
|
2147
2168
|
export declare namespace DBSnapshot {
|
|
2148
2169
|
/**
|
|
@@ -2681,7 +2702,7 @@ export interface CreateCustomDBEngineVersionMessage {
|
|
|
2681
2702
|
/**
|
|
2682
2703
|
* <p>The name of your CEV. The name format is <code>19.<i>customized_string</i>
|
|
2683
2704
|
* </code>. For example,
|
|
2684
|
-
* a valid name is <code>19.my_cev1</code>. This setting is required for RDS Custom, but optional for Amazon RDS.
|
|
2705
|
+
* a valid name is <code>19.my_cev1</code>. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS.
|
|
2685
2706
|
* The combination of <code>Engine</code> and <code>EngineVersion</code> is unique per customer per Region.</p>
|
|
2686
2707
|
*/
|
|
2687
2708
|
EngineVersion: string | undefined;
|
|
@@ -3075,11 +3096,12 @@ export declare namespace ScalingConfiguration {
|
|
|
3075
3096
|
*/
|
|
3076
3097
|
export interface CreateDBClusterMessage {
|
|
3077
3098
|
/**
|
|
3078
|
-
* <p>A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
|
3079
|
-
*
|
|
3080
|
-
*
|
|
3081
|
-
*
|
|
3082
|
-
*
|
|
3099
|
+
* <p>A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
|
|
3100
|
+
* </p>
|
|
3101
|
+
* <p>For information on Amazon Web Services Regions and Availability Zones, see
|
|
3102
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html">Choosing the Regions and
|
|
3103
|
+
* Availability Zones</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3104
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3083
3105
|
*/
|
|
3084
3106
|
AvailabilityZones?: string[];
|
|
3085
3107
|
/**
|
|
@@ -3091,16 +3113,19 @@ export interface CreateDBClusterMessage {
|
|
|
3091
3113
|
* <p>Must be a value from 1 to 35</p>
|
|
3092
3114
|
* </li>
|
|
3093
3115
|
* </ul>
|
|
3116
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3094
3117
|
*/
|
|
3095
3118
|
BackupRetentionPeriod?: number;
|
|
3096
3119
|
/**
|
|
3097
3120
|
* <p>A value that indicates that the DB cluster should be associated with the specified CharacterSet.</p>
|
|
3121
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3098
3122
|
*/
|
|
3099
3123
|
CharacterSetName?: string;
|
|
3100
3124
|
/**
|
|
3101
3125
|
* <p>The name for your database of up to 64 alphanumeric characters. If you do not
|
|
3102
3126
|
* provide a name, Amazon RDS doesn't create a database in the DB cluster you are
|
|
3103
3127
|
* creating.</p>
|
|
3128
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3104
3129
|
*/
|
|
3105
3130
|
DatabaseName?: string;
|
|
3106
3131
|
/**
|
|
@@ -3119,6 +3144,7 @@ export interface CreateDBClusterMessage {
|
|
|
3119
3144
|
* </ul>
|
|
3120
3145
|
* <p>Example: <code>my-cluster1</code>
|
|
3121
3146
|
* </p>
|
|
3147
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3122
3148
|
*/
|
|
3123
3149
|
DBClusterIdentifier: string | undefined;
|
|
3124
3150
|
/**
|
|
@@ -3133,56 +3159,124 @@ export interface CreateDBClusterMessage {
|
|
|
3133
3159
|
* <p>If supplied, must match the name of an existing DB cluster parameter group.</p>
|
|
3134
3160
|
* </li>
|
|
3135
3161
|
* </ul>
|
|
3162
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3136
3163
|
*/
|
|
3137
3164
|
DBClusterParameterGroupName?: string;
|
|
3138
3165
|
/**
|
|
3139
3166
|
* <p>A list of EC2 VPC security groups to associate with this DB cluster.</p>
|
|
3167
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3140
3168
|
*/
|
|
3141
3169
|
VpcSecurityGroupIds?: string[];
|
|
3142
3170
|
/**
|
|
3143
3171
|
* <p>A DB subnet group to associate with this DB cluster.</p>
|
|
3172
|
+
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3144
3173
|
* <p>Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.</p>
|
|
3145
3174
|
* <p>Example: <code>mySubnetgroup</code>
|
|
3146
3175
|
* </p>
|
|
3176
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3147
3177
|
*/
|
|
3148
3178
|
DBSubnetGroupName?: string;
|
|
3149
3179
|
/**
|
|
3150
3180
|
* <p>The name of the database engine to be used for this DB cluster.</p>
|
|
3151
|
-
* <p>Valid Values
|
|
3152
|
-
*
|
|
3181
|
+
* <p>Valid Values:</p>
|
|
3182
|
+
* <ul>
|
|
3183
|
+
* <li>
|
|
3184
|
+
* <p>
|
|
3185
|
+
* <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p>
|
|
3186
|
+
* </li>
|
|
3187
|
+
* <li>
|
|
3188
|
+
* <p>
|
|
3189
|
+
* <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
|
|
3190
|
+
* </li>
|
|
3191
|
+
* <li>
|
|
3192
|
+
* <p>
|
|
3193
|
+
* <code>aurora-postgresql</code>
|
|
3194
|
+
* </p>
|
|
3195
|
+
* </li>
|
|
3196
|
+
* <li>
|
|
3197
|
+
* <p>
|
|
3198
|
+
* <code>mysql</code>
|
|
3199
|
+
* </p>
|
|
3200
|
+
* </li>
|
|
3201
|
+
* <li>
|
|
3202
|
+
* <p>
|
|
3203
|
+
* <code>postgres</code>
|
|
3204
|
+
* </p>
|
|
3205
|
+
* </li>
|
|
3206
|
+
* </ul>
|
|
3207
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3153
3208
|
*/
|
|
3154
3209
|
Engine: string | undefined;
|
|
3155
3210
|
/**
|
|
3156
3211
|
* <p>The version number of the database engine to use.</p>
|
|
3157
|
-
* <p>To list all of the available engine versions for
|
|
3212
|
+
* <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p>
|
|
3158
3213
|
* <p>
|
|
3159
3214
|
* <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
|
|
3160
3215
|
* </p>
|
|
3161
|
-
* <p>To list all of the available engine versions for
|
|
3216
|
+
* <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>
|
|
3162
3217
|
* <p>
|
|
3163
3218
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
3164
3219
|
* </p>
|
|
3165
|
-
* <p>To list all of the available engine versions for
|
|
3220
|
+
* <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p>
|
|
3166
3221
|
* <p>
|
|
3167
3222
|
* <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"</code>
|
|
3168
3223
|
* </p>
|
|
3224
|
+
* <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p>
|
|
3225
|
+
* <p>
|
|
3226
|
+
* <code>aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
3227
|
+
* </p>
|
|
3228
|
+
* <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p>
|
|
3229
|
+
* <p>
|
|
3230
|
+
* <code>aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"</code>
|
|
3231
|
+
* </p>
|
|
3169
3232
|
* <p>
|
|
3170
3233
|
* <b>Aurora MySQL</b>
|
|
3171
3234
|
* </p>
|
|
3172
|
-
* <p>
|
|
3235
|
+
* <p>For information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html">MySQL on Amazon RDS Versions</a> in the
|
|
3236
|
+
* <i>Amazon Aurora User Guide.</i>
|
|
3173
3237
|
* </p>
|
|
3174
3238
|
* <p>
|
|
3175
3239
|
* <b>Aurora PostgreSQL</b>
|
|
3176
3240
|
* </p>
|
|
3177
|
-
* <p>
|
|
3241
|
+
* <p>For information, 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
|
|
3242
|
+
* <i>Amazon Aurora User Guide.</i>
|
|
3243
|
+
* </p>
|
|
3244
|
+
* <p>
|
|
3245
|
+
* <b>MySQL</b>
|
|
3246
|
+
* </p>
|
|
3247
|
+
* <p>For information, 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
|
|
3248
|
+
* <i>Amazon RDS User Guide.</i>
|
|
3249
|
+
* </p>
|
|
3250
|
+
* <p>
|
|
3251
|
+
* <b>PostgreSQL</b>
|
|
3252
|
+
* </p>
|
|
3253
|
+
* <p>For information, 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
|
|
3254
|
+
* <i>Amazon RDS User Guide.</i>
|
|
3178
3255
|
* </p>
|
|
3256
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3179
3257
|
*/
|
|
3180
3258
|
EngineVersion?: string;
|
|
3181
3259
|
/**
|
|
3182
3260
|
* <p>The port number on which the instances in the DB cluster accept connections.</p>
|
|
3183
3261
|
* <p>
|
|
3184
|
-
*
|
|
3185
|
-
*
|
|
3262
|
+
* <b>RDS for MySQL and Aurora MySQL</b>
|
|
3263
|
+
* </p>
|
|
3264
|
+
* <p>
|
|
3265
|
+
* Default: <code>3306</code>
|
|
3266
|
+
* </p>
|
|
3267
|
+
* <p>
|
|
3268
|
+
* Valid values: <code>1150-65535</code>
|
|
3269
|
+
* </p>
|
|
3270
|
+
* <p>
|
|
3271
|
+
* <b>RDS for PostgreSQL and Aurora PostgreSQL</b>
|
|
3272
|
+
* </p>
|
|
3273
|
+
* <p>
|
|
3274
|
+
* Default: <code>5432</code>
|
|
3275
|
+
* </p>
|
|
3276
|
+
* <p>
|
|
3277
|
+
* Valid values: <code>1150-65535</code>
|
|
3278
|
+
* </p>
|
|
3279
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3186
3280
|
*/
|
|
3187
3281
|
Port?: number;
|
|
3188
3282
|
/**
|
|
@@ -3199,16 +3293,18 @@ export interface CreateDBClusterMessage {
|
|
|
3199
3293
|
* <p>Can't be a reserved word for the chosen database engine.</p>
|
|
3200
3294
|
* </li>
|
|
3201
3295
|
* </ul>
|
|
3296
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3202
3297
|
*/
|
|
3203
3298
|
MasterUsername?: string;
|
|
3204
3299
|
/**
|
|
3205
3300
|
* <p>The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".</p>
|
|
3206
3301
|
* <p>Constraints: Must contain from 8 to 41 characters.</p>
|
|
3302
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3207
3303
|
*/
|
|
3208
3304
|
MasterUserPassword?: string;
|
|
3209
3305
|
/**
|
|
3210
3306
|
* <p>A value that indicates that the DB cluster should be associated with the specified option group.</p>
|
|
3211
|
-
* <p>
|
|
3307
|
+
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
3212
3308
|
*/
|
|
3213
3309
|
OptionGroupName?: string;
|
|
3214
3310
|
/**
|
|
@@ -3237,6 +3333,7 @@ export interface CreateDBClusterMessage {
|
|
|
3237
3333
|
* <p>Must be at least 30 minutes.</p>
|
|
3238
3334
|
* </li>
|
|
3239
3335
|
* </ul>
|
|
3336
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3240
3337
|
*/
|
|
3241
3338
|
PreferredBackupWindow?: string;
|
|
3242
3339
|
/**
|
|
@@ -3251,19 +3348,23 @@ export interface CreateDBClusterMessage {
|
|
|
3251
3348
|
* </p>
|
|
3252
3349
|
* <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p>
|
|
3253
3350
|
* <p>Constraints: Minimum 30-minute window.</p>
|
|
3351
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3254
3352
|
*/
|
|
3255
3353
|
PreferredMaintenanceWindow?: string;
|
|
3256
3354
|
/**
|
|
3257
3355
|
* <p>The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB
|
|
3258
3356
|
* cluster is created as a read replica.</p>
|
|
3357
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3259
3358
|
*/
|
|
3260
3359
|
ReplicationSourceIdentifier?: string;
|
|
3261
3360
|
/**
|
|
3262
3361
|
* <p>Tags to assign to the DB cluster.</p>
|
|
3362
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3263
3363
|
*/
|
|
3264
3364
|
Tags?: Tag[];
|
|
3265
3365
|
/**
|
|
3266
3366
|
* <p>A value that indicates whether the DB cluster is encrypted.</p>
|
|
3367
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3267
3368
|
*/
|
|
3268
3369
|
StorageEncrypted?: boolean;
|
|
3269
3370
|
/**
|
|
@@ -3288,13 +3389,13 @@ export interface CreateDBClusterMessage {
|
|
|
3288
3389
|
* <p>If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you
|
|
3289
3390
|
* must set <code>KmsKeyId</code> to a KMS key identifier that is valid in the destination Amazon Web Services
|
|
3290
3391
|
* Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.</p>
|
|
3392
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3291
3393
|
*/
|
|
3292
3394
|
KmsKeyId?: string;
|
|
3293
3395
|
/**
|
|
3294
3396
|
* <p>A URL that contains a Signature Version 4 signed request for
|
|
3295
3397
|
* the <code>CreateDBCluster</code> action to be called in the source Amazon Web Services Region where the DB cluster is replicated from.
|
|
3296
|
-
*
|
|
3297
|
-
*
|
|
3398
|
+
* Specify <code>PreSignedUrl</code> only when you are performing cross-Region replication from an encrypted DB cluster.</p>
|
|
3298
3399
|
* <p>The pre-signed URL must be a valid request for the <code>CreateDBCluster</code> API action
|
|
3299
3400
|
* that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.</p>
|
|
3300
3401
|
* <p>The pre-signed URL request must contain the following parameter values:</p>
|
|
@@ -3318,7 +3419,6 @@ export interface CreateDBClusterMessage {
|
|
|
3318
3419
|
* Example: <code>arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1</code>.</p>
|
|
3319
3420
|
* </li>
|
|
3320
3421
|
* </ul>
|
|
3321
|
-
*
|
|
3322
3422
|
* <p>To learn how to generate a Signature Version 4 signed request, see
|
|
3323
3423
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html">
|
|
3324
3424
|
* Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and
|
|
@@ -3329,24 +3429,24 @@ export interface CreateDBClusterMessage {
|
|
|
3329
3429
|
* instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid
|
|
3330
3430
|
* request for the operation that can be executed in the source Amazon Web Services Region.</p>
|
|
3331
3431
|
* </note>
|
|
3432
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3332
3433
|
*/
|
|
3333
3434
|
PreSignedUrl?: string;
|
|
3334
3435
|
/**
|
|
3335
3436
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
3336
|
-
* Management (IAM) accounts to database accounts. By default, mapping
|
|
3337
|
-
*
|
|
3437
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
3438
|
+
* enabled.</p>
|
|
3338
3439
|
* <p>For more information, see
|
|
3339
3440
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
3340
3441
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>
|
|
3341
3442
|
* </p>
|
|
3443
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3342
3444
|
*/
|
|
3343
3445
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
3344
3446
|
/**
|
|
3345
3447
|
* <p>The target backtrack window, in seconds. To disable backtracking, set this value to
|
|
3346
3448
|
* 0. </p>
|
|
3347
|
-
*
|
|
3348
|
-
* <p>Currently, Backtrack is only supported for Aurora MySQL DB clusters.</p>
|
|
3349
|
-
* </note>
|
|
3449
|
+
*
|
|
3350
3450
|
* <p>Default: 0</p>
|
|
3351
3451
|
* <p>Constraints:</p>
|
|
3352
3452
|
* <ul>
|
|
@@ -3354,6 +3454,7 @@ export interface CreateDBClusterMessage {
|
|
|
3354
3454
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
3355
3455
|
* </li>
|
|
3356
3456
|
* </ul>
|
|
3457
|
+
* <p>Valid for: Aurora MySQL DB clusters only</p>
|
|
3357
3458
|
*/
|
|
3358
3459
|
BacktrackWindow?: number;
|
|
3359
3460
|
/**
|
|
@@ -3363,13 +3464,12 @@ export interface CreateDBClusterMessage {
|
|
|
3363
3464
|
* <p>
|
|
3364
3465
|
* <b>Aurora MySQL</b>
|
|
3365
3466
|
* </p>
|
|
3366
|
-
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code
|
|
3367
|
-
* </p>
|
|
3467
|
+
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p>
|
|
3368
3468
|
* <p>
|
|
3369
3469
|
* <b>Aurora PostgreSQL</b>
|
|
3370
3470
|
* </p>
|
|
3371
|
-
* <p>Possible value is <code>postgresql</code
|
|
3372
|
-
* </p>
|
|
3471
|
+
* <p>Possible value is <code>postgresql</code>.</p>
|
|
3472
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3373
3473
|
*/
|
|
3374
3474
|
EnableCloudwatchLogsExports?: string[];
|
|
3375
3475
|
/**
|
|
@@ -3410,23 +3510,27 @@ export interface CreateDBClusterMessage {
|
|
|
3410
3510
|
* </p>
|
|
3411
3511
|
* </li>
|
|
3412
3512
|
* </ul>
|
|
3513
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3413
3514
|
*/
|
|
3414
3515
|
EngineMode?: string;
|
|
3415
3516
|
/**
|
|
3416
3517
|
* <p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>
|
|
3518
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3417
3519
|
*/
|
|
3418
3520
|
ScalingConfiguration?: ScalingConfiguration;
|
|
3419
3521
|
/**
|
|
3420
3522
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
3421
3523
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
3422
|
-
* deletion protection
|
|
3524
|
+
* deletion protection isn't enabled.</p>
|
|
3525
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3423
3526
|
*/
|
|
3424
3527
|
DeletionProtection?: boolean;
|
|
3425
3528
|
/**
|
|
3426
3529
|
* <p>
|
|
3427
|
-
*
|
|
3428
|
-
*
|
|
3429
|
-
*
|
|
3530
|
+
* The global cluster ID of an Aurora cluster that becomes the primary cluster
|
|
3531
|
+
* in the new global database cluster.
|
|
3532
|
+
* </p>
|
|
3533
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3430
3534
|
*/
|
|
3431
3535
|
GlobalClusterIdentifier?: string;
|
|
3432
3536
|
/**
|
|
@@ -3437,24 +3541,27 @@ export interface CreateDBClusterMessage {
|
|
|
3437
3541
|
* from inside the RDS console with the query editor.</p>
|
|
3438
3542
|
* <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
|
|
3439
3543
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
3544
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3440
3545
|
*/
|
|
3441
3546
|
EnableHttpEndpoint?: boolean;
|
|
3442
3547
|
/**
|
|
3443
3548
|
* <p>A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
|
3444
3549
|
* The default is not to copy them.</p>
|
|
3550
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3445
3551
|
*/
|
|
3446
3552
|
CopyTagsToSnapshot?: boolean;
|
|
3447
3553
|
/**
|
|
3448
3554
|
* <p>The Active Directory directory ID to create the DB cluster in.</p>
|
|
3449
3555
|
* <p>
|
|
3450
|
-
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
|
3451
|
-
*
|
|
3452
|
-
*
|
|
3453
|
-
*
|
|
3556
|
+
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.</p>
|
|
3557
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html">Kerberos authentication</a>
|
|
3558
|
+
* in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3559
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3454
3560
|
*/
|
|
3455
3561
|
Domain?: string;
|
|
3456
3562
|
/**
|
|
3457
3563
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
3564
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3458
3565
|
*/
|
|
3459
3566
|
DomainIAMRoleName?: string;
|
|
3460
3567
|
/**
|
|
@@ -3466,8 +3573,128 @@ export interface CreateDBClusterMessage {
|
|
|
3466
3573
|
* this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the
|
|
3467
3574
|
* primary is demoted by the <a>FailoverGlobalCluster</a> API operation, but it does nothing until then.
|
|
3468
3575
|
* </p>
|
|
3576
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3469
3577
|
*/
|
|
3470
3578
|
EnableGlobalWriteForwarding?: boolean;
|
|
3579
|
+
/**
|
|
3580
|
+
* <p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
|
3581
|
+
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p>
|
|
3582
|
+
* <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>
|
|
3583
|
+
* </p>
|
|
3584
|
+
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3585
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3586
|
+
*/
|
|
3587
|
+
DBClusterInstanceClass?: string;
|
|
3588
|
+
/**
|
|
3589
|
+
* <p>The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.</p>
|
|
3590
|
+
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3591
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3592
|
+
*/
|
|
3593
|
+
AllocatedStorage?: number;
|
|
3594
|
+
/**
|
|
3595
|
+
* <p>Specifies the storage type to be associated with the DB cluster.</p>
|
|
3596
|
+
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3597
|
+
* <p>
|
|
3598
|
+
* Valid values: <code>io1</code>
|
|
3599
|
+
* </p>
|
|
3600
|
+
* <p>
|
|
3601
|
+
* When specified, a value for the <code>Iops</code> parameter is required.
|
|
3602
|
+
* </p>
|
|
3603
|
+
* <p>
|
|
3604
|
+
* Default: <code>io1</code>
|
|
3605
|
+
* </p>
|
|
3606
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3607
|
+
*/
|
|
3608
|
+
StorageType?: string;
|
|
3609
|
+
/**
|
|
3610
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated
|
|
3611
|
+
* for each DB instance in the Multi-AZ DB cluster.</p>
|
|
3612
|
+
* <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>.
|
|
3613
|
+
* </p>
|
|
3614
|
+
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3615
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p>
|
|
3616
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3617
|
+
*/
|
|
3618
|
+
Iops?: number;
|
|
3619
|
+
/**
|
|
3620
|
+
* <p>A value that indicates whether the DB cluster is publicly accessible.</p>
|
|
3621
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
3622
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
3623
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
3624
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
3625
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
3626
|
+
* it.</p>
|
|
3627
|
+
* <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>
|
|
3628
|
+
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
|
|
3629
|
+
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
3630
|
+
* <ul>
|
|
3631
|
+
* <li>
|
|
3632
|
+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
3633
|
+
* </li>
|
|
3634
|
+
* <li>
|
|
3635
|
+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.</p>
|
|
3636
|
+
* </li>
|
|
3637
|
+
* </ul>
|
|
3638
|
+
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
3639
|
+
* <ul>
|
|
3640
|
+
* <li>
|
|
3641
|
+
* <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>
|
|
3642
|
+
* </li>
|
|
3643
|
+
* <li>
|
|
3644
|
+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.</p>
|
|
3645
|
+
* </li>
|
|
3646
|
+
* </ul>
|
|
3647
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3648
|
+
*/
|
|
3649
|
+
PubliclyAccessible?: boolean;
|
|
3650
|
+
/**
|
|
3651
|
+
* <p>A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
|
|
3652
|
+
* By default, minor engine upgrades are applied automatically.</p>
|
|
3653
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3654
|
+
*/
|
|
3655
|
+
AutoMinorVersionUpgrade?: boolean;
|
|
3656
|
+
/**
|
|
3657
|
+
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off
|
|
3658
|
+
* collecting Enhanced Monitoring metrics, specify 0. The default is 0.</p>
|
|
3659
|
+
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code>
|
|
3660
|
+
* to a value other than 0.</p>
|
|
3661
|
+
* <p>Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code>
|
|
3662
|
+
* </p>
|
|
3663
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3664
|
+
*/
|
|
3665
|
+
MonitoringInterval?: number;
|
|
3666
|
+
/**
|
|
3667
|
+
* <p>The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
|
3668
|
+
* An example is <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role,
|
|
3669
|
+
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling">Setting
|
|
3670
|
+
* up and enabling Enhanced Monitoring</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3671
|
+
* <p>If <code>MonitoringInterval</code> is set to a value other than 0, supply a <code>MonitoringRoleArn</code> value.</p>
|
|
3672
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3673
|
+
*/
|
|
3674
|
+
MonitoringRoleArn?: string;
|
|
3675
|
+
/**
|
|
3676
|
+
* <p>A value that indicates whether to turn on Performance Insights for the DB cluster.
|
|
3677
|
+
* </p>
|
|
3678
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
|
|
3679
|
+
* Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.
|
|
3680
|
+
* </p>
|
|
3681
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3682
|
+
*/
|
|
3683
|
+
EnablePerformanceInsights?: boolean;
|
|
3684
|
+
/**
|
|
3685
|
+
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
|
|
3686
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
3687
|
+
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
3688
|
+
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
3689
|
+
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
3690
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3691
|
+
*/
|
|
3692
|
+
PerformanceInsightsKMSKeyId?: string;
|
|
3693
|
+
/**
|
|
3694
|
+
* <p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p>
|
|
3695
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3696
|
+
*/
|
|
3697
|
+
PerformanceInsightsRetentionPeriod?: number;
|
|
3471
3698
|
}
|
|
3472
3699
|
export declare namespace CreateDBClusterMessage {
|
|
3473
3700
|
/**
|
|
@@ -3702,11 +3929,28 @@ export declare namespace ScalingConfigurationInfo {
|
|
|
3702
3929
|
const filterSensitiveLog: (obj: ScalingConfigurationInfo) => any;
|
|
3703
3930
|
}
|
|
3704
3931
|
/**
|
|
3705
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
3706
|
-
* </p>
|
|
3707
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
3708
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
3932
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
3709
3933
|
* </p>
|
|
3934
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
3935
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
3936
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
3937
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
3938
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
3939
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
3940
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
3941
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
3942
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
3943
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
3944
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
3945
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
3946
|
+
* </p>
|
|
3947
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
3948
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
3949
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
3950
|
+
* </p>
|
|
3951
|
+
* <note>
|
|
3952
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
3953
|
+
* </note>
|
|
3710
3954
|
*/
|
|
3711
3955
|
export interface DBCluster {
|
|
3712
3956
|
/**
|
|
@@ -3986,6 +4230,64 @@ export interface DBCluster {
|
|
|
3986
4230
|
* Specific changes are identified by subelements.</p>
|
|
3987
4231
|
*/
|
|
3988
4232
|
PendingModifiedValues?: ClusterPendingModifiedValues;
|
|
4233
|
+
/**
|
|
4234
|
+
* <p>The name of the compute and memory capacity class of the DB instance.</p>
|
|
4235
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4236
|
+
*/
|
|
4237
|
+
DBClusterInstanceClass?: string;
|
|
4238
|
+
/**
|
|
4239
|
+
* <p>The storage type associated with the DB cluster.</p>
|
|
4240
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4241
|
+
*/
|
|
4242
|
+
StorageType?: string;
|
|
4243
|
+
/**
|
|
4244
|
+
* <p>The Provisioned IOPS (I/O operations per second) value.</p>
|
|
4245
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4246
|
+
*/
|
|
4247
|
+
Iops?: number;
|
|
4248
|
+
/**
|
|
4249
|
+
* <p>Specifies the accessibility options for the DB instance.</p>
|
|
4250
|
+
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private
|
|
4251
|
+
* IP address from within the DB instance's virtual private cloud (VPC).
|
|
4252
|
+
* It resolves to the public IP address from outside of the DB instance's VPC.
|
|
4253
|
+
* Access to the DB instance is ultimately controlled by the security group it uses.
|
|
4254
|
+
* That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
|
|
4255
|
+
* <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>
|
|
4256
|
+
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
4257
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4258
|
+
*/
|
|
4259
|
+
PubliclyAccessible?: boolean;
|
|
4260
|
+
/**
|
|
4261
|
+
* <p>A value that indicates that minor version patches are applied automatically.</p>
|
|
4262
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4263
|
+
*/
|
|
4264
|
+
AutoMinorVersionUpgrade?: boolean;
|
|
4265
|
+
/**
|
|
4266
|
+
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.</p>
|
|
4267
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4268
|
+
*/
|
|
4269
|
+
MonitoringInterval?: number;
|
|
4270
|
+
/**
|
|
4271
|
+
* <p>The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.</p>
|
|
4272
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4273
|
+
*/
|
|
4274
|
+
MonitoringRoleArn?: string;
|
|
4275
|
+
/**
|
|
4276
|
+
* <p>True if Performance Insights is enabled for the DB cluster, and otherwise false.</p>
|
|
4277
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4278
|
+
*/
|
|
4279
|
+
PerformanceInsightsEnabled?: boolean;
|
|
4280
|
+
/**
|
|
4281
|
+
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
|
|
4282
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
4283
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4284
|
+
*/
|
|
4285
|
+
PerformanceInsightsKMSKeyId?: string;
|
|
4286
|
+
/**
|
|
4287
|
+
* <p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p>
|
|
4288
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4289
|
+
*/
|
|
4290
|
+
PerformanceInsightsRetentionPeriod?: number;
|
|
3989
4291
|
}
|
|
3990
4292
|
export declare namespace DBCluster {
|
|
3991
4293
|
/**
|
|
@@ -3995,11 +4297,28 @@ export declare namespace DBCluster {
|
|
|
3995
4297
|
}
|
|
3996
4298
|
export interface CreateDBClusterResult {
|
|
3997
4299
|
/**
|
|
3998
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
3999
|
-
* </p>
|
|
4000
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
4001
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
4300
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
4002
4301
|
* </p>
|
|
4302
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
4303
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
4304
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
4305
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
4306
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
4307
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
4308
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
4309
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
4310
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
4311
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
4312
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
4313
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
4314
|
+
* </p>
|
|
4315
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
4316
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
4317
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
4318
|
+
* </p>
|
|
4319
|
+
* <note>
|
|
4320
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
4321
|
+
* </note>
|
|
4003
4322
|
*/
|
|
4004
4323
|
DBCluster?: DBCluster;
|
|
4005
4324
|
}
|
|
@@ -4213,7 +4532,7 @@ export interface CreateDBClusterEndpointMessage {
|
|
|
4213
4532
|
*/
|
|
4214
4533
|
DBClusterEndpointIdentifier: string | undefined;
|
|
4215
4534
|
/**
|
|
4216
|
-
* <p>The type of the endpoint
|
|
4535
|
+
* <p>The type of the endpoint, one of: <code>READER</code>, <code>WRITER</code>, <code>ANY</code>.</p>
|
|
4217
4536
|
*/
|
|
4218
4537
|
EndpointType: string | undefined;
|
|
4219
4538
|
/**
|
|
@@ -4222,8 +4541,8 @@ export interface CreateDBClusterEndpointMessage {
|
|
|
4222
4541
|
StaticMembers?: string[];
|
|
4223
4542
|
/**
|
|
4224
4543
|
* <p>List of DB instance identifiers that aren't part of the custom endpoint group.
|
|
4225
|
-
*
|
|
4226
|
-
*
|
|
4544
|
+
* All other eligible instances are reachable through the custom endpoint.
|
|
4545
|
+
* This parameter is relevant only if the list of static members is empty.</p>
|
|
4227
4546
|
*/
|
|
4228
4547
|
ExcludedMembers?: string[];
|
|
4229
4548
|
/**
|
|
@@ -4355,7 +4674,7 @@ export interface CreateDBClusterParameterGroupMessage {
|
|
|
4355
4674
|
* <p>Constraints:</p>
|
|
4356
4675
|
* <ul>
|
|
4357
4676
|
* <li>
|
|
4358
|
-
* <p>Must match the name of an existing DB cluster parameter group.</p>
|
|
4677
|
+
* <p>Must not match the name of an existing DB cluster parameter group.</p>
|
|
4359
4678
|
* </li>
|
|
4360
4679
|
* </ul>
|
|
4361
4680
|
* <note>
|
|
@@ -4369,13 +4688,23 @@ export interface CreateDBClusterParameterGroupMessage {
|
|
|
4369
4688
|
* <p>
|
|
4370
4689
|
* <b>Aurora MySQL</b>
|
|
4371
4690
|
* </p>
|
|
4372
|
-
* <p>Example: <code>aurora5.6</code>, <code>aurora-mysql5.7</code>
|
|
4691
|
+
* <p>Example: <code>aurora5.6</code>, <code>aurora-mysql5.7</code>, <code>aurora-mysql8.0</code>
|
|
4373
4692
|
* </p>
|
|
4374
4693
|
* <p>
|
|
4375
4694
|
* <b>Aurora PostgreSQL</b>
|
|
4376
4695
|
* </p>
|
|
4377
4696
|
* <p>Example: <code>aurora-postgresql9.6</code>
|
|
4378
4697
|
* </p>
|
|
4698
|
+
* <p>
|
|
4699
|
+
* <b>RDS for MySQL</b>
|
|
4700
|
+
* </p>
|
|
4701
|
+
* <p>Example: <code>mysql8.0</code>
|
|
4702
|
+
* </p>
|
|
4703
|
+
* <p>
|
|
4704
|
+
* <b>RDS for PostgreSQL</b>
|
|
4705
|
+
* </p>
|
|
4706
|
+
* <p>Example: <code>postgres12</code>
|
|
4707
|
+
* </p>
|
|
4379
4708
|
* <p>To list all of the available parameter group families for a DB engine, use the following command:</p>
|
|
4380
4709
|
* <p>
|
|
4381
4710
|
* <code>aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine></code>
|
|
@@ -4395,13 +4724,23 @@ export interface CreateDBClusterParameterGroupMessage {
|
|
|
4395
4724
|
* </li>
|
|
4396
4725
|
* <li>
|
|
4397
4726
|
* <p>
|
|
4398
|
-
* <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora)</p>
|
|
4727
|
+
* <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
|
|
4399
4728
|
* </li>
|
|
4400
4729
|
* <li>
|
|
4401
4730
|
* <p>
|
|
4402
4731
|
* <code>aurora-postgresql</code>
|
|
4403
4732
|
* </p>
|
|
4404
4733
|
* </li>
|
|
4734
|
+
* <li>
|
|
4735
|
+
* <p>
|
|
4736
|
+
* <code>mysql</code>
|
|
4737
|
+
* </p>
|
|
4738
|
+
* </li>
|
|
4739
|
+
* <li>
|
|
4740
|
+
* <p>
|
|
4741
|
+
* <code>postgres</code>
|
|
4742
|
+
* </p>
|
|
4743
|
+
* </li>
|
|
4405
4744
|
* </ul>
|
|
4406
4745
|
*/
|
|
4407
4746
|
DBParameterGroupFamily: string | undefined;
|
|
@@ -4595,7 +4934,7 @@ export interface CreateDBInstanceMessage {
|
|
|
4595
4934
|
* </li>
|
|
4596
4935
|
* </ul>
|
|
4597
4936
|
* <p>
|
|
4598
|
-
* <b>Amazon RDS Custom</b>
|
|
4937
|
+
* <b>Amazon RDS Custom for Oracle</b>
|
|
4599
4938
|
* </p>
|
|
4600
4939
|
* <p>The Oracle System ID (SID) of the created RDS Custom DB instance.
|
|
4601
4940
|
* If you don't specify a value, the default value is <code>ORCL</code>.
|
|
@@ -4615,6 +4954,10 @@ export interface CreateDBInstanceMessage {
|
|
|
4615
4954
|
* </li>
|
|
4616
4955
|
* </ul>
|
|
4617
4956
|
* <p>
|
|
4957
|
+
* <b>Amazon RDS Custom for SQL Server</b>
|
|
4958
|
+
* </p>
|
|
4959
|
+
* <p>Not applicable. Must be null.</p>
|
|
4960
|
+
* <p>
|
|
4618
4961
|
* <b>SQL Server</b>
|
|
4619
4962
|
* </p>
|
|
4620
4963
|
* <p>Not applicable. Must be null.</p>
|
|
@@ -4690,10 +5033,12 @@ export interface CreateDBInstanceMessage {
|
|
|
4690
5033
|
* </p>
|
|
4691
5034
|
* <ul>
|
|
4692
5035
|
* <li>
|
|
4693
|
-
* <p>General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536
|
|
5036
|
+
* <p>General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536 for RDS Custom for Oracle,
|
|
5037
|
+
* 16384 for RDS Custom for SQL Server.</p>
|
|
4694
5038
|
* </li>
|
|
4695
5039
|
* <li>
|
|
4696
|
-
* <p>Provisioned IOPS storage (io1): Must be an integer from 40 to 65536
|
|
5040
|
+
* <p>Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle,
|
|
5041
|
+
* 16384 for RDS Custom for SQL Server.</p>
|
|
4697
5042
|
* </li>
|
|
4698
5043
|
* </ul>
|
|
4699
5044
|
*
|
|
@@ -4775,7 +5120,7 @@ export interface CreateDBInstanceMessage {
|
|
|
4775
5120
|
* <p>General Purpose (SSD) storage (gp2):</p>
|
|
4776
5121
|
* <ul>
|
|
4777
5122
|
* <li>
|
|
4778
|
-
* <p>Enterprise and Standard editions: Must be an integer from
|
|
5123
|
+
* <p>Enterprise and Standard editions: Must be an integer from 20 to 16384.</p>
|
|
4779
5124
|
* </li>
|
|
4780
5125
|
* <li>
|
|
4781
5126
|
* <p>Web and Express editions: Must be an integer from 20 to 16384.</p>
|
|
@@ -4786,7 +5131,7 @@ export interface CreateDBInstanceMessage {
|
|
|
4786
5131
|
* <p>Provisioned IOPS storage (io1):</p>
|
|
4787
5132
|
* <ul>
|
|
4788
5133
|
* <li>
|
|
4789
|
-
* <p>Enterprise and Standard editions: Must be an integer from
|
|
5134
|
+
* <p>Enterprise and Standard editions: Must be an integer from 100 to 16384.</p>
|
|
4790
5135
|
* </li>
|
|
4791
5136
|
* <li>
|
|
4792
5137
|
* <p>Web and Express editions: Must be an integer from 100 to 16384.</p>
|
|
@@ -4797,7 +5142,7 @@ export interface CreateDBInstanceMessage {
|
|
|
4797
5142
|
* <p>Magnetic storage (standard):</p>
|
|
4798
5143
|
* <ul>
|
|
4799
5144
|
* <li>
|
|
4800
|
-
* <p>Enterprise and Standard editions: Must be an integer from
|
|
5145
|
+
* <p>Enterprise and Standard editions: Must be an integer from 20 to 1024.</p>
|
|
4801
5146
|
* </li>
|
|
4802
5147
|
* <li>
|
|
4803
5148
|
* <p>Web and Express editions: Must be an integer from 20 to 1024.</p>
|
|
@@ -4808,7 +5153,7 @@ export interface CreateDBInstanceMessage {
|
|
|
4808
5153
|
*/
|
|
4809
5154
|
AllocatedStorage?: number;
|
|
4810
5155
|
/**
|
|
4811
|
-
* <p>The compute and memory capacity of the DB instance, for example
|
|
5156
|
+
* <p>The compute and memory capacity of the DB instance, for example db.m4.large.
|
|
4812
5157
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
|
|
4813
5158
|
* For the full list of DB instance classes,
|
|
4814
5159
|
* and availability for your engine, see
|
|
@@ -4832,7 +5177,7 @@ export interface CreateDBInstanceMessage {
|
|
|
4832
5177
|
* </li>
|
|
4833
5178
|
* <li>
|
|
4834
5179
|
* <p>
|
|
4835
|
-
* <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora)</p>
|
|
5180
|
+
* <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
|
|
4836
5181
|
* </li>
|
|
4837
5182
|
* <li>
|
|
4838
5183
|
* <p>
|
|
@@ -4841,7 +5186,22 @@ export interface CreateDBInstanceMessage {
|
|
|
4841
5186
|
* </li>
|
|
4842
5187
|
* <li>
|
|
4843
5188
|
* <p>
|
|
4844
|
-
* <code>custom-oracle-ee (for RDS Custom instances)</code>
|
|
5189
|
+
* <code>custom-oracle-ee (for RDS Custom for Oracle instances)</code>
|
|
5190
|
+
* </p>
|
|
5191
|
+
* </li>
|
|
5192
|
+
* <li>
|
|
5193
|
+
* <p>
|
|
5194
|
+
* <code>custom-sqlserver-ee (for RDS Custom for SQL Server instances)</code>
|
|
5195
|
+
* </p>
|
|
5196
|
+
* </li>
|
|
5197
|
+
* <li>
|
|
5198
|
+
* <p>
|
|
5199
|
+
* <code>custom-sqlserver-se (for RDS Custom for SQL Server instances)</code>
|
|
5200
|
+
* </p>
|
|
5201
|
+
* </li>
|
|
5202
|
+
* <li>
|
|
5203
|
+
* <p>
|
|
5204
|
+
* <code>custom-sqlserver-web (for RDS Custom for SQL Server instances)</code>
|
|
4845
5205
|
* </p>
|
|
4846
5206
|
* </li>
|
|
4847
5207
|
* <li>
|
|
@@ -4912,88 +5272,15 @@ export interface CreateDBInstanceMessage {
|
|
|
4912
5272
|
* </p>
|
|
4913
5273
|
*
|
|
4914
5274
|
* <p>
|
|
4915
|
-
* <b>
|
|
4916
|
-
*
|
|
4917
|
-
* <p>Constraints:</p>
|
|
4918
|
-
* <ul>
|
|
4919
|
-
* <li>
|
|
4920
|
-
* <p>Required for MariaDB.</p>
|
|
4921
|
-
* </li>
|
|
4922
|
-
* <li>
|
|
4923
|
-
* <p>Must be 1 to 16 letters or numbers.</p>
|
|
4924
|
-
* </li>
|
|
4925
|
-
* <li>
|
|
4926
|
-
* <p>Can't be a reserved word for the chosen database engine.</p>
|
|
4927
|
-
* </li>
|
|
4928
|
-
* </ul>
|
|
4929
|
-
*
|
|
4930
|
-
* <p>
|
|
4931
|
-
* <b>Microsoft SQL Server</b>
|
|
4932
|
-
* </p>
|
|
4933
|
-
* <p>Constraints:</p>
|
|
4934
|
-
* <ul>
|
|
4935
|
-
* <li>
|
|
4936
|
-
* <p>Required for SQL Server.</p>
|
|
4937
|
-
* </li>
|
|
4938
|
-
* <li>
|
|
4939
|
-
* <p>Must be 1 to 128 letters or numbers.</p>
|
|
4940
|
-
* </li>
|
|
4941
|
-
* <li>
|
|
4942
|
-
* <p>The first character must be a letter.</p>
|
|
4943
|
-
* </li>
|
|
4944
|
-
* <li>
|
|
4945
|
-
* <p>Can't be a reserved word for the chosen database engine.</p>
|
|
4946
|
-
* </li>
|
|
4947
|
-
* </ul>
|
|
4948
|
-
*
|
|
4949
|
-
* <p>
|
|
4950
|
-
* <b>MySQL</b>
|
|
4951
|
-
* </p>
|
|
4952
|
-
* <p>Constraints:</p>
|
|
4953
|
-
* <ul>
|
|
4954
|
-
* <li>
|
|
4955
|
-
* <p>Required for MySQL.</p>
|
|
4956
|
-
* </li>
|
|
4957
|
-
* <li>
|
|
4958
|
-
* <p>Must be 1 to 16 letters or numbers.</p>
|
|
4959
|
-
* </li>
|
|
4960
|
-
* <li>
|
|
4961
|
-
* <p>First character must be a letter.</p>
|
|
4962
|
-
* </li>
|
|
4963
|
-
* <li>
|
|
4964
|
-
* <p>Can't be a reserved word for the chosen database engine.</p>
|
|
4965
|
-
* </li>
|
|
4966
|
-
* </ul>
|
|
4967
|
-
*
|
|
4968
|
-
* <p>
|
|
4969
|
-
* <b>Oracle</b>
|
|
4970
|
-
* </p>
|
|
4971
|
-
* <p>Constraints:</p>
|
|
4972
|
-
* <ul>
|
|
4973
|
-
* <li>
|
|
4974
|
-
* <p>Required for Oracle.</p>
|
|
4975
|
-
* </li>
|
|
4976
|
-
* <li>
|
|
4977
|
-
* <p>Must be 1 to 30 letters or numbers.</p>
|
|
4978
|
-
* </li>
|
|
4979
|
-
* <li>
|
|
4980
|
-
* <p>First character must be a letter.</p>
|
|
4981
|
-
* </li>
|
|
4982
|
-
* <li>
|
|
4983
|
-
* <p>Can't be a reserved word for the chosen database engine.</p>
|
|
4984
|
-
* </li>
|
|
4985
|
-
* </ul>
|
|
4986
|
-
*
|
|
4987
|
-
* <p>
|
|
4988
|
-
* <b>PostgreSQL</b>
|
|
4989
|
-
* </p>
|
|
5275
|
+
* <b>Amazon RDS</b>
|
|
5276
|
+
* </p>
|
|
4990
5277
|
* <p>Constraints:</p>
|
|
4991
5278
|
* <ul>
|
|
4992
5279
|
* <li>
|
|
4993
|
-
* <p>Required
|
|
5280
|
+
* <p>Required.</p>
|
|
4994
5281
|
* </li>
|
|
4995
5282
|
* <li>
|
|
4996
|
-
* <p>Must be 1 to
|
|
5283
|
+
* <p>Must be 1 to 16 letters, numbers, or underscores.</p>
|
|
4997
5284
|
* </li>
|
|
4998
5285
|
* <li>
|
|
4999
5286
|
* <p>First character must be a letter.</p>
|
|
@@ -5063,6 +5350,11 @@ export interface CreateDBInstanceMessage {
|
|
|
5063
5350
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions
|
|
5064
5351
|
* and Availability Zones</a>.
|
|
5065
5352
|
* </p>
|
|
5353
|
+
* <p>
|
|
5354
|
+
* <b>Amazon Aurora</b>
|
|
5355
|
+
* </p>
|
|
5356
|
+
* <p>Not applicable. Availability Zones are managed by the DB cluster.
|
|
5357
|
+
* </p>
|
|
5066
5358
|
* <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.</p>
|
|
5067
5359
|
* <p>
|
|
5068
5360
|
* Example: <code>us-east-1d</code>
|
|
@@ -5138,7 +5430,7 @@ export interface CreateDBInstanceMessage {
|
|
|
5138
5430
|
* <p>Can't be set to 0 if the DB instance is a source to read replicas</p>
|
|
5139
5431
|
* </li>
|
|
5140
5432
|
* <li>
|
|
5141
|
-
* <p>Can't be set to 0 or 35 for an RDS Custom DB instance</p>
|
|
5433
|
+
* <p>Can't be set to 0 or 35 for an RDS Custom for Oracle DB instance</p>
|
|
5142
5434
|
* </li>
|
|
5143
5435
|
* </ul>
|
|
5144
5436
|
*/
|
|
@@ -5251,51 +5543,53 @@ export interface CreateDBInstanceMessage {
|
|
|
5251
5543
|
* instance is managed by the DB cluster.</p>
|
|
5252
5544
|
*
|
|
5253
5545
|
* <p>
|
|
5254
|
-
* <b>Amazon RDS Custom</b>
|
|
5546
|
+
* <b>Amazon RDS Custom for Oracle</b>
|
|
5255
5547
|
* </p>
|
|
5256
|
-
* <p>A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom. The CEV
|
|
5548
|
+
* <p>A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV
|
|
5257
5549
|
* name has the following format: <code>19.<i>customized_string</i>
|
|
5258
5550
|
* </code>. An example identifier is
|
|
5259
5551
|
* <code>19.my_cev1</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create">
|
|
5260
|
-
* Creating an RDS Custom DB instance</a> in the <i>Amazon RDS User Guide.</i>.</p>
|
|
5552
|
+
* Creating an RDS Custom for Oracle DB instance</a> in the <i>Amazon RDS User Guide.</i>.</p>
|
|
5261
5553
|
*
|
|
5262
5554
|
* <p>
|
|
5263
|
-
* <b>
|
|
5555
|
+
* <b>Amazon RDS Custom for SQL Server</b>
|
|
5556
|
+
* </p>
|
|
5557
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.reqsMS">RDS Custom for SQL Server general requirements</a>
|
|
5558
|
+
* in the <i>Amazon RDS User Guide.</i>
|
|
5264
5559
|
* </p>
|
|
5265
5560
|
*
|
|
5266
|
-
* <p>
|
|
5561
|
+
* <p>
|
|
5562
|
+
* <b>MariaDB</b>
|
|
5563
|
+
* </p>
|
|
5564
|
+
* <p>For information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt">MariaDB on Amazon RDS Versions</a> in the
|
|
5267
5565
|
* <i>Amazon RDS User Guide.</i>
|
|
5268
5566
|
* </p>
|
|
5269
5567
|
*
|
|
5270
5568
|
* <p>
|
|
5271
5569
|
* <b>Microsoft SQL Server</b>
|
|
5272
5570
|
* </p>
|
|
5273
|
-
*
|
|
5274
|
-
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport">Microsoft SQL Server Versions on Amazon RDS</a> in the
|
|
5571
|
+
* <p>For information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport">Microsoft SQL Server Versions on Amazon RDS</a> in the
|
|
5275
5572
|
* <i>Amazon RDS User Guide.</i>
|
|
5276
5573
|
* </p>
|
|
5277
5574
|
*
|
|
5278
5575
|
* <p>
|
|
5279
5576
|
* <b>MySQL</b>
|
|
5280
5577
|
* </p>
|
|
5281
|
-
*
|
|
5282
|
-
* <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
|
|
5578
|
+
* <p>For information, 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
|
|
5283
5579
|
* <i>Amazon RDS User Guide.</i>
|
|
5284
5580
|
* </p>
|
|
5285
5581
|
*
|
|
5286
5582
|
* <p>
|
|
5287
5583
|
* <b>Oracle</b>
|
|
5288
5584
|
* </p>
|
|
5289
|
-
*
|
|
5290
|
-
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html">Oracle Database Engine Release Notes</a> in the
|
|
5585
|
+
* <p>For information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html">Oracle Database Engine Release Notes</a> in the
|
|
5291
5586
|
* <i>Amazon RDS User Guide.</i>
|
|
5292
5587
|
* </p>
|
|
5293
5588
|
*
|
|
5294
5589
|
* <p>
|
|
5295
5590
|
* <b>PostgreSQL</b>
|
|
5296
5591
|
* </p>
|
|
5297
|
-
*
|
|
5298
|
-
* <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
|
|
5592
|
+
* <p>For information, 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
|
|
5299
5593
|
* <i>Amazon RDS User Guide.</i>
|
|
5300
5594
|
* </p>
|
|
5301
5595
|
*/
|
|
@@ -5317,10 +5611,11 @@ export interface CreateDBInstanceMessage {
|
|
|
5317
5611
|
LicenseModel?: string;
|
|
5318
5612
|
/**
|
|
5319
5613
|
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
|
|
5320
|
-
* 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
|
|
5614
|
+
* 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>.
|
|
5321
5615
|
* </p>
|
|
5322
|
-
* <p>Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50
|
|
5323
|
-
* For SQL Server DB instances, must be a multiple between 1 and 50
|
|
5616
|
+
* <p>Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50
|
|
5617
|
+
* of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50
|
|
5618
|
+
* of the storage amount for the DB instance.
|
|
5324
5619
|
* </p>
|
|
5325
5620
|
*/
|
|
5326
5621
|
Iops?: number;
|
|
@@ -5351,27 +5646,28 @@ export interface CreateDBInstanceMessage {
|
|
|
5351
5646
|
NcharCharacterSetName?: string;
|
|
5352
5647
|
/**
|
|
5353
5648
|
* <p>A value that indicates whether the DB instance is publicly accessible.</p>
|
|
5354
|
-
* <p>When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from
|
|
5355
|
-
*
|
|
5356
|
-
*
|
|
5649
|
+
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from
|
|
5650
|
+
* within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC.
|
|
5651
|
+
* Access to the DB instance is ultimately controlled by the security group it uses.
|
|
5652
|
+
* That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
|
|
5357
5653
|
* <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>
|
|
5358
5654
|
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
|
|
5359
5655
|
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
5360
5656
|
* <ul>
|
|
5361
5657
|
* <li>
|
|
5362
|
-
* <p>If the default VPC in the target
|
|
5658
|
+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.</p>
|
|
5363
5659
|
* </li>
|
|
5364
5660
|
* <li>
|
|
5365
|
-
* <p>If the default VPC in the target
|
|
5661
|
+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.</p>
|
|
5366
5662
|
* </li>
|
|
5367
5663
|
* </ul>
|
|
5368
5664
|
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
5369
5665
|
* <ul>
|
|
5370
5666
|
* <li>
|
|
5371
|
-
* <p>If the subnets are part of a VPC that doesn’t have an
|
|
5667
|
+
* <p>If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.</p>
|
|
5372
5668
|
* </li>
|
|
5373
5669
|
* <li>
|
|
5374
|
-
* <p>If the subnets are part of a VPC that has an
|
|
5670
|
+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.</p>
|
|
5375
5671
|
* </li>
|
|
5376
5672
|
* </ul>
|
|
5377
5673
|
*/
|
|
@@ -5412,7 +5708,7 @@ export interface CreateDBInstanceMessage {
|
|
|
5412
5708
|
TdeCredentialPassword?: string;
|
|
5413
5709
|
/**
|
|
5414
5710
|
* <p>A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.</p>
|
|
5415
|
-
* <p>For RDS Custom
|
|
5711
|
+
* <p>For RDS Custom instances, either set this parameter to <code>true</code> or leave it unset.
|
|
5416
5712
|
* If you set this parameter to <code>false</code>, RDS reports an error.</p>
|
|
5417
5713
|
* <p>
|
|
5418
5714
|
* <b>Amazon Aurora</b>
|
|
@@ -5437,8 +5733,8 @@ export interface CreateDBInstanceMessage {
|
|
|
5437
5733
|
* <p>
|
|
5438
5734
|
* <b>Amazon RDS Custom</b>
|
|
5439
5735
|
* </p>
|
|
5440
|
-
* <p>A KMS key is required for RDS Custom
|
|
5441
|
-
* while enabling <code>StorageEncrypted</code>, the engine uses the default KMS key. However, RDS Custom
|
|
5736
|
+
* <p>A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty
|
|
5737
|
+
* while enabling <code>StorageEncrypted</code>, the engine uses the default KMS key. However, RDS Custom
|
|
5442
5738
|
* doesn't use the default key when this parameter is empty. You must explicitly specify a key.</p>
|
|
5443
5739
|
*/
|
|
5444
5740
|
KmsKeyId?: string;
|
|
@@ -5502,8 +5798,8 @@ export interface CreateDBInstanceMessage {
|
|
|
5502
5798
|
*/
|
|
5503
5799
|
Timezone?: string;
|
|
5504
5800
|
/**
|
|
5505
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
5506
|
-
*
|
|
5801
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
5802
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
5507
5803
|
* <p>This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts
|
|
5508
5804
|
* to database accounts is managed by the DB cluster.</p>
|
|
5509
5805
|
* <p>For more information, see
|
|
@@ -5559,7 +5855,7 @@ export interface CreateDBInstanceMessage {
|
|
|
5559
5855
|
* </p>
|
|
5560
5856
|
* <p>Possible values are <code>agent</code> and <code>error</code>.
|
|
5561
5857
|
* </p>
|
|
5562
|
-
*
|
|
5858
|
+
* <p>
|
|
5563
5859
|
* <b>MySQL</b>
|
|
5564
5860
|
* </p>
|
|
5565
5861
|
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.
|
|
@@ -5585,7 +5881,7 @@ export interface CreateDBInstanceMessage {
|
|
|
5585
5881
|
/**
|
|
5586
5882
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
5587
5883
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
5588
|
-
* deletion protection
|
|
5884
|
+
* deletion protection isn't enabled. For more information, see
|
|
5589
5885
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
5590
5886
|
* Deleting a DB Instance</a>.
|
|
5591
5887
|
* </p>
|
|
@@ -5641,6 +5937,13 @@ export interface CreateDBInstanceMessage {
|
|
|
5641
5937
|
* <p>This setting is required for RDS Custom.</p>
|
|
5642
5938
|
*/
|
|
5643
5939
|
CustomIamInstanceProfile?: string;
|
|
5940
|
+
/**
|
|
5941
|
+
* <p>Specifies where automated backups and manual snapshots are stored.</p>
|
|
5942
|
+
* <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>
|
|
5943
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working
|
|
5944
|
+
* with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
5945
|
+
*/
|
|
5946
|
+
BackupTarget?: string;
|
|
5644
5947
|
}
|
|
5645
5948
|
export declare namespace CreateDBInstanceMessage {
|
|
5646
5949
|
/**
|
|
@@ -6074,7 +6377,11 @@ export declare namespace DBInstanceStatusInfo {
|
|
|
6074
6377
|
/**
|
|
6075
6378
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
6076
6379
|
* </p>
|
|
6077
|
-
* <p>This data type is used as a response element in the <code>
|
|
6380
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
6381
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
6382
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
6383
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
6384
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
6078
6385
|
* </p>
|
|
6079
6386
|
*/
|
|
6080
6387
|
export interface DBInstance {
|
|
@@ -6206,8 +6513,8 @@ export interface DBInstance {
|
|
|
6206
6513
|
/**
|
|
6207
6514
|
* <p>Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance
|
|
6208
6515
|
* is replicated as a read replica. For example, when you create an Aurora read replica of
|
|
6209
|
-
* an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is
|
|
6210
|
-
* shown. This output
|
|
6516
|
+
* an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is
|
|
6517
|
+
* shown. This output doesn't contain information about cross-Region Aurora read
|
|
6211
6518
|
* replicas.</p>
|
|
6212
6519
|
* <note>
|
|
6213
6520
|
* <p>Currently, each RDS DB instance can have only one Aurora read replica.</p>
|
|
@@ -6251,9 +6558,12 @@ export interface DBInstance {
|
|
|
6251
6558
|
SecondaryAvailabilityZone?: string;
|
|
6252
6559
|
/**
|
|
6253
6560
|
* <p>Specifies the accessibility options for the DB instance.</p>
|
|
6254
|
-
* <p>When the DB
|
|
6255
|
-
*
|
|
6256
|
-
*
|
|
6561
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
6562
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
6563
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
6564
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
6565
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
6566
|
+
* it.</p>
|
|
6257
6567
|
* <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>
|
|
6258
6568
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
6259
6569
|
*/
|
|
@@ -6492,6 +6802,10 @@ export interface DBInstance {
|
|
|
6492
6802
|
* User Guide</i>.</p>
|
|
6493
6803
|
*/
|
|
6494
6804
|
CustomIamInstanceProfile?: string;
|
|
6805
|
+
/**
|
|
6806
|
+
* <p>Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.</p>
|
|
6807
|
+
*/
|
|
6808
|
+
BackupTarget?: string;
|
|
6495
6809
|
}
|
|
6496
6810
|
export declare namespace DBInstance {
|
|
6497
6811
|
/**
|
|
@@ -6503,7 +6817,11 @@ export interface CreateDBInstanceResult {
|
|
|
6503
6817
|
/**
|
|
6504
6818
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
6505
6819
|
* </p>
|
|
6506
|
-
* <p>This data type is used as a response element in the <code>
|
|
6820
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
6821
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
6822
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
6823
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
6824
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
6507
6825
|
* </p>
|
|
6508
6826
|
*/
|
|
6509
6827
|
DBInstance?: DBInstance;
|
|
@@ -6616,7 +6934,7 @@ export interface CreateDBInstanceReadReplicaMessage {
|
|
|
6616
6934
|
* </li>
|
|
6617
6935
|
* <li>
|
|
6618
6936
|
* <p>Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or
|
|
6619
|
-
* later (9.4.7 and higher for cross-
|
|
6937
|
+
* later (9.4.7 and higher for cross-Region replication).</p>
|
|
6620
6938
|
* </li>
|
|
6621
6939
|
* <li>
|
|
6622
6940
|
* <p>The specified DB instance must have automatic backups enabled, that is, its backup
|
|
@@ -6636,8 +6954,8 @@ export interface CreateDBInstanceReadReplicaMessage {
|
|
|
6636
6954
|
*/
|
|
6637
6955
|
SourceDBInstanceIdentifier: string | undefined;
|
|
6638
6956
|
/**
|
|
6639
|
-
* <p>The compute and memory capacity of the read replica, for example
|
|
6640
|
-
*
|
|
6957
|
+
* <p>The compute and memory capacity of the read replica, for example
|
|
6958
|
+
* db.m4.large. Not all DB instance classes are available in all Amazon Web Services
|
|
6641
6959
|
* Regions, or for all database engines. For the full list of DB instance classes, and
|
|
6642
6960
|
* availability for your engine, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB Instance
|
|
6643
6961
|
* Class</a> in the <i>Amazon RDS User Guide.</i>
|
|
@@ -6693,9 +7011,9 @@ export interface CreateDBInstanceReadReplicaMessage {
|
|
|
6693
7011
|
/**
|
|
6694
7012
|
* <p>The name of the DB parameter group to associate with this DB instance.</p>
|
|
6695
7013
|
* <p>If you do not specify a value for <code>DBParameterGroupName</code>, then Amazon RDS
|
|
6696
|
-
* uses the <code>DBParameterGroup</code> of source DB instance for a same
|
|
7014
|
+
* uses the <code>DBParameterGroup</code> of source DB instance for a same Region read
|
|
6697
7015
|
* replica, or the default <code>DBParameterGroup</code> for the specified DB engine for a
|
|
6698
|
-
* cross
|
|
7016
|
+
* cross-Region read replica.</p>
|
|
6699
7017
|
* <p>Specifying a parameter group for this operation is only supported for Oracle DB instances. It
|
|
6700
7018
|
* isn't supported for RDS Custom.</p>
|
|
6701
7019
|
* <p>Constraints:</p>
|
|
@@ -6714,9 +7032,12 @@ export interface CreateDBInstanceReadReplicaMessage {
|
|
|
6714
7032
|
DBParameterGroupName?: string;
|
|
6715
7033
|
/**
|
|
6716
7034
|
* <p>A value that indicates whether the DB instance is publicly accessible.</p>
|
|
6717
|
-
* <p>When the DB
|
|
6718
|
-
*
|
|
6719
|
-
*
|
|
7035
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
7036
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
7037
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
7038
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
7039
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
7040
|
+
* it.</p>
|
|
6720
7041
|
* <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>
|
|
6721
7042
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
6722
7043
|
*/
|
|
@@ -6887,14 +7208,14 @@ export interface CreateDBInstanceReadReplicaMessage {
|
|
|
6887
7208
|
* for the operation that can be executed in the source Amazon Web Services Region.</p>
|
|
6888
7209
|
* <p>
|
|
6889
7210
|
* <code>SourceRegion</code> isn't supported for SQL Server, because SQL Server on Amazon RDS
|
|
6890
|
-
* doesn't support cross-
|
|
7211
|
+
* doesn't support cross-Region read replicas.</p>
|
|
6891
7212
|
* </note>
|
|
6892
7213
|
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6893
7214
|
*/
|
|
6894
7215
|
PreSignedUrl?: string;
|
|
6895
7216
|
/**
|
|
6896
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
6897
|
-
*
|
|
7217
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
7218
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
6898
7219
|
*
|
|
6899
7220
|
* <p>For more information about IAM database authentication, see
|
|
6900
7221
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
@@ -6947,7 +7268,7 @@ export interface CreateDBInstanceReadReplicaMessage {
|
|
|
6947
7268
|
/**
|
|
6948
7269
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
6949
7270
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6950
|
-
* deletion protection
|
|
7271
|
+
* deletion protection isn't enabled. For more information, see
|
|
6951
7272
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
6952
7273
|
* Deleting a DB Instance</a>.
|
|
6953
7274
|
* </p>
|
|
@@ -7022,7 +7343,11 @@ export interface CreateDBInstanceReadReplicaResult {
|
|
|
7022
7343
|
/**
|
|
7023
7344
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7024
7345
|
* </p>
|
|
7025
|
-
* <p>This data type is used as a response element in the <code>
|
|
7346
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
7347
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
7348
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
7349
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
7350
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7026
7351
|
* </p>
|
|
7027
7352
|
*/
|
|
7028
7353
|
DBInstance?: DBInstance;
|
|
@@ -7107,7 +7432,7 @@ export interface CreateDBParameterGroupMessage {
|
|
|
7107
7432
|
* </li>
|
|
7108
7433
|
* <li>
|
|
7109
7434
|
* <p>
|
|
7110
|
-
* <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora)</p>
|
|
7435
|
+
* <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
|
|
7111
7436
|
* </li>
|
|
7112
7437
|
* <li>
|
|
7113
7438
|
* <p>
|
|
@@ -8571,11 +8896,28 @@ export declare namespace DeleteDBClusterMessage {
|
|
|
8571
8896
|
}
|
|
8572
8897
|
export interface DeleteDBClusterResult {
|
|
8573
8898
|
/**
|
|
8574
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
8575
|
-
* </p>
|
|
8576
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
8577
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
8899
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
8578
8900
|
* </p>
|
|
8901
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
8902
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8903
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
8904
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
8905
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
8906
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
8907
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8908
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
8909
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
8910
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
8911
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
8912
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
8913
|
+
* </p>
|
|
8914
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
8915
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
8916
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
8917
|
+
* </p>
|
|
8918
|
+
* <note>
|
|
8919
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
8920
|
+
* </note>
|
|
8579
8921
|
*/
|
|
8580
8922
|
DBCluster?: DBCluster;
|
|
8581
8923
|
}
|
|
@@ -8787,7 +9129,11 @@ export interface DeleteDBInstanceResult {
|
|
|
8787
9129
|
/**
|
|
8788
9130
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
8789
9131
|
* </p>
|
|
8790
|
-
* <p>This data type is used as a response element in the <code>
|
|
9132
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
9133
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
9134
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
9135
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
9136
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
8791
9137
|
* </p>
|
|
8792
9138
|
*/
|
|
8793
9139
|
DBInstance?: DBInstance;
|
|
@@ -8988,6 +9334,10 @@ export interface DBInstanceAutomatedBackup {
|
|
|
8988
9334
|
* <p>The list of replications to different Amazon Web Services Regions associated with the automated backup.</p>
|
|
8989
9335
|
*/
|
|
8990
9336
|
DBInstanceAutomatedBackupsReplications?: DBInstanceAutomatedBackupsReplication[];
|
|
9337
|
+
/**
|
|
9338
|
+
* <p>Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.</p>
|
|
9339
|
+
*/
|
|
9340
|
+
BackupTarget?: string;
|
|
8991
9341
|
}
|
|
8992
9342
|
export declare namespace DBInstanceAutomatedBackup {
|
|
8993
9343
|
/**
|
|
@@ -10504,7 +10854,7 @@ export interface DescribeDBEngineVersionsMessage {
|
|
|
10504
10854
|
* </li>
|
|
10505
10855
|
* <li>
|
|
10506
10856
|
* <p>
|
|
10507
|
-
* <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora)</p>
|
|
10857
|
+
* <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
|
|
10508
10858
|
* </li>
|
|
10509
10859
|
* <li>
|
|
10510
10860
|
* <p>
|