@aws-sdk/client-rds 3.358.0 → 3.360.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/dist-types/commands/DescribeDBClustersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +952 -977
- package/dist-types/models/models_1.d.ts +461 -366
- package/package.json +8 -8
|
@@ -3150,35 +3150,37 @@ export interface CreateDBClusterMessage {
|
|
|
3150
3150
|
* <p>For information on Amazon Web Services Regions and Availability Zones, see
|
|
3151
3151
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html">Choosing the Regions and
|
|
3152
3152
|
* Availability Zones</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3153
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3153
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3154
3154
|
*/
|
|
3155
3155
|
AvailabilityZones?: string[];
|
|
3156
3156
|
/**
|
|
3157
3157
|
* <p>The number of days for which automated backups are retained.</p>
|
|
3158
|
-
* <p>
|
|
3158
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3159
|
+
* <p>Default: <code>1</code>
|
|
3160
|
+
* </p>
|
|
3159
3161
|
* <p>Constraints:</p>
|
|
3160
3162
|
* <ul>
|
|
3161
3163
|
* <li>
|
|
3162
|
-
* <p>Must be a value from 1 to 35
|
|
3164
|
+
* <p>Must be a value from 1 to 35.</p>
|
|
3163
3165
|
* </li>
|
|
3164
3166
|
* </ul>
|
|
3165
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3166
3167
|
*/
|
|
3167
3168
|
BackupRetentionPeriod?: number;
|
|
3168
3169
|
/**
|
|
3169
|
-
* <p>
|
|
3170
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3170
|
+
* <p>The name of the character set (<code>CharacterSet</code>) to associate the DB cluster with.</p>
|
|
3171
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3171
3172
|
*/
|
|
3172
3173
|
CharacterSetName?: string;
|
|
3173
3174
|
/**
|
|
3174
|
-
* <p>The name for your database of up to 64 alphanumeric characters. If you
|
|
3175
|
+
* <p>The name for your database of up to 64 alphanumeric characters. If you don't
|
|
3175
3176
|
* provide a name, Amazon RDS doesn't create a database in the DB cluster you are
|
|
3176
3177
|
* creating.</p>
|
|
3177
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3178
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3178
3179
|
*/
|
|
3179
3180
|
DatabaseName?: string;
|
|
3180
3181
|
/**
|
|
3181
|
-
* <p>The DB cluster
|
|
3182
|
+
* <p>The identifier for this DB cluster. This parameter is stored as a lowercase string.</p>
|
|
3183
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3182
3184
|
* <p>Constraints:</p>
|
|
3183
3185
|
* <ul>
|
|
3184
3186
|
* <li>
|
|
@@ -3193,62 +3195,48 @@ export interface CreateDBClusterMessage {
|
|
|
3193
3195
|
* </ul>
|
|
3194
3196
|
* <p>Example: <code>my-cluster1</code>
|
|
3195
3197
|
* </p>
|
|
3196
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3197
3198
|
*/
|
|
3198
3199
|
DBClusterIdentifier: string | undefined;
|
|
3199
3200
|
/**
|
|
3200
3201
|
* <p>The name of the DB cluster parameter group to associate
|
|
3201
|
-
* with this DB cluster. If you
|
|
3202
|
+
* with this DB cluster. If you don't specify a value, then
|
|
3202
3203
|
* the default DB cluster parameter group for the specified DB engine and version is used.</p>
|
|
3204
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3203
3205
|
* <p>Constraints:</p>
|
|
3204
3206
|
* <ul>
|
|
3205
3207
|
* <li>
|
|
3206
3208
|
* <p>If supplied, must match the name of an existing DB cluster parameter group.</p>
|
|
3207
3209
|
* </li>
|
|
3208
3210
|
* </ul>
|
|
3209
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3210
3211
|
*/
|
|
3211
3212
|
DBClusterParameterGroupName?: string;
|
|
3212
3213
|
/**
|
|
3213
3214
|
* <p>A list of EC2 VPC security groups to associate with this DB cluster.</p>
|
|
3214
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3215
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3215
3216
|
*/
|
|
3216
3217
|
VpcSecurityGroupIds?: string[];
|
|
3217
3218
|
/**
|
|
3218
3219
|
* <p>A DB subnet group to associate with this DB cluster.</p>
|
|
3219
3220
|
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3220
|
-
* <p>
|
|
3221
|
-
* <p>
|
|
3222
|
-
* </p>
|
|
3223
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3224
|
-
*/
|
|
3225
|
-
DBSubnetGroupName?: string;
|
|
3226
|
-
/**
|
|
3227
|
-
* <p>The name of the database engine to be used for this DB cluster.</p>
|
|
3228
|
-
* <p>Valid Values:</p>
|
|
3221
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3222
|
+
* <p>Constraints:</p>
|
|
3229
3223
|
* <ul>
|
|
3230
3224
|
* <li>
|
|
3231
|
-
* <p>
|
|
3232
|
-
* <code>aurora-mysql</code>
|
|
3233
|
-
* </p>
|
|
3234
|
-
* </li>
|
|
3235
|
-
* <li>
|
|
3236
|
-
* <p>
|
|
3237
|
-
* <code>aurora-postgresql</code>
|
|
3238
|
-
* </p>
|
|
3239
|
-
* </li>
|
|
3240
|
-
* <li>
|
|
3241
|
-
* <p>
|
|
3242
|
-
* <code>mysql</code>
|
|
3243
|
-
* </p>
|
|
3225
|
+
* <p>Must match the name of an existing DB subnet group.</p>
|
|
3244
3226
|
* </li>
|
|
3245
3227
|
* <li>
|
|
3246
|
-
* <p>
|
|
3247
|
-
* <code>postgres</code>
|
|
3248
|
-
* </p>
|
|
3228
|
+
* <p>Must not be <code>default</code>.</p>
|
|
3249
3229
|
* </li>
|
|
3250
3230
|
* </ul>
|
|
3251
|
-
* <p>
|
|
3231
|
+
* <p>Example: <code>mydbsubnetgroup</code>
|
|
3232
|
+
* </p>
|
|
3233
|
+
*/
|
|
3234
|
+
DBSubnetGroupName?: string;
|
|
3235
|
+
/**
|
|
3236
|
+
* <p>The database engine to use for this DB cluster.</p>
|
|
3237
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3238
|
+
* <p>Valid Values: <code>aurora-mysql | aurora-postgresql | mysql | postgres</code>
|
|
3239
|
+
* </p>
|
|
3252
3240
|
*/
|
|
3253
3241
|
Engine: string | undefined;
|
|
3254
3242
|
/**
|
|
@@ -3272,48 +3260,47 @@ export interface CreateDBClusterMessage {
|
|
|
3272
3260
|
* <p>
|
|
3273
3261
|
* <code>aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"</code>
|
|
3274
3262
|
* </p>
|
|
3275
|
-
* <p>
|
|
3276
|
-
*
|
|
3277
|
-
*
|
|
3278
|
-
*
|
|
3263
|
+
* <p>For information about a specific engine, see the following topics:</p>
|
|
3264
|
+
* <ul>
|
|
3265
|
+
* <li>
|
|
3266
|
+
* <p>Aurora MySQL - see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html">Database engine updates for Amazon Aurora MySQL</a> in the
|
|
3279
3267
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
3280
|
-
*
|
|
3281
|
-
* <
|
|
3282
|
-
*
|
|
3283
|
-
* <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
|
|
3268
|
+
* </li>
|
|
3269
|
+
* <li>
|
|
3270
|
+
* <p>Aurora PostgreSQL - 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
|
|
3284
3271
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
3285
|
-
*
|
|
3286
|
-
* <
|
|
3287
|
-
*
|
|
3288
|
-
*
|
|
3289
|
-
*
|
|
3290
|
-
*
|
|
3291
|
-
*
|
|
3292
|
-
*
|
|
3293
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3272
|
+
* </li>
|
|
3273
|
+
* <li>
|
|
3274
|
+
* <p>RDS for MySQL - see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt">Amazon RDS for MySQL</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3275
|
+
* </li>
|
|
3276
|
+
* <li>
|
|
3277
|
+
* <p>RDS for PostgreSQL - see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts">Amazon RDS for PostgreSQL</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3278
|
+
* </li>
|
|
3279
|
+
* </ul>
|
|
3280
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3294
3281
|
*/
|
|
3295
3282
|
EngineVersion?: string;
|
|
3296
3283
|
/**
|
|
3297
3284
|
* <p>The port number on which the instances in the DB cluster accept connections.</p>
|
|
3298
|
-
* <p>
|
|
3299
|
-
*
|
|
3300
|
-
* </p>
|
|
3301
|
-
* <p>Default: <code>3306</code>
|
|
3302
|
-
* </p>
|
|
3303
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
3304
|
-
* </p>
|
|
3305
|
-
* <p>
|
|
3306
|
-
* <b>RDS for PostgreSQL and Aurora PostgreSQL</b>
|
|
3307
|
-
* </p>
|
|
3308
|
-
* <p>Default: <code>5432</code>
|
|
3309
|
-
* </p>
|
|
3310
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
3285
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3286
|
+
* <p>Valid Values: <code>1150-65535</code>
|
|
3311
3287
|
* </p>
|
|
3312
|
-
* <p>
|
|
3288
|
+
* <p>Default:</p>
|
|
3289
|
+
* <ul>
|
|
3290
|
+
* <li>
|
|
3291
|
+
* <p>RDS for MySQL and Aurora MySQL - <code>3306</code>
|
|
3292
|
+
* </p>
|
|
3293
|
+
* </li>
|
|
3294
|
+
* <li>
|
|
3295
|
+
* <p>RDS for PostgreSQL and Aurora PostgreSQL - <code>5432</code>
|
|
3296
|
+
* </p>
|
|
3297
|
+
* </li>
|
|
3298
|
+
* </ul>
|
|
3313
3299
|
*/
|
|
3314
3300
|
Port?: number;
|
|
3315
3301
|
/**
|
|
3316
3302
|
* <p>The name of the master user for the DB cluster.</p>
|
|
3303
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3317
3304
|
* <p>Constraints:</p>
|
|
3318
3305
|
* <ul>
|
|
3319
3306
|
* <li>
|
|
@@ -3326,25 +3313,27 @@ export interface CreateDBClusterMessage {
|
|
|
3326
3313
|
* <p>Can't be a reserved word for the chosen database engine.</p>
|
|
3327
3314
|
* </li>
|
|
3328
3315
|
* </ul>
|
|
3329
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3330
3316
|
*/
|
|
3331
3317
|
MasterUsername?: string;
|
|
3332
3318
|
/**
|
|
3333
|
-
* <p>The password for the master database user
|
|
3319
|
+
* <p>The password for the master database user.</p>
|
|
3320
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3334
3321
|
* <p>Constraints:</p>
|
|
3335
3322
|
* <ul>
|
|
3336
3323
|
* <li>
|
|
3337
3324
|
* <p>Must contain from 8 to 41 characters.</p>
|
|
3338
3325
|
* </li>
|
|
3339
3326
|
* <li>
|
|
3327
|
+
* <p>Can contain any printable ASCII character except "/", """, or "@".</p>
|
|
3328
|
+
* </li>
|
|
3329
|
+
* <li>
|
|
3340
3330
|
* <p>Can't be specified if <code>ManageMasterUserPassword</code> is turned on.</p>
|
|
3341
3331
|
* </li>
|
|
3342
3332
|
* </ul>
|
|
3343
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3344
3333
|
*/
|
|
3345
3334
|
MasterUserPassword?: string;
|
|
3346
3335
|
/**
|
|
3347
|
-
* <p>
|
|
3336
|
+
* <p>The option group to associate the DB cluster with.</p>
|
|
3348
3337
|
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
3349
3338
|
*/
|
|
3350
3339
|
OptionGroupName?: string;
|
|
@@ -3352,6 +3341,7 @@ export interface CreateDBClusterMessage {
|
|
|
3352
3341
|
* <p>The daily time range during which automated backups are created
|
|
3353
3342
|
* if automated backups are enabled
|
|
3354
3343
|
* using the <code>BackupRetentionPeriod</code> parameter.</p>
|
|
3344
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3355
3345
|
* <p>The default is a 30-minute window selected at random from an
|
|
3356
3346
|
* 8-hour block of time for each Amazon Web Services Region.
|
|
3357
3347
|
* To view the time blocks available, see
|
|
@@ -3372,37 +3362,47 @@ export interface CreateDBClusterMessage {
|
|
|
3372
3362
|
* <p>Must be at least 30 minutes.</p>
|
|
3373
3363
|
* </li>
|
|
3374
3364
|
* </ul>
|
|
3375
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3376
3365
|
*/
|
|
3377
3366
|
PreferredBackupWindow?: string;
|
|
3378
3367
|
/**
|
|
3379
|
-
* <p>The weekly time range during which system maintenance can occur
|
|
3380
|
-
* <p>
|
|
3381
|
-
* </p>
|
|
3368
|
+
* <p>The weekly time range during which system maintenance can occur.</p>
|
|
3369
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3382
3370
|
* <p>The default is a 30-minute window selected at random from an
|
|
3383
3371
|
* 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the
|
|
3384
3372
|
* week. To see the time blocks available, see
|
|
3385
3373
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora">
|
|
3386
3374
|
* Adjusting the Preferred DB Cluster Maintenance Window</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3387
|
-
* <p>
|
|
3388
|
-
* <
|
|
3389
|
-
*
|
|
3375
|
+
* <p>Constraints:</p>
|
|
3376
|
+
* <ul>
|
|
3377
|
+
* <li>
|
|
3378
|
+
* <p>Must be in the format <code>ddd:hh24:mi-ddd:hh24:mi</code>.</p>
|
|
3379
|
+
* </li>
|
|
3380
|
+
* <li>
|
|
3381
|
+
* <p>Days must be one of <code>Mon | Tue | Wed | Thu | Fri | Sat | Sun</code>.</p>
|
|
3382
|
+
* </li>
|
|
3383
|
+
* <li>
|
|
3384
|
+
* <p>Must be in Universal Coordinated Time (UTC).</p>
|
|
3385
|
+
* </li>
|
|
3386
|
+
* <li>
|
|
3387
|
+
* <p>Must be at least 30 minutes.</p>
|
|
3388
|
+
* </li>
|
|
3389
|
+
* </ul>
|
|
3390
3390
|
*/
|
|
3391
3391
|
PreferredMaintenanceWindow?: string;
|
|
3392
3392
|
/**
|
|
3393
3393
|
* <p>The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB
|
|
3394
3394
|
* cluster is created as a read replica.</p>
|
|
3395
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3395
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3396
3396
|
*/
|
|
3397
3397
|
ReplicationSourceIdentifier?: string;
|
|
3398
3398
|
/**
|
|
3399
3399
|
* <p>Tags to assign to the DB cluster.</p>
|
|
3400
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3400
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3401
3401
|
*/
|
|
3402
3402
|
Tags?: Tag[];
|
|
3403
3403
|
/**
|
|
3404
|
-
* <p>
|
|
3405
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3404
|
+
* <p>Specifies whether the DB cluster is encrypted.</p>
|
|
3405
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3406
3406
|
*/
|
|
3407
3407
|
StorageEncrypted?: boolean;
|
|
3408
3408
|
/**
|
|
@@ -3413,21 +3413,21 @@ export interface CreateDBClusterMessage {
|
|
|
3413
3413
|
* <ul>
|
|
3414
3414
|
* <li>
|
|
3415
3415
|
* <p>If <code>ReplicationSourceIdentifier</code> identifies an encrypted
|
|
3416
|
-
* source, then Amazon RDS
|
|
3417
|
-
* source. Otherwise, Amazon RDS
|
|
3416
|
+
* source, then Amazon RDS uses the KMS key used to encrypt the
|
|
3417
|
+
* source. Otherwise, Amazon RDS uses your default KMS key.</p>
|
|
3418
3418
|
* </li>
|
|
3419
3419
|
* <li>
|
|
3420
3420
|
* <p>If the <code>StorageEncrypted</code> parameter is enabled and
|
|
3421
3421
|
* <code>ReplicationSourceIdentifier</code> isn't specified, then Amazon RDS
|
|
3422
|
-
*
|
|
3422
|
+
* uses your default KMS key.</p>
|
|
3423
3423
|
* </li>
|
|
3424
3424
|
* </ul>
|
|
3425
3425
|
* <p>There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account
|
|
3426
3426
|
* has a different default KMS key for each Amazon Web Services Region.</p>
|
|
3427
|
-
* <p>If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region,
|
|
3428
|
-
*
|
|
3427
|
+
* <p>If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make
|
|
3428
|
+
* sure to set <code>KmsKeyId</code> to a KMS key identifier that is valid in the destination Amazon Web Services
|
|
3429
3429
|
* Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.</p>
|
|
3430
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3430
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3431
3431
|
*/
|
|
3432
3432
|
KmsKeyId?: string;
|
|
3433
3433
|
/**
|
|
@@ -3474,54 +3474,57 @@ export interface CreateDBClusterMessage {
|
|
|
3474
3474
|
* <code>SourceRegion</code> autogenerates a presigned URL that is a valid request
|
|
3475
3475
|
* for the operation that can run in the source Amazon Web Services Region.</p>
|
|
3476
3476
|
* </note>
|
|
3477
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3477
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3478
3478
|
*/
|
|
3479
3479
|
PreSignedUrl?: string;
|
|
3480
3480
|
/**
|
|
3481
|
-
* <p>
|
|
3481
|
+
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
|
|
3482
3482
|
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
3483
3483
|
* enabled.</p>
|
|
3484
3484
|
* <p>For more information, see
|
|
3485
3485
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
3486
3486
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3487
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3487
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3488
3488
|
*/
|
|
3489
3489
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
3490
3490
|
/**
|
|
3491
3491
|
* <p>The target backtrack window, in seconds. To disable backtracking, set this value to
|
|
3492
|
-
* 0
|
|
3493
|
-
* <p>
|
|
3492
|
+
* <code>0</code>.</p>
|
|
3493
|
+
* <p>Valid for Cluster Type: Aurora MySQL DB clusters only</p>
|
|
3494
|
+
* <p>Default: <code>0</code>
|
|
3495
|
+
* </p>
|
|
3494
3496
|
* <p>Constraints:</p>
|
|
3495
3497
|
* <ul>
|
|
3496
3498
|
* <li>
|
|
3497
3499
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
3498
3500
|
* </li>
|
|
3499
3501
|
* </ul>
|
|
3500
|
-
* <p>Valid for: Aurora MySQL DB clusters only</p>
|
|
3501
3502
|
*/
|
|
3502
3503
|
BacktrackWindow?: number;
|
|
3503
3504
|
/**
|
|
3504
|
-
* <p>The list of log types that need to be enabled for exporting to CloudWatch Logs
|
|
3505
|
-
*
|
|
3506
|
-
* <p>
|
|
3507
|
-
*
|
|
3508
|
-
*
|
|
3509
|
-
*
|
|
3510
|
-
*
|
|
3511
|
-
*
|
|
3512
|
-
*
|
|
3513
|
-
*
|
|
3514
|
-
*
|
|
3515
|
-
*
|
|
3516
|
-
*
|
|
3517
|
-
*
|
|
3518
|
-
*
|
|
3519
|
-
*
|
|
3520
|
-
*
|
|
3521
|
-
*
|
|
3505
|
+
* <p>The list of log types that need to be enabled for exporting to CloudWatch Logs.</p>
|
|
3506
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3507
|
+
* <p>The following values are valid for each DB engine:</p>
|
|
3508
|
+
* <ul>
|
|
3509
|
+
* <li>
|
|
3510
|
+
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
|
|
3511
|
+
* </p>
|
|
3512
|
+
* </li>
|
|
3513
|
+
* <li>
|
|
3514
|
+
* <p>Aurora PostgreSQL - <code>postgresql</code>
|
|
3515
|
+
* </p>
|
|
3516
|
+
* </li>
|
|
3517
|
+
* <li>
|
|
3518
|
+
* <p>RDS for MySQL - <code>error | general | slowquery</code>
|
|
3519
|
+
* </p>
|
|
3520
|
+
* </li>
|
|
3521
|
+
* <li>
|
|
3522
|
+
* <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
|
|
3523
|
+
* </p>
|
|
3524
|
+
* </li>
|
|
3525
|
+
* </ul>
|
|
3522
3526
|
* <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3523
3527
|
* <p>For more information about exporting CloudWatch Logs for Amazon Aurora, 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>
|
|
3524
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3525
3528
|
*/
|
|
3526
3529
|
EnableCloudwatchLogsExports?: string[];
|
|
3527
3530
|
/**
|
|
@@ -3543,42 +3546,42 @@ export interface CreateDBClusterMessage {
|
|
|
3543
3546
|
* </p>
|
|
3544
3547
|
* </li>
|
|
3545
3548
|
* </ul>
|
|
3546
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3549
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3547
3550
|
*/
|
|
3548
3551
|
EngineMode?: string;
|
|
3549
3552
|
/**
|
|
3550
3553
|
* <p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>
|
|
3551
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3554
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3552
3555
|
*/
|
|
3553
3556
|
ScalingConfiguration?: ScalingConfiguration;
|
|
3554
3557
|
/**
|
|
3555
|
-
* <p>
|
|
3558
|
+
* <p>Specifies whether the DB cluster has deletion protection enabled.
|
|
3556
3559
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
3557
3560
|
* deletion protection isn't enabled.</p>
|
|
3558
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3561
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3559
3562
|
*/
|
|
3560
3563
|
DeletionProtection?: boolean;
|
|
3561
3564
|
/**
|
|
3562
3565
|
* <p>The global cluster ID of an Aurora cluster that becomes the primary cluster
|
|
3563
3566
|
* in the new global database cluster.</p>
|
|
3564
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3567
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3565
3568
|
*/
|
|
3566
3569
|
GlobalClusterIdentifier?: string;
|
|
3567
3570
|
/**
|
|
3568
|
-
* <p>
|
|
3571
|
+
* <p>Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint
|
|
3569
3572
|
* is disabled.</p>
|
|
3570
3573
|
* <p>When enabled, the HTTP endpoint provides a connectionless web service API for running
|
|
3571
3574
|
* SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database
|
|
3572
3575
|
* from inside the RDS console with the query editor.</p>
|
|
3573
3576
|
* <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 v1</a> in the
|
|
3574
3577
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
3575
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3578
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3576
3579
|
*/
|
|
3577
3580
|
EnableHttpEndpoint?: boolean;
|
|
3578
3581
|
/**
|
|
3579
|
-
* <p>
|
|
3582
|
+
* <p>Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
|
3580
3583
|
* The default is not to copy them.</p>
|
|
3581
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3584
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3582
3585
|
*/
|
|
3583
3586
|
CopyTagsToSnapshot?: boolean;
|
|
3584
3587
|
/**
|
|
@@ -3586,48 +3589,68 @@ export interface CreateDBClusterMessage {
|
|
|
3586
3589
|
* <p>For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.</p>
|
|
3587
3590
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html">Kerberos authentication</a>
|
|
3588
3591
|
* in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3589
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3592
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3590
3593
|
*/
|
|
3591
3594
|
Domain?: string;
|
|
3592
3595
|
/**
|
|
3593
|
-
* <p>
|
|
3594
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3596
|
+
* <p>The name of the IAM role to use when making API calls to the Directory Service.</p>
|
|
3597
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3595
3598
|
*/
|
|
3596
3599
|
DomainIAMRoleName?: string;
|
|
3597
3600
|
/**
|
|
3598
|
-
* <p>
|
|
3599
|
-
* Aurora global database
|
|
3601
|
+
* <p>Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster
|
|
3602
|
+
* (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that
|
|
3600
3603
|
* are secondary clusters in an Aurora global database.</p>
|
|
3601
3604
|
* <p>You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter
|
|
3602
|
-
* enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to
|
|
3605
|
+
* enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to
|
|
3603
3606
|
* this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the
|
|
3604
|
-
* primary is demoted by
|
|
3605
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3607
|
+
* primary is demoted by a global cluster API operation, but it does nothing until then.</p>
|
|
3608
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3606
3609
|
*/
|
|
3607
3610
|
EnableGlobalWriteForwarding?: boolean;
|
|
3608
3611
|
/**
|
|
3609
|
-
* <p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge
|
|
3612
|
+
* <p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example <code>db.m6gd.xlarge</code>.
|
|
3610
3613
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p>
|
|
3611
3614
|
* <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>.</p>
|
|
3612
3615
|
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3613
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3616
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3614
3617
|
*/
|
|
3615
3618
|
DBClusterInstanceClass?: string;
|
|
3616
3619
|
/**
|
|
3617
3620
|
* <p>The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.</p>
|
|
3621
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3618
3622
|
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3619
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3620
3623
|
*/
|
|
3621
3624
|
AllocatedStorage?: number;
|
|
3622
3625
|
/**
|
|
3623
|
-
* <p>
|
|
3626
|
+
* <p>The storage type to associate with the DB cluster.</p>
|
|
3627
|
+
* <p>For information on storage types for Aurora DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type">Storage configurations for Amazon Aurora DB clusters</a>. For information on storage types for Multi-AZ DB
|
|
3628
|
+
* clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings">Settings for creating Multi-AZ DB clusters</a>.</p>
|
|
3624
3629
|
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3625
3630
|
* <p>When specified for a Multi-AZ DB cluster, a value for the <code>Iops</code> parameter is required.</p>
|
|
3626
|
-
* <p>Valid
|
|
3627
|
-
* <p>
|
|
3628
|
-
* <
|
|
3629
|
-
*
|
|
3630
|
-
*
|
|
3631
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3632
|
+
* <p>Valid Values:</p>
|
|
3633
|
+
* <ul>
|
|
3634
|
+
* <li>
|
|
3635
|
+
* <p>Aurora DB clusters - <code>aurora | aurora-iopt1</code>
|
|
3636
|
+
* </p>
|
|
3637
|
+
* </li>
|
|
3638
|
+
* <li>
|
|
3639
|
+
* <p>Multi-AZ DB clusters - <code>io1</code>
|
|
3640
|
+
* </p>
|
|
3641
|
+
* </li>
|
|
3642
|
+
* </ul>
|
|
3643
|
+
* <p>Default:</p>
|
|
3644
|
+
* <ul>
|
|
3645
|
+
* <li>
|
|
3646
|
+
* <p>Aurora DB clusters - <code>aurora</code>
|
|
3647
|
+
* </p>
|
|
3648
|
+
* </li>
|
|
3649
|
+
* <li>
|
|
3650
|
+
* <p>Multi-AZ DB clusters - <code>io1</code>
|
|
3651
|
+
* </p>
|
|
3652
|
+
* </li>
|
|
3653
|
+
* </ul>
|
|
3631
3654
|
*/
|
|
3632
3655
|
StorageType?: string;
|
|
3633
3656
|
/**
|
|
@@ -3636,12 +3659,17 @@ export interface CreateDBClusterMessage {
|
|
|
3636
3659
|
* <p>For information about valid IOPS values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS">Provisioned IOPS storage</a> in the <i>Amazon RDS
|
|
3637
3660
|
* User Guide</i>.</p>
|
|
3638
3661
|
* <p>This setting is required to create a Multi-AZ DB cluster.</p>
|
|
3639
|
-
* <p>
|
|
3640
|
-
* <p>
|
|
3662
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3663
|
+
* <p>Constraints:</p>
|
|
3664
|
+
* <ul>
|
|
3665
|
+
* <li>
|
|
3666
|
+
* <p>Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p>
|
|
3667
|
+
* </li>
|
|
3668
|
+
* </ul>
|
|
3641
3669
|
*/
|
|
3642
3670
|
Iops?: number;
|
|
3643
3671
|
/**
|
|
3644
|
-
* <p>
|
|
3672
|
+
* <p>Specifies whether the DB cluster is publicly accessible.</p>
|
|
3645
3673
|
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
3646
3674
|
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
3647
3675
|
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
@@ -3649,6 +3677,7 @@ export interface CreateDBClusterMessage {
|
|
|
3649
3677
|
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
3650
3678
|
* it.</p>
|
|
3651
3679
|
* <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>
|
|
3680
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3652
3681
|
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
|
|
3653
3682
|
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
3654
3683
|
* <ul>
|
|
@@ -3668,23 +3697,24 @@ export interface CreateDBClusterMessage {
|
|
|
3668
3697
|
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.</p>
|
|
3669
3698
|
* </li>
|
|
3670
3699
|
* </ul>
|
|
3671
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3672
3700
|
*/
|
|
3673
3701
|
PubliclyAccessible?: boolean;
|
|
3674
3702
|
/**
|
|
3675
|
-
* <p>
|
|
3703
|
+
* <p>Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
|
|
3676
3704
|
* By default, minor engine upgrades are applied automatically.</p>
|
|
3677
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3705
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3678
3706
|
*/
|
|
3679
3707
|
AutoMinorVersionUpgrade?: boolean;
|
|
3680
3708
|
/**
|
|
3681
3709
|
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off
|
|
3682
|
-
* collecting Enhanced Monitoring metrics, specify 0
|
|
3710
|
+
* collecting Enhanced Monitoring metrics, specify <code>0</code>.</p>
|
|
3683
3711
|
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code>
|
|
3684
|
-
* to a value other than 0
|
|
3685
|
-
* <p>Valid
|
|
3712
|
+
* to a value other than <code>0</code>.</p>
|
|
3713
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3714
|
+
* <p>Valid Values: <code>0 | 1 | 5 | 10 | 15 | 30 | 60</code>
|
|
3715
|
+
* </p>
|
|
3716
|
+
* <p>Default: <code>0</code>
|
|
3686
3717
|
* </p>
|
|
3687
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3688
3718
|
*/
|
|
3689
3719
|
MonitoringInterval?: number;
|
|
3690
3720
|
/**
|
|
@@ -3692,15 +3722,15 @@ export interface CreateDBClusterMessage {
|
|
|
3692
3722
|
* An example is <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role,
|
|
3693
3723
|
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling">Setting
|
|
3694
3724
|
* up and enabling Enhanced Monitoring</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3695
|
-
* <p>If <code>MonitoringInterval</code> is set to a value other than 0
|
|
3696
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3725
|
+
* <p>If <code>MonitoringInterval</code> is set to a value other than <code>0</code>, supply a <code>MonitoringRoleArn</code> value.</p>
|
|
3726
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3697
3727
|
*/
|
|
3698
3728
|
MonitoringRoleArn?: string;
|
|
3699
3729
|
/**
|
|
3700
|
-
* <p>
|
|
3730
|
+
* <p>Specifies whether to turn on Performance Insights for the DB cluster.</p>
|
|
3701
3731
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
|
|
3702
3732
|
* Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3703
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3733
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3704
3734
|
*/
|
|
3705
3735
|
EnablePerformanceInsights?: boolean;
|
|
3706
3736
|
/**
|
|
@@ -3709,40 +3739,32 @@ export interface CreateDBClusterMessage {
|
|
|
3709
3739
|
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
3710
3740
|
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
3711
3741
|
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
3712
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3742
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3713
3743
|
*/
|
|
3714
3744
|
PerformanceInsightsKMSKeyId?: string;
|
|
3715
3745
|
/**
|
|
3716
|
-
* <p>The number of days to retain Performance Insights data
|
|
3746
|
+
* <p>The number of days to retain Performance Insights data.</p>
|
|
3747
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3748
|
+
* <p>Valid Values:</p>
|
|
3717
3749
|
* <ul>
|
|
3718
3750
|
* <li>
|
|
3719
|
-
* <p>7</p>
|
|
3720
|
-
* </li>
|
|
3721
|
-
* <li>
|
|
3722
3751
|
* <p>
|
|
3723
|
-
* <
|
|
3724
|
-
*
|
|
3725
|
-
* <li>
|
|
3726
|
-
* <p>731</p>
|
|
3727
|
-
* </li>
|
|
3728
|
-
* </ul>
|
|
3729
|
-
* <p>For example, the following values are valid:</p>
|
|
3730
|
-
* <ul>
|
|
3731
|
-
* <li>
|
|
3732
|
-
* <p>93 (3 months * 31)</p>
|
|
3733
|
-
* </li>
|
|
3734
|
-
* <li>
|
|
3735
|
-
* <p>341 (11 months * 31)</p>
|
|
3752
|
+
* <code>7</code>
|
|
3753
|
+
* </p>
|
|
3736
3754
|
* </li>
|
|
3737
3755
|
* <li>
|
|
3738
|
-
* <p>
|
|
3756
|
+
* <p>
|
|
3757
|
+
* <i>month</i> * 31, where <i>month</i> is a number of months from 1-23.
|
|
3758
|
+
* Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31)</p>
|
|
3739
3759
|
* </li>
|
|
3740
3760
|
* <li>
|
|
3741
|
-
* <p>
|
|
3761
|
+
* <p>
|
|
3762
|
+
* <code>731</code>
|
|
3763
|
+
* </p>
|
|
3742
3764
|
* </li>
|
|
3743
3765
|
* </ul>
|
|
3744
|
-
* <p>
|
|
3745
|
-
* <p>
|
|
3766
|
+
* <p>Default: <code>7</code> days</p>
|
|
3767
|
+
* <p>If you specify a retention period that isn't valid, such as <code>94</code>, Amazon RDS issues an error.</p>
|
|
3746
3768
|
*/
|
|
3747
3769
|
PerformanceInsightsRetentionPeriod?: number;
|
|
3748
3770
|
/**
|
|
@@ -3753,19 +3775,6 @@ export interface CreateDBClusterMessage {
|
|
|
3753
3775
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
|
3754
3776
|
/**
|
|
3755
3777
|
* <p>The network type of the DB cluster.</p>
|
|
3756
|
-
* <p>Valid values:</p>
|
|
3757
|
-
* <ul>
|
|
3758
|
-
* <li>
|
|
3759
|
-
* <p>
|
|
3760
|
-
* <code>IPV4</code>
|
|
3761
|
-
* </p>
|
|
3762
|
-
* </li>
|
|
3763
|
-
* <li>
|
|
3764
|
-
* <p>
|
|
3765
|
-
* <code>DUAL</code>
|
|
3766
|
-
* </p>
|
|
3767
|
-
* </li>
|
|
3768
|
-
* </ul>
|
|
3769
3778
|
* <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the DB cluster.
|
|
3770
3779
|
* A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6
|
|
3771
3780
|
* protocols (<code>DUAL</code>).</p>
|
|
@@ -3773,7 +3782,9 @@ export interface CreateDBClusterMessage {
|
|
|
3773
3782
|
* Working with a DB instance in a VPC</a> in the
|
|
3774
3783
|
* <i>Amazon Aurora User Guide.</i>
|
|
3775
3784
|
* </p>
|
|
3776
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3785
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3786
|
+
* <p>Valid Values: <code>IPV4 | DUAL</code>
|
|
3787
|
+
* </p>
|
|
3777
3788
|
*/
|
|
3778
3789
|
NetworkType?: string;
|
|
3779
3790
|
/**
|
|
@@ -3781,11 +3792,12 @@ export interface CreateDBClusterMessage {
|
|
|
3781
3792
|
*/
|
|
3782
3793
|
DBSystemId?: string;
|
|
3783
3794
|
/**
|
|
3784
|
-
* <p>
|
|
3795
|
+
* <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.</p>
|
|
3785
3796
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a>
|
|
3786
3797
|
* in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a>
|
|
3787
3798
|
* in the <i>Amazon Aurora User Guide.</i>
|
|
3788
3799
|
* </p>
|
|
3800
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3789
3801
|
* <p>Constraints:</p>
|
|
3790
3802
|
* <ul>
|
|
3791
3803
|
* <li>
|
|
@@ -3793,7 +3805,6 @@ export interface CreateDBClusterMessage {
|
|
|
3793
3805
|
* is specified.</p>
|
|
3794
3806
|
* </li>
|
|
3795
3807
|
* </ul>
|
|
3796
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3797
3808
|
*/
|
|
3798
3809
|
ManageMasterUserPassword?: boolean;
|
|
3799
3810
|
/**
|
|
@@ -3809,7 +3820,7 @@ export interface CreateDBClusterMessage {
|
|
|
3809
3820
|
* managed KMS key.</p>
|
|
3810
3821
|
* <p>There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account
|
|
3811
3822
|
* has a different default KMS key for each Amazon Web Services Region.</p>
|
|
3812
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3823
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3813
3824
|
*/
|
|
3814
3825
|
MasterUserSecretKmsKeyId?: string;
|
|
3815
3826
|
}
|
|
@@ -4034,7 +4045,7 @@ export interface ClusterPendingModifiedValues {
|
|
|
4034
4045
|
}
|
|
4035
4046
|
/**
|
|
4036
4047
|
* @public
|
|
4037
|
-
* <p>
|
|
4048
|
+
* <p>The scaling configuration for an Aurora DB cluster in <code>serverless</code> DB engine mode.</p>
|
|
4038
4049
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html">Using Amazon Aurora Serverless v1</a> in the
|
|
4039
4050
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
4040
4051
|
*/
|
|
@@ -4077,7 +4088,7 @@ export interface ScalingConfigurationInfo {
|
|
|
4077
4088
|
}
|
|
4078
4089
|
/**
|
|
4079
4090
|
* @public
|
|
4080
|
-
* <p>
|
|
4091
|
+
* <p>The scaling configuration for an Aurora Serverless v2 DB cluster.</p>
|
|
4081
4092
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html">Using Amazon Aurora Serverless v2</a> in the
|
|
4082
4093
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
4083
4094
|
*/
|
|
@@ -4124,11 +4135,11 @@ export interface DBCluster {
|
|
|
4124
4135
|
*/
|
|
4125
4136
|
AllocatedStorage?: number;
|
|
4126
4137
|
/**
|
|
4127
|
-
* <p>
|
|
4138
|
+
* <p>The list of Availability Zones (AZs) where instances in the DB cluster can be created.</p>
|
|
4128
4139
|
*/
|
|
4129
4140
|
AvailabilityZones?: string[];
|
|
4130
4141
|
/**
|
|
4131
|
-
* <p>
|
|
4142
|
+
* <p>The number of days for which automatic DB snapshots are retained.</p>
|
|
4132
4143
|
*/
|
|
4133
4144
|
BackupRetentionPeriod?: number;
|
|
4134
4145
|
/**
|
|
@@ -4136,23 +4147,23 @@ export interface DBCluster {
|
|
|
4136
4147
|
*/
|
|
4137
4148
|
CharacterSetName?: string;
|
|
4138
4149
|
/**
|
|
4139
|
-
* <p>
|
|
4150
|
+
* <p>The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.</p>
|
|
4140
4151
|
*/
|
|
4141
4152
|
DatabaseName?: string;
|
|
4142
4153
|
/**
|
|
4143
|
-
* <p>
|
|
4154
|
+
* <p>The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.</p>
|
|
4144
4155
|
*/
|
|
4145
4156
|
DBClusterIdentifier?: string;
|
|
4146
4157
|
/**
|
|
4147
|
-
* <p>
|
|
4158
|
+
* <p>The name of the DB cluster parameter group for the DB cluster.</p>
|
|
4148
4159
|
*/
|
|
4149
4160
|
DBClusterParameterGroup?: string;
|
|
4150
4161
|
/**
|
|
4151
|
-
* <p>
|
|
4162
|
+
* <p>Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.</p>
|
|
4152
4163
|
*/
|
|
4153
4164
|
DBSubnetGroup?: string;
|
|
4154
4165
|
/**
|
|
4155
|
-
* <p>
|
|
4166
|
+
* <p>The current state of this DB cluster.</p>
|
|
4156
4167
|
*/
|
|
4157
4168
|
Status?: string;
|
|
4158
4169
|
/**
|
|
@@ -4160,7 +4171,7 @@ export interface DBCluster {
|
|
|
4160
4171
|
*/
|
|
4161
4172
|
AutomaticRestartTime?: Date;
|
|
4162
4173
|
/**
|
|
4163
|
-
* <p>
|
|
4174
|
+
* <p>The progress of the operation as a percentage.</p>
|
|
4164
4175
|
*/
|
|
4165
4176
|
PercentProgress?: string;
|
|
4166
4177
|
/**
|
|
@@ -4169,7 +4180,7 @@ export interface DBCluster {
|
|
|
4169
4180
|
*/
|
|
4170
4181
|
EarliestRestorableTime?: Date;
|
|
4171
4182
|
/**
|
|
4172
|
-
* <p>
|
|
4183
|
+
* <p>The connection endpoint for the primary instance of the DB cluster.</p>
|
|
4173
4184
|
*/
|
|
4174
4185
|
Endpoint?: string;
|
|
4175
4186
|
/**
|
|
@@ -4184,49 +4195,49 @@ export interface DBCluster {
|
|
|
4184
4195
|
*/
|
|
4185
4196
|
ReaderEndpoint?: string;
|
|
4186
4197
|
/**
|
|
4187
|
-
* <p>
|
|
4198
|
+
* <p>The custom endpoints associated with the DB cluster.</p>
|
|
4188
4199
|
*/
|
|
4189
4200
|
CustomEndpoints?: string[];
|
|
4190
4201
|
/**
|
|
4191
|
-
* <p>
|
|
4202
|
+
* <p>Indicates whether the DB cluster has instances in multiple Availability Zones.</p>
|
|
4192
4203
|
*/
|
|
4193
4204
|
MultiAZ?: boolean;
|
|
4194
4205
|
/**
|
|
4195
|
-
* <p>The
|
|
4206
|
+
* <p>The database engine used for this DB cluster.</p>
|
|
4196
4207
|
*/
|
|
4197
4208
|
Engine?: string;
|
|
4198
4209
|
/**
|
|
4199
|
-
* <p>
|
|
4210
|
+
* <p>The version of the database engine.</p>
|
|
4200
4211
|
*/
|
|
4201
4212
|
EngineVersion?: string;
|
|
4202
4213
|
/**
|
|
4203
|
-
* <p>
|
|
4214
|
+
* <p>The latest time to which a database can be restored with point-in-time restore.</p>
|
|
4204
4215
|
*/
|
|
4205
4216
|
LatestRestorableTime?: Date;
|
|
4206
4217
|
/**
|
|
4207
|
-
* <p>
|
|
4218
|
+
* <p>The port that the database engine is listening on.</p>
|
|
4208
4219
|
*/
|
|
4209
4220
|
Port?: number;
|
|
4210
4221
|
/**
|
|
4211
|
-
* <p>
|
|
4222
|
+
* <p>The master username for the DB cluster.</p>
|
|
4212
4223
|
*/
|
|
4213
4224
|
MasterUsername?: string;
|
|
4214
4225
|
/**
|
|
4215
|
-
* <p>
|
|
4226
|
+
* <p>The list of option group memberships for this DB cluster.</p>
|
|
4216
4227
|
*/
|
|
4217
4228
|
DBClusterOptionGroupMemberships?: DBClusterOptionGroupStatus[];
|
|
4218
4229
|
/**
|
|
4219
|
-
* <p>
|
|
4230
|
+
* <p>The daily time range during which automated backups are
|
|
4220
4231
|
* created if automated backups are enabled, as determined
|
|
4221
4232
|
* by the <code>BackupRetentionPeriod</code>.</p>
|
|
4222
4233
|
*/
|
|
4223
4234
|
PreferredBackupWindow?: string;
|
|
4224
4235
|
/**
|
|
4225
|
-
* <p>
|
|
4236
|
+
* <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
|
|
4226
4237
|
*/
|
|
4227
4238
|
PreferredMaintenanceWindow?: string;
|
|
4228
4239
|
/**
|
|
4229
|
-
* <p>
|
|
4240
|
+
* <p>The identifier of the source DB cluster if this DB cluster is a read
|
|
4230
4241
|
* replica.</p>
|
|
4231
4242
|
*/
|
|
4232
4243
|
ReplicationSourceIdentifier?: string;
|
|
@@ -4236,19 +4247,19 @@ export interface DBCluster {
|
|
|
4236
4247
|
*/
|
|
4237
4248
|
ReadReplicaIdentifiers?: string[];
|
|
4238
4249
|
/**
|
|
4239
|
-
* <p>
|
|
4250
|
+
* <p>The list of DB instances that make up the DB cluster.</p>
|
|
4240
4251
|
*/
|
|
4241
4252
|
DBClusterMembers?: DBClusterMember[];
|
|
4242
4253
|
/**
|
|
4243
|
-
* <p>
|
|
4254
|
+
* <p>The list of VPC security groups that the DB cluster belongs to.</p>
|
|
4244
4255
|
*/
|
|
4245
4256
|
VpcSecurityGroups?: VpcSecurityGroupMembership[];
|
|
4246
4257
|
/**
|
|
4247
|
-
* <p>
|
|
4258
|
+
* <p>The ID that Amazon Route 53 assigns when you create a hosted zone.</p>
|
|
4248
4259
|
*/
|
|
4249
4260
|
HostedZoneId?: string;
|
|
4250
4261
|
/**
|
|
4251
|
-
* <p>
|
|
4262
|
+
* <p>Indicates whether the DB cluster is encrypted.</p>
|
|
4252
4263
|
*/
|
|
4253
4264
|
StorageEncrypted?: boolean;
|
|
4254
4265
|
/**
|
|
@@ -4266,21 +4277,21 @@ export interface DBCluster {
|
|
|
4266
4277
|
*/
|
|
4267
4278
|
DBClusterArn?: string;
|
|
4268
4279
|
/**
|
|
4269
|
-
* <p>
|
|
4280
|
+
* <p>A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster.
|
|
4270
4281
|
* IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services
|
|
4271
4282
|
* on your behalf.</p>
|
|
4272
4283
|
*/
|
|
4273
4284
|
AssociatedRoles?: DBClusterRole[];
|
|
4274
4285
|
/**
|
|
4275
|
-
* <p>
|
|
4286
|
+
* <p>Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.</p>
|
|
4276
4287
|
*/
|
|
4277
4288
|
IAMDatabaseAuthenticationEnabled?: boolean;
|
|
4278
4289
|
/**
|
|
4279
|
-
* <p>
|
|
4290
|
+
* <p>The ID of the clone group with which the DB cluster is associated.</p>
|
|
4280
4291
|
*/
|
|
4281
4292
|
CloneGroupId?: string;
|
|
4282
4293
|
/**
|
|
4283
|
-
* <p>
|
|
4294
|
+
* <p>The time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>
|
|
4284
4295
|
*/
|
|
4285
4296
|
ClusterCreateTime?: Date;
|
|
4286
4297
|
/**
|
|
@@ -4288,7 +4299,7 @@ export interface DBCluster {
|
|
|
4288
4299
|
*/
|
|
4289
4300
|
EarliestBacktrackTime?: Date;
|
|
4290
4301
|
/**
|
|
4291
|
-
* <p>The target backtrack window, in seconds. If this value is set to 0
|
|
4302
|
+
* <p>The target backtrack window, in seconds. If this value is set to <code>0</code>, backtracking is
|
|
4292
4303
|
* disabled for the DB cluster. Otherwise, backtracking is enabled.</p>
|
|
4293
4304
|
*/
|
|
4294
4305
|
BacktrackWindow?: number;
|
|
@@ -4304,7 +4315,7 @@ export interface DBCluster {
|
|
|
4304
4315
|
*/
|
|
4305
4316
|
EnabledCloudwatchLogsExports?: string[];
|
|
4306
4317
|
/**
|
|
4307
|
-
* <p>The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero)
|
|
4318
|
+
* <p>The current capacity of an Aurora Serverless v1 DB cluster. The capacity is <code>0</code> (zero)
|
|
4308
4319
|
* when the cluster is paused.</p>
|
|
4309
4320
|
* <p>For more information about Aurora Serverless v1, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html">Using Amazon Aurora Serverless v1</a> in the
|
|
4310
4321
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
@@ -4317,18 +4328,18 @@ export interface DBCluster {
|
|
|
4317
4328
|
*/
|
|
4318
4329
|
EngineMode?: string;
|
|
4319
4330
|
/**
|
|
4320
|
-
* <p>
|
|
4331
|
+
* <p>The scaling configuration for an Aurora DB cluster in <code>serverless</code> DB engine mode.</p>
|
|
4321
4332
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html">Using Amazon Aurora Serverless v1</a> in the
|
|
4322
4333
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
4323
4334
|
*/
|
|
4324
4335
|
ScalingConfigurationInfo?: ScalingConfigurationInfo;
|
|
4325
4336
|
/**
|
|
4326
|
-
* <p>Indicates
|
|
4337
|
+
* <p>Indicates whether the DB cluster has deletion protection enabled.
|
|
4327
4338
|
* The database can't be deleted when deletion protection is enabled.</p>
|
|
4328
4339
|
*/
|
|
4329
4340
|
DeletionProtection?: boolean;
|
|
4330
4341
|
/**
|
|
4331
|
-
* <p>
|
|
4342
|
+
* <p>Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.</p>
|
|
4332
4343
|
* <p>When enabled, the HTTP endpoint provides a connectionless web service API for running
|
|
4333
4344
|
* SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database
|
|
4334
4345
|
* from inside the RDS console with the query editor.</p>
|
|
@@ -4356,11 +4367,11 @@ export interface DBCluster {
|
|
|
4356
4367
|
*/
|
|
4357
4368
|
ActivityStreamKinesisStreamName?: string;
|
|
4358
4369
|
/**
|
|
4359
|
-
* <p>
|
|
4370
|
+
* <p>Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.</p>
|
|
4360
4371
|
*/
|
|
4361
4372
|
CopyTagsToSnapshot?: boolean;
|
|
4362
4373
|
/**
|
|
4363
|
-
* <p>
|
|
4374
|
+
* <p>Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.</p>
|
|
4364
4375
|
*/
|
|
4365
4376
|
CrossAccountClone?: boolean;
|
|
4366
4377
|
/**
|
|
@@ -4374,20 +4385,18 @@ export interface DBCluster {
|
|
|
4374
4385
|
*/
|
|
4375
4386
|
TagList?: Tag[];
|
|
4376
4387
|
/**
|
|
4377
|
-
* <p>
|
|
4378
|
-
* write forwarding enabled, not enabled, or is in the process of enabling it.</p>
|
|
4388
|
+
* <p>The status of write forwarding for a secondary cluster in an Aurora global database.</p>
|
|
4379
4389
|
*/
|
|
4380
4390
|
GlobalWriteForwardingStatus?: WriteForwardingStatus | string;
|
|
4381
4391
|
/**
|
|
4382
|
-
* <p>Specifies whether
|
|
4392
|
+
* <p>Specifies whether write forwarding is enabled for a secondary cluster
|
|
4383
4393
|
* in an Aurora global database. Because write forwarding takes time to enable, check the
|
|
4384
4394
|
* value of <code>GlobalWriteForwardingStatus</code> to confirm that the request has completed
|
|
4385
4395
|
* before using the write forwarding feature for this cluster.</p>
|
|
4386
4396
|
*/
|
|
4387
4397
|
GlobalWriteForwardingRequested?: boolean;
|
|
4388
4398
|
/**
|
|
4389
|
-
* <p>
|
|
4390
|
-
* Specific changes are identified by subelements.</p>
|
|
4399
|
+
* <p>Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.</p>
|
|
4391
4400
|
*/
|
|
4392
4401
|
PendingModifiedValues?: ClusterPendingModifiedValues;
|
|
4393
4402
|
/**
|
|
@@ -4405,19 +4414,20 @@ export interface DBCluster {
|
|
|
4405
4414
|
*/
|
|
4406
4415
|
Iops?: number;
|
|
4407
4416
|
/**
|
|
4408
|
-
* <p>
|
|
4409
|
-
* <p>When the DB
|
|
4410
|
-
*
|
|
4411
|
-
*
|
|
4412
|
-
*
|
|
4413
|
-
*
|
|
4414
|
-
*
|
|
4415
|
-
* <p>
|
|
4417
|
+
* <p>Indicates whether the DB cluster is publicly accessible.</p>
|
|
4418
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
4419
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
4420
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
4421
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
4422
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
4423
|
+
* it.</p>
|
|
4424
|
+
* <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>
|
|
4425
|
+
* <p>For more information, see <a>CreateDBCluster</a>.</p>
|
|
4416
4426
|
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4417
4427
|
*/
|
|
4418
4428
|
PubliclyAccessible?: boolean;
|
|
4419
4429
|
/**
|
|
4420
|
-
* <p>
|
|
4430
|
+
* <p>Indicates whether minor version patches are applied automatically.</p>
|
|
4421
4431
|
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4422
4432
|
*/
|
|
4423
4433
|
AutoMinorVersionUpgrade?: boolean;
|
|
@@ -4432,7 +4442,7 @@ export interface DBCluster {
|
|
|
4432
4442
|
*/
|
|
4433
4443
|
MonitoringRoleArn?: string;
|
|
4434
4444
|
/**
|
|
4435
|
-
* <p>
|
|
4445
|
+
* <p>Indicates whether Performance Insights is enabled for the DB cluster.</p>
|
|
4436
4446
|
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4437
4447
|
*/
|
|
4438
4448
|
PerformanceInsightsEnabled?: boolean;
|
|
@@ -4443,58 +4453,37 @@ export interface DBCluster {
|
|
|
4443
4453
|
*/
|
|
4444
4454
|
PerformanceInsightsKMSKeyId?: string;
|
|
4445
4455
|
/**
|
|
4446
|
-
* <p>The number of days to retain Performance Insights data
|
|
4456
|
+
* <p>The number of days to retain Performance Insights data.</p>
|
|
4457
|
+
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
|
|
4458
|
+
* <p>Valid Values:</p>
|
|
4447
4459
|
* <ul>
|
|
4448
4460
|
* <li>
|
|
4449
|
-
* <p>7</p>
|
|
4450
|
-
* </li>
|
|
4451
|
-
* <li>
|
|
4452
4461
|
* <p>
|
|
4453
|
-
* <
|
|
4454
|
-
*
|
|
4455
|
-
* <li>
|
|
4456
|
-
* <p>731</p>
|
|
4457
|
-
* </li>
|
|
4458
|
-
* </ul>
|
|
4459
|
-
* <p>For example, the following values are valid:</p>
|
|
4460
|
-
* <ul>
|
|
4461
|
-
* <li>
|
|
4462
|
-
* <p>93 (3 months * 31)</p>
|
|
4463
|
-
* </li>
|
|
4464
|
-
* <li>
|
|
4465
|
-
* <p>341 (11 months * 31)</p>
|
|
4462
|
+
* <code>7</code>
|
|
4463
|
+
* </p>
|
|
4466
4464
|
* </li>
|
|
4467
4465
|
* <li>
|
|
4468
|
-
* <p>
|
|
4466
|
+
* <p>
|
|
4467
|
+
* <i>month</i> * 31, where <i>month</i> is a number of months from 1-23.
|
|
4468
|
+
* Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31)</p>
|
|
4469
4469
|
* </li>
|
|
4470
4470
|
* <li>
|
|
4471
|
-
* <p>
|
|
4471
|
+
* <p>
|
|
4472
|
+
* <code>731</code>
|
|
4473
|
+
* </p>
|
|
4472
4474
|
* </li>
|
|
4473
4475
|
* </ul>
|
|
4474
|
-
* <p>
|
|
4476
|
+
* <p>Default: <code>7</code> days</p>
|
|
4475
4477
|
*/
|
|
4476
4478
|
PerformanceInsightsRetentionPeriod?: number;
|
|
4477
4479
|
/**
|
|
4478
|
-
* <p>
|
|
4480
|
+
* <p>The scaling configuration for an Aurora Serverless v2 DB cluster.</p>
|
|
4479
4481
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html">Using Amazon Aurora Serverless v2</a> in the
|
|
4480
4482
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
4481
4483
|
*/
|
|
4482
4484
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfigurationInfo;
|
|
4483
4485
|
/**
|
|
4484
4486
|
* <p>The network type of the DB instance.</p>
|
|
4485
|
-
* <p>Valid values:</p>
|
|
4486
|
-
* <ul>
|
|
4487
|
-
* <li>
|
|
4488
|
-
* <p>
|
|
4489
|
-
* <code>IPV4</code>
|
|
4490
|
-
* </p>
|
|
4491
|
-
* </li>
|
|
4492
|
-
* <li>
|
|
4493
|
-
* <p>
|
|
4494
|
-
* <code>DUAL</code>
|
|
4495
|
-
* </p>
|
|
4496
|
-
* </li>
|
|
4497
|
-
* </ul>
|
|
4498
4487
|
* <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the DB cluster.
|
|
4499
4488
|
* A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6
|
|
4500
4489
|
* protocols (<code>DUAL</code>).</p>
|
|
@@ -4503,6 +4492,8 @@ export interface DBCluster {
|
|
|
4503
4492
|
* <i>Amazon Aurora User Guide.</i>
|
|
4504
4493
|
* </p>
|
|
4505
4494
|
* <p>This setting is only for Aurora DB clusters.</p>
|
|
4495
|
+
* <p>Valid Values: <code>IPV4 | DUAL</code>
|
|
4496
|
+
* </p>
|
|
4506
4497
|
*/
|
|
4507
4498
|
NetworkType?: string;
|
|
4508
4499
|
/**
|
|
@@ -4510,7 +4501,7 @@ export interface DBCluster {
|
|
|
4510
4501
|
*/
|
|
4511
4502
|
DBSystemId?: string;
|
|
4512
4503
|
/**
|
|
4513
|
-
* <p>
|
|
4504
|
+
* <p>The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.</p>
|
|
4514
4505
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a>
|
|
4515
4506
|
* in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a>
|
|
4516
4507
|
* in the <i>Amazon Aurora User Guide.</i>
|
|
@@ -5012,137 +5003,139 @@ export declare class CertificateNotFoundFault extends __BaseException {
|
|
|
5012
5003
|
*/
|
|
5013
5004
|
export interface CreateDBInstanceMessage {
|
|
5014
5005
|
/**
|
|
5015
|
-
* <p>The meaning of this parameter differs
|
|
5016
|
-
* <
|
|
5017
|
-
* <
|
|
5018
|
-
*
|
|
5019
|
-
*
|
|
5020
|
-
*
|
|
5021
|
-
*
|
|
5022
|
-
* <
|
|
5023
|
-
*
|
|
5024
|
-
* </
|
|
5025
|
-
* <
|
|
5026
|
-
*
|
|
5027
|
-
*
|
|
5028
|
-
*
|
|
5029
|
-
* <p>
|
|
5030
|
-
*
|
|
5031
|
-
*
|
|
5032
|
-
*
|
|
5033
|
-
*
|
|
5034
|
-
*
|
|
5035
|
-
*
|
|
5036
|
-
*
|
|
5037
|
-
*
|
|
5038
|
-
*
|
|
5039
|
-
*
|
|
5040
|
-
*
|
|
5041
|
-
*
|
|
5042
|
-
* <p>
|
|
5043
|
-
*
|
|
5044
|
-
*
|
|
5045
|
-
* <
|
|
5046
|
-
*
|
|
5047
|
-
*
|
|
5048
|
-
*
|
|
5049
|
-
*
|
|
5050
|
-
*
|
|
5051
|
-
*
|
|
5052
|
-
*
|
|
5053
|
-
*
|
|
5054
|
-
*
|
|
5055
|
-
*
|
|
5056
|
-
*
|
|
5057
|
-
*
|
|
5058
|
-
*
|
|
5059
|
-
*
|
|
5060
|
-
*
|
|
5061
|
-
*
|
|
5062
|
-
*
|
|
5063
|
-
*
|
|
5064
|
-
*
|
|
5065
|
-
*
|
|
5066
|
-
*
|
|
5067
|
-
*
|
|
5068
|
-
*
|
|
5069
|
-
*
|
|
5070
|
-
*
|
|
5071
|
-
*
|
|
5072
|
-
*
|
|
5073
|
-
*
|
|
5074
|
-
*
|
|
5075
|
-
*
|
|
5076
|
-
*
|
|
5077
|
-
*
|
|
5078
|
-
*
|
|
5079
|
-
*
|
|
5080
|
-
*
|
|
5081
|
-
*
|
|
5082
|
-
*
|
|
5083
|
-
*
|
|
5084
|
-
*
|
|
5085
|
-
*
|
|
5086
|
-
*
|
|
5087
|
-
*
|
|
5088
|
-
*
|
|
5089
|
-
*
|
|
5090
|
-
*
|
|
5091
|
-
*
|
|
5092
|
-
*
|
|
5093
|
-
* </
|
|
5094
|
-
* <
|
|
5095
|
-
* <p>
|
|
5096
|
-
*
|
|
5097
|
-
*
|
|
5098
|
-
*
|
|
5099
|
-
*
|
|
5100
|
-
*
|
|
5101
|
-
*
|
|
5102
|
-
*
|
|
5103
|
-
*
|
|
5104
|
-
*
|
|
5105
|
-
*
|
|
5106
|
-
*
|
|
5107
|
-
*
|
|
5108
|
-
*
|
|
5109
|
-
*
|
|
5110
|
-
*
|
|
5111
|
-
*
|
|
5112
|
-
*
|
|
5113
|
-
*
|
|
5114
|
-
*
|
|
5115
|
-
*
|
|
5116
|
-
*
|
|
5117
|
-
*
|
|
5118
|
-
*
|
|
5119
|
-
*
|
|
5120
|
-
*
|
|
5121
|
-
*
|
|
5122
|
-
*
|
|
5123
|
-
*
|
|
5124
|
-
*
|
|
5125
|
-
*
|
|
5126
|
-
*
|
|
5127
|
-
*
|
|
5128
|
-
*
|
|
5129
|
-
*
|
|
5130
|
-
*
|
|
5131
|
-
*
|
|
5132
|
-
*
|
|
5133
|
-
*
|
|
5134
|
-
*
|
|
5135
|
-
*
|
|
5136
|
-
*
|
|
5137
|
-
*
|
|
5138
|
-
*
|
|
5139
|
-
*
|
|
5140
|
-
*
|
|
5141
|
-
*
|
|
5006
|
+
* <p>The meaning of this parameter differs depending on the database engine.</p>
|
|
5007
|
+
* <dl>
|
|
5008
|
+
* <dt>Amazon Aurora MySQL</dt>
|
|
5009
|
+
* <dt>Amazon Aurora PostgreSQL</dt>
|
|
5010
|
+
* <dt>Amazon RDS Custom for Oracle</dt>
|
|
5011
|
+
* <dt>Amazon RDS Custom for SQL Server</dt>
|
|
5012
|
+
* <dt>RDS for MariaDB</dt>
|
|
5013
|
+
* <dt>RDS for MySQL</dt>
|
|
5014
|
+
* <dt>RDS for Oracle</dt>
|
|
5015
|
+
* <dt>RDS for PostgreSQL</dt>
|
|
5016
|
+
* <dt>RDS for SQL Server</dt>
|
|
5017
|
+
* <dd>
|
|
5018
|
+
* <p>The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is
|
|
5019
|
+
* created. If you don't specify a value, Amazon RDS doesn't create a database in the DB cluster.</p>
|
|
5020
|
+
* <p>Constraints:</p>
|
|
5021
|
+
* <ul>
|
|
5022
|
+
* <li>
|
|
5023
|
+
* <p>Must contain 1 to 64 alphanumeric characters.</p>
|
|
5024
|
+
* </li>
|
|
5025
|
+
* <li>
|
|
5026
|
+
* <p>Can't be a word reserved by the database engine.</p>
|
|
5027
|
+
* </li>
|
|
5028
|
+
* </ul>
|
|
5029
|
+
* </dd>
|
|
5030
|
+
* <dd>
|
|
5031
|
+
* <p>The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is
|
|
5032
|
+
* created.</p>
|
|
5033
|
+
* <p>Default: <code>postgres</code>
|
|
5034
|
+
* </p>
|
|
5035
|
+
* <p>Constraints:</p>
|
|
5036
|
+
* <ul>
|
|
5037
|
+
* <li>
|
|
5038
|
+
* <p>Must contain 1 to 63 alphanumeric characters.</p>
|
|
5039
|
+
* </li>
|
|
5040
|
+
* <li>
|
|
5041
|
+
* <p>Must begin with a letter.
|
|
5042
|
+
* Subsequent characters can be letters, underscores, or digits
|
|
5043
|
+
* (0 to 9).</p>
|
|
5044
|
+
* </li>
|
|
5045
|
+
* <li>
|
|
5046
|
+
* <p>Can't be a word reserved by the database engine.</p>
|
|
5047
|
+
* </li>
|
|
5048
|
+
* </ul>
|
|
5049
|
+
* </dd>
|
|
5050
|
+
* <dd>
|
|
5051
|
+
* <p>The Oracle System ID (SID) of the created RDS Custom DB instance.</p>
|
|
5052
|
+
* <p>Default: <code>ORCL</code>
|
|
5053
|
+
* </p>
|
|
5054
|
+
* <p>Constraints:</p>
|
|
5055
|
+
* <ul>
|
|
5056
|
+
* <li>
|
|
5057
|
+
* <p>Must contain 1 to 8 alphanumeric characters.</p>
|
|
5058
|
+
* </li>
|
|
5059
|
+
* <li>
|
|
5060
|
+
* <p>Must contain a letter.</p>
|
|
5061
|
+
* </li>
|
|
5062
|
+
* <li>
|
|
5063
|
+
* <p>Can't be a word reserved by the database engine.</p>
|
|
5064
|
+
* </li>
|
|
5065
|
+
* </ul>
|
|
5066
|
+
* </dd>
|
|
5067
|
+
* <dd>
|
|
5068
|
+
* <p>Not applicable. Must be null.</p>
|
|
5069
|
+
* </dd>
|
|
5070
|
+
* <dd>
|
|
5071
|
+
* <p>The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance.</p>
|
|
5072
|
+
* <p>Constraints:</p>
|
|
5073
|
+
* <ul>
|
|
5074
|
+
* <li>
|
|
5075
|
+
* <p>Must contain 1 to 64 letters or numbers.</p>
|
|
5076
|
+
* </li>
|
|
5077
|
+
* <li>
|
|
5078
|
+
* <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
|
|
5079
|
+
* </li>
|
|
5080
|
+
* <li>
|
|
5081
|
+
* <p>Can't be a word reserved by the database engine.</p>
|
|
5082
|
+
* </li>
|
|
5083
|
+
* </ul>
|
|
5084
|
+
* </dd>
|
|
5085
|
+
* <dd>
|
|
5086
|
+
* <p>The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance.</p>
|
|
5087
|
+
* <p>Constraints:</p>
|
|
5088
|
+
* <ul>
|
|
5089
|
+
* <li>
|
|
5090
|
+
* <p>Must contain 1 to 64 letters or numbers.</p>
|
|
5091
|
+
* </li>
|
|
5092
|
+
* <li>
|
|
5093
|
+
* <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
|
|
5094
|
+
* </li>
|
|
5095
|
+
* <li>
|
|
5096
|
+
* <p>Can't be a word reserved by the database engine.</p>
|
|
5097
|
+
* </li>
|
|
5098
|
+
* </ul>
|
|
5099
|
+
* </dd>
|
|
5100
|
+
* <dd>
|
|
5101
|
+
* <p>The Oracle System ID (SID) of the created DB instance.</p>
|
|
5102
|
+
* <p>Default: <code>ORCL</code>
|
|
5103
|
+
* </p>
|
|
5104
|
+
* <p>Constraints:</p>
|
|
5105
|
+
* <ul>
|
|
5106
|
+
* <li>
|
|
5107
|
+
* <p>Can't be longer than 8 characters.</p>
|
|
5108
|
+
* </li>
|
|
5109
|
+
* <li>
|
|
5110
|
+
* <p>Can't be a word reserved by the database engine, such as the string <code>NULL</code>.</p>
|
|
5111
|
+
* </li>
|
|
5112
|
+
* </ul>
|
|
5113
|
+
* </dd>
|
|
5114
|
+
* <dd>
|
|
5115
|
+
* <p>The name of the database to create when the DB instance is created.</p>
|
|
5116
|
+
* <p>Default: <code>postgres</code>
|
|
5117
|
+
* </p>
|
|
5118
|
+
* <p>Constraints:</p>
|
|
5119
|
+
* <ul>
|
|
5120
|
+
* <li>
|
|
5121
|
+
* <p>Must contain 1 to 63 letters, numbers, or underscores.</p>
|
|
5122
|
+
* </li>
|
|
5123
|
+
* <li>
|
|
5124
|
+
* <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
|
|
5125
|
+
* </li>
|
|
5126
|
+
* <li>
|
|
5127
|
+
* <p>Can't be a word reserved by the database engine.</p>
|
|
5128
|
+
* </li>
|
|
5129
|
+
* </ul>
|
|
5130
|
+
* </dd>
|
|
5131
|
+
* <dd>
|
|
5132
|
+
* <p>Not applicable. Must be null.</p>
|
|
5133
|
+
* </dd>
|
|
5134
|
+
* </dl>
|
|
5142
5135
|
*/
|
|
5143
5136
|
DBName?: string;
|
|
5144
5137
|
/**
|
|
5145
|
-
* <p>The DB instance
|
|
5138
|
+
* <p>The identifier for this DB instance. This parameter is stored as a lowercase string.</p>
|
|
5146
5139
|
* <p>Constraints:</p>
|
|
5147
5140
|
* <ul>
|
|
5148
5141
|
* <li>
|
|
@@ -5161,129 +5154,127 @@ export interface CreateDBInstanceMessage {
|
|
|
5161
5154
|
DBInstanceIdentifier: string | undefined;
|
|
5162
5155
|
/**
|
|
5163
5156
|
* <p>The amount of storage in gibibytes (GiB) to allocate for the DB instance.</p>
|
|
5164
|
-
* <p>
|
|
5165
|
-
*
|
|
5166
|
-
*
|
|
5167
|
-
*
|
|
5168
|
-
*
|
|
5169
|
-
*
|
|
5170
|
-
*
|
|
5171
|
-
* <
|
|
5172
|
-
*
|
|
5173
|
-
*
|
|
5174
|
-
*
|
|
5175
|
-
* <li>
|
|
5176
|
-
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle,
|
|
5177
|
-
* 16384 for RDS Custom for SQL Server.</p>
|
|
5178
|
-
* </li>
|
|
5179
|
-
* <li>
|
|
5180
|
-
* <p>Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle,
|
|
5181
|
-
* 16384 for RDS Custom for SQL Server.</p>
|
|
5182
|
-
* </li>
|
|
5183
|
-
* </ul>
|
|
5184
|
-
* <p>
|
|
5185
|
-
* <b>MySQL</b>
|
|
5186
|
-
* </p>
|
|
5187
|
-
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5188
|
-
* <ul>
|
|
5189
|
-
* <li>
|
|
5190
|
-
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.</p>
|
|
5191
|
-
* </li>
|
|
5192
|
-
* <li>
|
|
5193
|
-
* <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>
|
|
5194
|
-
* </li>
|
|
5195
|
-
* <li>
|
|
5196
|
-
* <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>
|
|
5197
|
-
* </li>
|
|
5198
|
-
* </ul>
|
|
5199
|
-
* <p>
|
|
5200
|
-
* <b>MariaDB</b>
|
|
5201
|
-
* </p>
|
|
5202
|
-
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5203
|
-
* <ul>
|
|
5204
|
-
* <li>
|
|
5205
|
-
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.</p>
|
|
5206
|
-
* </li>
|
|
5207
|
-
* <li>
|
|
5208
|
-
* <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>
|
|
5209
|
-
* </li>
|
|
5210
|
-
* <li>
|
|
5211
|
-
* <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>
|
|
5212
|
-
* </li>
|
|
5213
|
-
* </ul>
|
|
5214
|
-
* <p>
|
|
5215
|
-
* <b>PostgreSQL</b>
|
|
5216
|
-
* </p>
|
|
5217
|
-
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5218
|
-
* <ul>
|
|
5219
|
-
* <li>
|
|
5220
|
-
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.</p>
|
|
5221
|
-
* </li>
|
|
5222
|
-
* <li>
|
|
5223
|
-
* <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>
|
|
5224
|
-
* </li>
|
|
5225
|
-
* <li>
|
|
5226
|
-
* <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>
|
|
5227
|
-
* </li>
|
|
5228
|
-
* </ul>
|
|
5229
|
-
* <p>
|
|
5230
|
-
* <b>Oracle</b>
|
|
5231
|
-
* </p>
|
|
5232
|
-
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5233
|
-
* <ul>
|
|
5234
|
-
* <li>
|
|
5235
|
-
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.</p>
|
|
5236
|
-
* </li>
|
|
5237
|
-
* <li>
|
|
5238
|
-
* <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>
|
|
5239
|
-
* </li>
|
|
5240
|
-
* <li>
|
|
5241
|
-
* <p>Magnetic storage (standard): Must be an integer from 10 to 3072.</p>
|
|
5242
|
-
* </li>
|
|
5243
|
-
* </ul>
|
|
5244
|
-
* <p>
|
|
5245
|
-
* <b>SQL Server</b>
|
|
5246
|
-
* </p>
|
|
5247
|
-
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5248
|
-
* <ul>
|
|
5249
|
-
* <li>
|
|
5250
|
-
* <p>General Purpose (SSD) storage (gp2, gp3):</p>
|
|
5157
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your
|
|
5158
|
+
* database increases, though you are only charged for the space that you use in an Aurora cluster volume.</p>
|
|
5159
|
+
* <dl>
|
|
5160
|
+
* <dt>Amazon RDS Custom</dt>
|
|
5161
|
+
* <dt>RDS for MariaDB</dt>
|
|
5162
|
+
* <dt>RDS for MySQL</dt>
|
|
5163
|
+
* <dt>RDS for Oracle</dt>
|
|
5164
|
+
* <dt>RDS for PostgreSQL</dt>
|
|
5165
|
+
* <dt>RDS for SQL Server</dt>
|
|
5166
|
+
* <dd>
|
|
5167
|
+
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5251
5168
|
* <ul>
|
|
5252
5169
|
* <li>
|
|
5253
|
-
* <p>
|
|
5170
|
+
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle,
|
|
5171
|
+
* 16384 for RDS Custom for SQL Server.</p>
|
|
5254
5172
|
* </li>
|
|
5255
5173
|
* <li>
|
|
5256
|
-
* <p>
|
|
5174
|
+
* <p>Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle,
|
|
5175
|
+
* 16384 for RDS Custom for SQL Server.</p>
|
|
5257
5176
|
* </li>
|
|
5258
5177
|
* </ul>
|
|
5259
|
-
* </
|
|
5260
|
-
* <
|
|
5261
|
-
* <p>
|
|
5178
|
+
* </dd>
|
|
5179
|
+
* <dd>
|
|
5180
|
+
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5262
5181
|
* <ul>
|
|
5263
5182
|
* <li>
|
|
5264
|
-
* <p>
|
|
5183
|
+
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.</p>
|
|
5184
|
+
* </li>
|
|
5185
|
+
* <li>
|
|
5186
|
+
* <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>
|
|
5265
5187
|
* </li>
|
|
5266
5188
|
* <li>
|
|
5267
|
-
* <p>
|
|
5189
|
+
* <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>
|
|
5268
5190
|
* </li>
|
|
5269
5191
|
* </ul>
|
|
5270
|
-
* </
|
|
5271
|
-
* <
|
|
5272
|
-
* <p>
|
|
5192
|
+
* </dd>
|
|
5193
|
+
* <dd>
|
|
5194
|
+
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5273
5195
|
* <ul>
|
|
5274
5196
|
* <li>
|
|
5275
|
-
* <p>
|
|
5197
|
+
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.</p>
|
|
5198
|
+
* </li>
|
|
5199
|
+
* <li>
|
|
5200
|
+
* <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>
|
|
5276
5201
|
* </li>
|
|
5277
5202
|
* <li>
|
|
5278
|
-
* <p>
|
|
5203
|
+
* <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>
|
|
5279
5204
|
* </li>
|
|
5280
5205
|
* </ul>
|
|
5281
|
-
* </
|
|
5282
|
-
*
|
|
5206
|
+
* </dd>
|
|
5207
|
+
* <dd>
|
|
5208
|
+
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5209
|
+
* <ul>
|
|
5210
|
+
* <li>
|
|
5211
|
+
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.</p>
|
|
5212
|
+
* </li>
|
|
5213
|
+
* <li>
|
|
5214
|
+
* <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>
|
|
5215
|
+
* </li>
|
|
5216
|
+
* <li>
|
|
5217
|
+
* <p>Magnetic storage (standard): Must be an integer from 10 to 3072.</p>
|
|
5218
|
+
* </li>
|
|
5219
|
+
* </ul>
|
|
5220
|
+
* </dd>
|
|
5221
|
+
* <dd>
|
|
5222
|
+
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5223
|
+
* <ul>
|
|
5224
|
+
* <li>
|
|
5225
|
+
* <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.</p>
|
|
5226
|
+
* </li>
|
|
5227
|
+
* <li>
|
|
5228
|
+
* <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>
|
|
5229
|
+
* </li>
|
|
5230
|
+
* <li>
|
|
5231
|
+
* <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>
|
|
5232
|
+
* </li>
|
|
5233
|
+
* </ul>
|
|
5234
|
+
* </dd>
|
|
5235
|
+
* <dd>
|
|
5236
|
+
* <p>Constraints to the amount of storage for each storage type are the following:</p>
|
|
5237
|
+
* <ul>
|
|
5238
|
+
* <li>
|
|
5239
|
+
* <p>General Purpose (SSD) storage (gp2, gp3):</p>
|
|
5240
|
+
* <ul>
|
|
5241
|
+
* <li>
|
|
5242
|
+
* <p>Enterprise and Standard editions: Must be an integer from 20 to 16384.</p>
|
|
5243
|
+
* </li>
|
|
5244
|
+
* <li>
|
|
5245
|
+
* <p>Web and Express editions: Must be an integer from 20 to 16384.</p>
|
|
5246
|
+
* </li>
|
|
5247
|
+
* </ul>
|
|
5248
|
+
* </li>
|
|
5249
|
+
* <li>
|
|
5250
|
+
* <p>Provisioned IOPS storage (io1):</p>
|
|
5251
|
+
* <ul>
|
|
5252
|
+
* <li>
|
|
5253
|
+
* <p>Enterprise and Standard editions: Must be an integer from 100 to 16384.</p>
|
|
5254
|
+
* </li>
|
|
5255
|
+
* <li>
|
|
5256
|
+
* <p>Web and Express editions: Must be an integer from 100 to 16384.</p>
|
|
5257
|
+
* </li>
|
|
5258
|
+
* </ul>
|
|
5259
|
+
* </li>
|
|
5260
|
+
* <li>
|
|
5261
|
+
* <p>Magnetic storage (standard):</p>
|
|
5262
|
+
* <ul>
|
|
5263
|
+
* <li>
|
|
5264
|
+
* <p>Enterprise and Standard editions: Must be an integer from 20 to 1024.</p>
|
|
5265
|
+
* </li>
|
|
5266
|
+
* <li>
|
|
5267
|
+
* <p>Web and Express editions: Must be an integer from 20 to 1024.</p>
|
|
5268
|
+
* </li>
|
|
5269
|
+
* </ul>
|
|
5270
|
+
* </li>
|
|
5271
|
+
* </ul>
|
|
5272
|
+
* </dd>
|
|
5273
|
+
* </dl>
|
|
5283
5274
|
*/
|
|
5284
5275
|
AllocatedStorage?: number;
|
|
5285
5276
|
/**
|
|
5286
|
-
* <p>The compute and memory capacity of the DB instance, for example db.m5.large
|
|
5277
|
+
* <p>The compute and memory capacity of the DB instance, for example <code>db.m5.large</code>.
|
|
5287
5278
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
|
|
5288
5279
|
* For the full list of DB instance classes, and availability for your engine, see
|
|
5289
5280
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB instance
|
|
@@ -5293,8 +5284,8 @@ export interface CreateDBInstanceMessage {
|
|
|
5293
5284
|
*/
|
|
5294
5285
|
DBInstanceClass: string | undefined;
|
|
5295
5286
|
/**
|
|
5296
|
-
* <p>The
|
|
5297
|
-
* <p>Not every database engine is available
|
|
5287
|
+
* <p>The database engine to use for this DB instance.</p>
|
|
5288
|
+
* <p>Not every database engine is available in every Amazon Web Services Region.</p>
|
|
5298
5289
|
* <p>Valid Values:</p>
|
|
5299
5290
|
* <ul>
|
|
5300
5291
|
* <li>
|
|
@@ -5307,28 +5298,23 @@ export interface CreateDBInstanceMessage {
|
|
|
5307
5298
|
* </li>
|
|
5308
5299
|
* <li>
|
|
5309
5300
|
* <p>
|
|
5310
|
-
* <code>custom-oracle-ee (for RDS Custom for Oracle DB instances)</
|
|
5311
|
-
* </p>
|
|
5301
|
+
* <code>custom-oracle-ee</code> (for RDS Custom for Oracle DB instances)</p>
|
|
5312
5302
|
* </li>
|
|
5313
5303
|
* <li>
|
|
5314
5304
|
* <p>
|
|
5315
|
-
* <code>custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)</
|
|
5316
|
-
* </p>
|
|
5305
|
+
* <code>custom-oracle-ee-cdb</code> (for RDS Custom for Oracle DB instances)</p>
|
|
5317
5306
|
* </li>
|
|
5318
5307
|
* <li>
|
|
5319
5308
|
* <p>
|
|
5320
|
-
* <code>custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)</
|
|
5321
|
-
* </p>
|
|
5309
|
+
* <code>custom-sqlserver-ee</code> (for RDS Custom for SQL Server DB instances)</p>
|
|
5322
5310
|
* </li>
|
|
5323
5311
|
* <li>
|
|
5324
5312
|
* <p>
|
|
5325
|
-
* <code>custom-sqlserver-se (for RDS Custom for SQL Server DB instances)</
|
|
5326
|
-
* </p>
|
|
5313
|
+
* <code>custom-sqlserver-se</code> (for RDS Custom for SQL Server DB instances)</p>
|
|
5327
5314
|
* </li>
|
|
5328
5315
|
* <li>
|
|
5329
5316
|
* <p>
|
|
5330
|
-
* <code>custom-sqlserver-web (for RDS Custom for SQL Server DB instances)</
|
|
5331
|
-
* </p>
|
|
5317
|
+
* <code>custom-sqlserver-web</code> (for RDS Custom for SQL Server DB instances)</p>
|
|
5332
5318
|
* </li>
|
|
5333
5319
|
* <li>
|
|
5334
5320
|
* <p>
|
|
@@ -5390,19 +5376,11 @@ export interface CreateDBInstanceMessage {
|
|
|
5390
5376
|
Engine: string | undefined;
|
|
5391
5377
|
/**
|
|
5392
5378
|
* <p>The name for the master user.</p>
|
|
5393
|
-
* <p>
|
|
5394
|
-
*
|
|
5395
|
-
* </p>
|
|
5396
|
-
* <p>Not applicable. The name for the master user is managed by the DB cluster.</p>
|
|
5397
|
-
* <p>
|
|
5398
|
-
* <b>Amazon RDS</b>
|
|
5399
|
-
* </p>
|
|
5379
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.</p>
|
|
5380
|
+
* <p>This setting is required for RDS DB instances.</p>
|
|
5400
5381
|
* <p>Constraints:</p>
|
|
5401
5382
|
* <ul>
|
|
5402
5383
|
* <li>
|
|
5403
|
-
* <p>Required.</p>
|
|
5404
|
-
* </li>
|
|
5405
|
-
* <li>
|
|
5406
5384
|
* <p>Must be 1 to 16 letters, numbers, or underscores.</p>
|
|
5407
5385
|
* </li>
|
|
5408
5386
|
* <li>
|
|
@@ -5415,33 +5393,36 @@ export interface CreateDBInstanceMessage {
|
|
|
5415
5393
|
*/
|
|
5416
5394
|
MasterUsername?: string;
|
|
5417
5395
|
/**
|
|
5418
|
-
* <p>The password for the master user
|
|
5419
|
-
* <p>
|
|
5420
|
-
* <b>Amazon Aurora</b>
|
|
5421
|
-
* </p>
|
|
5422
|
-
* <p>Not applicable. The password for the master user is managed by the DB
|
|
5396
|
+
* <p>The password for the master user.</p>
|
|
5397
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB
|
|
5423
5398
|
* cluster.</p>
|
|
5424
|
-
* <p>Constraints
|
|
5425
|
-
* <
|
|
5426
|
-
* <
|
|
5427
|
-
*
|
|
5428
|
-
*
|
|
5429
|
-
*
|
|
5430
|
-
*
|
|
5431
|
-
*
|
|
5432
|
-
*
|
|
5433
|
-
* <p>
|
|
5434
|
-
*
|
|
5435
|
-
*
|
|
5436
|
-
*
|
|
5437
|
-
*
|
|
5438
|
-
* <
|
|
5439
|
-
*
|
|
5440
|
-
*
|
|
5441
|
-
*
|
|
5442
|
-
*
|
|
5443
|
-
*
|
|
5444
|
-
*
|
|
5399
|
+
* <p>Constraints:</p>
|
|
5400
|
+
* <ul>
|
|
5401
|
+
* <li>
|
|
5402
|
+
* <p>Can't be specified if <code>ManageMasterUserPassword</code> is turned on.</p>
|
|
5403
|
+
* </li>
|
|
5404
|
+
* <li>
|
|
5405
|
+
* <p>Can include any printable ASCII character except "/", """, or "@".</p>
|
|
5406
|
+
* </li>
|
|
5407
|
+
* </ul>
|
|
5408
|
+
* <p>Length Constraints:</p>
|
|
5409
|
+
* <ul>
|
|
5410
|
+
* <li>
|
|
5411
|
+
* <p>RDS for MariaDB - Must contain from 8 to 41 characters.</p>
|
|
5412
|
+
* </li>
|
|
5413
|
+
* <li>
|
|
5414
|
+
* <p>RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.</p>
|
|
5415
|
+
* </li>
|
|
5416
|
+
* <li>
|
|
5417
|
+
* <p>RDS for MySQL - Must contain from 8 to 41 characters.</p>
|
|
5418
|
+
* </li>
|
|
5419
|
+
* <li>
|
|
5420
|
+
* <p>RDS for Oracle - Must contain from 8 to 30 characters.</p>
|
|
5421
|
+
* </li>
|
|
5422
|
+
* <li>
|
|
5423
|
+
* <p>RDS for PostgreSQL - Must contain from 8 to 128 characters.</p>
|
|
5424
|
+
* </li>
|
|
5425
|
+
* </ul>
|
|
5445
5426
|
*/
|
|
5446
5427
|
MasterUserPassword?: string;
|
|
5447
5428
|
/**
|
|
@@ -5452,10 +5433,7 @@ export interface CreateDBInstanceMessage {
|
|
|
5452
5433
|
DBSecurityGroups?: string[];
|
|
5453
5434
|
/**
|
|
5454
5435
|
* <p>A list of Amazon EC2 VPC security groups to associate with this DB instance.</p>
|
|
5455
|
-
* <p>
|
|
5456
|
-
* <b>Amazon Aurora</b>
|
|
5457
|
-
* </p>
|
|
5458
|
-
* <p>Not applicable. The associated list of EC2 VPC security groups is managed by
|
|
5436
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by
|
|
5459
5437
|
* the DB cluster.</p>
|
|
5460
5438
|
* <p>Default: The default EC2 VPC security group for the DB subnet group's VPC.</p>
|
|
5461
5439
|
*/
|
|
@@ -5465,74 +5443,99 @@ export interface CreateDBInstanceMessage {
|
|
|
5465
5443
|
* Amazon Web Services Regions and Availability Zones, see
|
|
5466
5444
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions
|
|
5467
5445
|
* and Availability Zones</a>.</p>
|
|
5468
|
-
* <p>
|
|
5469
|
-
* <b>Amazon Aurora</b>
|
|
5470
|
-
* </p>
|
|
5471
|
-
* <p>Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these
|
|
5446
|
+
* <p>For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these
|
|
5472
5447
|
* Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.</p>
|
|
5473
5448
|
* <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.</p>
|
|
5449
|
+
* <p>Constraints:</p>
|
|
5450
|
+
* <ul>
|
|
5451
|
+
* <li>
|
|
5452
|
+
* <p>The <code>AvailabilityZone</code> parameter can't be specified if the DB instance is a Multi-AZ deployment.</p>
|
|
5453
|
+
* </li>
|
|
5454
|
+
* <li>
|
|
5455
|
+
* <p>The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.</p>
|
|
5456
|
+
* </li>
|
|
5457
|
+
* </ul>
|
|
5474
5458
|
* <p>Example: <code>us-east-1d</code>
|
|
5475
5459
|
* </p>
|
|
5476
|
-
* <p>Constraint: The <code>AvailabilityZone</code> parameter can't be specified if the DB instance is a Multi-AZ deployment.
|
|
5477
|
-
* The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.</p>
|
|
5478
5460
|
*/
|
|
5479
5461
|
AvailabilityZone?: string;
|
|
5480
5462
|
/**
|
|
5481
5463
|
* <p>A DB subnet group to associate with this DB instance.</p>
|
|
5482
|
-
* <p>Constraints
|
|
5464
|
+
* <p>Constraints:</p>
|
|
5465
|
+
* <ul>
|
|
5466
|
+
* <li>
|
|
5467
|
+
* <p>Must match the name of an existing DB subnet group.</p>
|
|
5468
|
+
* </li>
|
|
5469
|
+
* <li>
|
|
5470
|
+
* <p>Must not be <code>default</code>.</p>
|
|
5471
|
+
* </li>
|
|
5472
|
+
* </ul>
|
|
5483
5473
|
* <p>Example: <code>mydbsubnetgroup</code>
|
|
5484
5474
|
* </p>
|
|
5485
5475
|
*/
|
|
5486
5476
|
DBSubnetGroupName?: string;
|
|
5487
5477
|
/**
|
|
5488
|
-
* <p>The time range each week during which system maintenance can occur
|
|
5489
|
-
*
|
|
5490
|
-
*
|
|
5491
|
-
* <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code>
|
|
5478
|
+
* <p>The time range each week during which system maintenance can occur.
|
|
5479
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance">Amazon RDS Maintenance Window</a>
|
|
5480
|
+
* in the <i>Amazon RDS User Guide.</i>
|
|
5492
5481
|
* </p>
|
|
5493
5482
|
* <p>The default is a 30-minute window selected at random from an
|
|
5494
5483
|
* 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the
|
|
5495
5484
|
* week.</p>
|
|
5496
|
-
* <p>
|
|
5497
|
-
* <
|
|
5485
|
+
* <p>Constraints:</p>
|
|
5486
|
+
* <ul>
|
|
5487
|
+
* <li>
|
|
5488
|
+
* <p>Must be in the format <code>ddd:hh24:mi-ddd:hh24:mi</code>.</p>
|
|
5489
|
+
* </li>
|
|
5490
|
+
* <li>
|
|
5491
|
+
* <p>The day values must be <code>mon | tue | wed | thu | fri | sat | sun</code>. </p>
|
|
5492
|
+
* </li>
|
|
5493
|
+
* <li>
|
|
5494
|
+
* <p>Must be in Universal Coordinated Time (UTC).</p>
|
|
5495
|
+
* </li>
|
|
5496
|
+
* <li>
|
|
5497
|
+
* <p>Must not conflict with the preferred backup window.</p>
|
|
5498
|
+
* </li>
|
|
5499
|
+
* <li>
|
|
5500
|
+
* <p>Must be at least 30 minutes.</p>
|
|
5501
|
+
* </li>
|
|
5502
|
+
* </ul>
|
|
5498
5503
|
*/
|
|
5499
5504
|
PreferredMaintenanceWindow?: string;
|
|
5500
5505
|
/**
|
|
5501
|
-
* <p>The name of the DB parameter group to associate with this DB instance. If you
|
|
5502
|
-
* the default DB parameter group for the specified DB engine and version
|
|
5503
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5506
|
+
* <p>The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then
|
|
5507
|
+
* Amazon RDS uses the default DB parameter group for the specified DB engine and version.</p>
|
|
5508
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5504
5509
|
* <p>Constraints:</p>
|
|
5505
5510
|
* <ul>
|
|
5506
5511
|
* <li>
|
|
5507
|
-
* <p>
|
|
5512
|
+
* <p>Must be 1 to 255 letters, numbers, or hyphens.</p>
|
|
5508
5513
|
* </li>
|
|
5509
5514
|
* <li>
|
|
5510
5515
|
* <p>The first character must be a letter.</p>
|
|
5511
5516
|
* </li>
|
|
5512
5517
|
* <li>
|
|
5513
|
-
* <p>
|
|
5518
|
+
* <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
|
|
5514
5519
|
* </li>
|
|
5515
5520
|
* </ul>
|
|
5516
5521
|
*/
|
|
5517
5522
|
DBParameterGroupName?: string;
|
|
5518
5523
|
/**
|
|
5519
5524
|
* <p>The number of days for which automated backups are retained. Setting this parameter to a positive number enables
|
|
5520
|
-
* backups. Setting this parameter to 0 disables automated backups.</p>
|
|
5521
|
-
* <p>
|
|
5522
|
-
*
|
|
5525
|
+
* backups. Setting this parameter to <code>0</code> disables automated backups.</p>
|
|
5526
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.</p>
|
|
5527
|
+
* <p>Default: <code>1</code>
|
|
5523
5528
|
* </p>
|
|
5524
|
-
* <p>Not applicable. The retention period for automated backups is managed by the DB cluster.</p>
|
|
5525
|
-
* <p>Default: 1</p>
|
|
5526
5529
|
* <p>Constraints:</p>
|
|
5527
5530
|
* <ul>
|
|
5528
5531
|
* <li>
|
|
5529
|
-
* <p>Must be a value from 0 to 35
|
|
5532
|
+
* <p>Must be a value from 0 to 35.</p>
|
|
5530
5533
|
* </li>
|
|
5531
5534
|
* <li>
|
|
5532
|
-
* <p>Can't be set to 0 if the DB instance is a source to read replicas
|
|
5535
|
+
* <p>Can't be set to 0 if the DB instance is a source to read replicas.</p>
|
|
5533
5536
|
* </li>
|
|
5534
5537
|
* <li>
|
|
5535
|
-
* <p>Can't be set to 0 for an RDS Custom for Oracle DB instance
|
|
5538
|
+
* <p>Can't be set to 0 for an RDS Custom for Oracle DB instance.</p>
|
|
5536
5539
|
* </li>
|
|
5537
5540
|
* </ul>
|
|
5538
5541
|
*/
|
|
@@ -5543,10 +5546,7 @@ export interface CreateDBInstanceMessage {
|
|
|
5543
5546
|
* using the <code>BackupRetentionPeriod</code> parameter.
|
|
5544
5547
|
* The default is a 30-minute window selected at random from an
|
|
5545
5548
|
* 8-hour block of time for each Amazon Web Services Region. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow">Backup window</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
5546
|
-
* <p>
|
|
5547
|
-
* <b>Amazon Aurora</b>
|
|
5548
|
-
* </p>
|
|
5549
|
-
* <p>Not applicable. The daily time range for creating automated backups is managed by
|
|
5549
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by
|
|
5550
5550
|
* the DB cluster.</p>
|
|
5551
5551
|
* <p>Constraints:</p>
|
|
5552
5552
|
* <ul>
|
|
@@ -5567,178 +5567,188 @@ export interface CreateDBInstanceMessage {
|
|
|
5567
5567
|
PreferredBackupWindow?: string;
|
|
5568
5568
|
/**
|
|
5569
5569
|
* <p>The port number on which the database accepts connections.</p>
|
|
5570
|
-
* <p>
|
|
5571
|
-
*
|
|
5572
|
-
* </p>
|
|
5573
|
-
* <p>Default: <code>3306</code>
|
|
5574
|
-
* </p>
|
|
5575
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
5576
|
-
* </p>
|
|
5577
|
-
* <p>Type: Integer</p>
|
|
5578
|
-
* <p>
|
|
5579
|
-
* <b>MariaDB</b>
|
|
5580
|
-
* </p>
|
|
5581
|
-
* <p>Default: <code>3306</code>
|
|
5582
|
-
* </p>
|
|
5583
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
5584
|
-
* </p>
|
|
5585
|
-
* <p>Type: Integer</p>
|
|
5586
|
-
* <p>
|
|
5587
|
-
* <b>PostgreSQL</b>
|
|
5588
|
-
* </p>
|
|
5589
|
-
* <p>Default: <code>5432</code>
|
|
5590
|
-
* </p>
|
|
5591
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
5592
|
-
* </p>
|
|
5593
|
-
* <p>Type: Integer</p>
|
|
5594
|
-
* <p>
|
|
5595
|
-
* <b>Oracle</b>
|
|
5596
|
-
* </p>
|
|
5597
|
-
* <p>Default: <code>1521</code>
|
|
5598
|
-
* </p>
|
|
5599
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
5600
|
-
* </p>
|
|
5601
|
-
* <p>
|
|
5602
|
-
* <b>SQL Server</b>
|
|
5603
|
-
* </p>
|
|
5604
|
-
* <p>Default: <code>1433</code>
|
|
5570
|
+
* <p>This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.</p>
|
|
5571
|
+
* <p>Valid Values: <code>1150-65535</code>
|
|
5605
5572
|
* </p>
|
|
5606
|
-
* <p>
|
|
5607
|
-
*
|
|
5573
|
+
* <p>Default:</p>
|
|
5574
|
+
* <ul>
|
|
5575
|
+
* <li>
|
|
5576
|
+
* <p>RDS for MariaDB - <code>3306</code>
|
|
5577
|
+
* </p>
|
|
5578
|
+
* </li>
|
|
5579
|
+
* <li>
|
|
5580
|
+
* <p>RDS for Microsoft SQL Server - <code>1433</code>
|
|
5581
|
+
* </p>
|
|
5582
|
+
* </li>
|
|
5583
|
+
* <li>
|
|
5584
|
+
* <p>RDS for MySQL - <code>3306</code>
|
|
5585
|
+
* </p>
|
|
5586
|
+
* </li>
|
|
5587
|
+
* <li>
|
|
5588
|
+
* <p>RDS for Oracle - <code>1521</code>
|
|
5589
|
+
* </p>
|
|
5590
|
+
* </li>
|
|
5591
|
+
* <li>
|
|
5592
|
+
* <p>RDS for PostgreSQL - <code>5432</code>
|
|
5593
|
+
* </p>
|
|
5594
|
+
* </li>
|
|
5595
|
+
* </ul>
|
|
5596
|
+
* <p>Constraints:</p>
|
|
5597
|
+
* <ul>
|
|
5598
|
+
* <li>
|
|
5599
|
+
* <p>For RDS for Microsoft SQL Server, the value can't be <code>1234</code>, <code>1434</code>,
|
|
5600
|
+
* <code>3260</code>, <code>3343</code>, <code>3389</code>, <code>47001</code>, or
|
|
5608
5601
|
* <code>49152-49156</code>.</p>
|
|
5609
|
-
*
|
|
5610
|
-
*
|
|
5611
|
-
* </p>
|
|
5612
|
-
* <p>Default: <code>3306</code>
|
|
5613
|
-
* </p>
|
|
5614
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
5615
|
-
* </p>
|
|
5616
|
-
* <p>Type: Integer</p>
|
|
5602
|
+
* </li>
|
|
5603
|
+
* </ul>
|
|
5617
5604
|
*/
|
|
5618
5605
|
Port?: number;
|
|
5619
5606
|
/**
|
|
5620
|
-
* <p>
|
|
5607
|
+
* <p>Specifies whether the DB instance is a Multi-AZ deployment. You can't set
|
|
5621
5608
|
* the <code>AvailabilityZone</code> parameter if the DB instance is a Multi-AZ deployment.</p>
|
|
5622
|
-
* <p>This setting doesn't apply to
|
|
5623
|
-
* <
|
|
5624
|
-
* <
|
|
5625
|
-
*
|
|
5626
|
-
*
|
|
5609
|
+
* <p>This setting doesn't apply to the following DB instances:</p>
|
|
5610
|
+
* <ul>
|
|
5611
|
+
* <li>
|
|
5612
|
+
* <p>Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)</p>
|
|
5613
|
+
* </li>
|
|
5614
|
+
* <li>
|
|
5615
|
+
* <p>RDS Custom</p>
|
|
5616
|
+
* </li>
|
|
5617
|
+
* </ul>
|
|
5627
5618
|
*/
|
|
5628
5619
|
MultiAZ?: boolean;
|
|
5629
5620
|
/**
|
|
5630
5621
|
* <p>The version number of the database engine to use.</p>
|
|
5622
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB
|
|
5623
|
+
* instance uses is managed by the DB cluster.</p>
|
|
5631
5624
|
* <p>For a list of valid engine versions, use the <code>DescribeDBEngineVersions</code>
|
|
5632
5625
|
* operation.</p>
|
|
5633
5626
|
* <p>The following are the database engines and links to information about the major and minor versions that are available with
|
|
5634
5627
|
* Amazon RDS. Not every database engine is available for every Amazon Web Services Region.</p>
|
|
5635
|
-
* <
|
|
5636
|
-
* <
|
|
5637
|
-
*
|
|
5638
|
-
*
|
|
5639
|
-
*
|
|
5640
|
-
*
|
|
5641
|
-
* <
|
|
5642
|
-
*
|
|
5643
|
-
*
|
|
5644
|
-
*
|
|
5645
|
-
*
|
|
5646
|
-
*
|
|
5647
|
-
*
|
|
5648
|
-
*
|
|
5649
|
-
*
|
|
5650
|
-
*
|
|
5651
|
-
*
|
|
5652
|
-
*
|
|
5653
|
-
* <
|
|
5654
|
-
*
|
|
5655
|
-
*
|
|
5656
|
-
*
|
|
5657
|
-
*
|
|
5658
|
-
*
|
|
5659
|
-
*
|
|
5660
|
-
*
|
|
5661
|
-
*
|
|
5662
|
-
*
|
|
5663
|
-
*
|
|
5664
|
-
*
|
|
5665
|
-
*
|
|
5666
|
-
*
|
|
5667
|
-
*
|
|
5668
|
-
*
|
|
5669
|
-
*
|
|
5670
|
-
*
|
|
5671
|
-
*
|
|
5672
|
-
*
|
|
5673
|
-
*
|
|
5674
|
-
* </p>
|
|
5675
|
-
* <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
|
|
5676
|
-
* <i>Amazon RDS User Guide</i>.</p>
|
|
5628
|
+
* <dl>
|
|
5629
|
+
* <dt>Amazon RDS Custom for Oracle</dt>
|
|
5630
|
+
* <dt>Amazon RDS Custom for SQL Server</dt>
|
|
5631
|
+
* <dt>RDS for MariaDB</dt>
|
|
5632
|
+
* <dt>RDS for Microsoft SQL Server</dt>
|
|
5633
|
+
* <dt>RDS for MySQL</dt>
|
|
5634
|
+
* <dt>RDS for Oracle</dt>
|
|
5635
|
+
* <dt>RDS for PostgreSQL</dt>
|
|
5636
|
+
* <dd>
|
|
5637
|
+
* <p>A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV
|
|
5638
|
+
* name has the following format: 19.<i>customized_string</i>. A valid CEV name is
|
|
5639
|
+
* <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">
|
|
5640
|
+
* Creating an RDS Custom for Oracle DB instance</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
5641
|
+
* </dd>
|
|
5642
|
+
* <dd>
|
|
5643
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html">RDS Custom for SQL Server general requirements</a>
|
|
5644
|
+
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
5645
|
+
* </dd>
|
|
5646
|
+
* <dd>
|
|
5647
|
+
* <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
|
|
5648
|
+
* <i>Amazon RDS User Guide</i>.</p>
|
|
5649
|
+
* </dd>
|
|
5650
|
+
* <dd>
|
|
5651
|
+
* <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
|
|
5652
|
+
* <i>Amazon RDS User Guide</i>.</p>
|
|
5653
|
+
* </dd>
|
|
5654
|
+
* <dd>
|
|
5655
|
+
* <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
|
|
5656
|
+
* <i>Amazon RDS User Guide</i>.</p>
|
|
5657
|
+
* </dd>
|
|
5658
|
+
* <dd>
|
|
5659
|
+
* <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
|
|
5660
|
+
* <i>Amazon RDS User Guide</i>.</p>
|
|
5661
|
+
* </dd>
|
|
5662
|
+
* <dd>
|
|
5663
|
+
* <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
|
|
5664
|
+
* <i>Amazon RDS User Guide</i>.</p>
|
|
5665
|
+
* </dd>
|
|
5666
|
+
* </dl>
|
|
5677
5667
|
*/
|
|
5678
5668
|
EngineVersion?: string;
|
|
5679
5669
|
/**
|
|
5680
|
-
* <p>
|
|
5670
|
+
* <p>Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
|
|
5681
5671
|
* By default, minor engine upgrades are applied automatically.</p>
|
|
5682
5672
|
* <p>If you create an RDS Custom DB instance, you must set <code>AutoMinorVersionUpgrade</code> to
|
|
5683
5673
|
* <code>false</code>.</p>
|
|
5684
5674
|
*/
|
|
5685
5675
|
AutoMinorVersionUpgrade?: boolean;
|
|
5686
5676
|
/**
|
|
5687
|
-
* <p>
|
|
5688
|
-
* <p>
|
|
5689
|
-
*
|
|
5690
|
-
* <
|
|
5691
|
-
*
|
|
5692
|
-
*
|
|
5693
|
-
*
|
|
5694
|
-
*
|
|
5677
|
+
* <p>The license model information for this DB instance.</p>
|
|
5678
|
+
* <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>
|
|
5679
|
+
* <p>Valid Values:</p>
|
|
5680
|
+
* <ul>
|
|
5681
|
+
* <li>
|
|
5682
|
+
* <p>RDS for MariaDB - <code>general-public-license</code>
|
|
5683
|
+
* </p>
|
|
5684
|
+
* </li>
|
|
5685
|
+
* <li>
|
|
5686
|
+
* <p>RDS for Microsoft SQL Server - <code>license-included</code>
|
|
5687
|
+
* </p>
|
|
5688
|
+
* </li>
|
|
5689
|
+
* <li>
|
|
5690
|
+
* <p>RDS for MySQL - <code>general-public-license</code>
|
|
5691
|
+
* </p>
|
|
5692
|
+
* </li>
|
|
5693
|
+
* <li>
|
|
5694
|
+
* <p>RDS for Oracle - <code>bring-your-own-license | license-included</code>
|
|
5695
|
+
* </p>
|
|
5696
|
+
* </li>
|
|
5697
|
+
* <li>
|
|
5698
|
+
* <p>RDS for PostgreSQL - <code>postgresql-license</code>
|
|
5699
|
+
* </p>
|
|
5700
|
+
* </li>
|
|
5701
|
+
* </ul>
|
|
5695
5702
|
*/
|
|
5696
5703
|
LicenseModel?: string;
|
|
5697
5704
|
/**
|
|
5698
|
-
* <p>The amount of Provisioned IOPS (input/output operations per second) to
|
|
5705
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
|
|
5699
5706
|
* For information about valid IOPS values, see
|
|
5700
5707
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html">Amazon RDS DB instance storage</a>
|
|
5701
5708
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
5702
|
-
* <p>
|
|
5703
|
-
*
|
|
5709
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.</p>
|
|
5710
|
+
* <p>Constraints:</p>
|
|
5711
|
+
* <ul>
|
|
5712
|
+
* <li>
|
|
5713
|
+
* <p>For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50
|
|
5704
5714
|
* of the storage amount for the DB instance.</p>
|
|
5705
|
-
*
|
|
5706
|
-
* <
|
|
5707
|
-
*
|
|
5708
|
-
*
|
|
5715
|
+
* </li>
|
|
5716
|
+
* <li>
|
|
5717
|
+
* <p>For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.</p>
|
|
5718
|
+
* </li>
|
|
5719
|
+
* </ul>
|
|
5709
5720
|
*/
|
|
5710
5721
|
Iops?: number;
|
|
5711
5722
|
/**
|
|
5712
|
-
* <p>
|
|
5723
|
+
* <p>The option group to associate the DB instance with.</p>
|
|
5713
5724
|
* <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed
|
|
5714
5725
|
* from an option group. Also, that option group can't be removed from a DB instance after it is
|
|
5715
5726
|
* associated with a DB instance.</p>
|
|
5716
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5717
|
-
* <p>
|
|
5718
|
-
* <b>Amazon Aurora</b>
|
|
5719
|
-
* </p>
|
|
5720
|
-
* <p>Not applicable.</p>
|
|
5727
|
+
* <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>
|
|
5721
5728
|
*/
|
|
5722
5729
|
OptionGroupName?: string;
|
|
5723
5730
|
/**
|
|
5724
|
-
* <p>For supported engines,
|
|
5725
|
-
*
|
|
5726
|
-
* <
|
|
5727
|
-
*
|
|
5728
|
-
*
|
|
5729
|
-
* <b>Amazon Aurora</b>
|
|
5730
|
-
* </p>
|
|
5731
|
-
* <p>Not applicable. The character set is managed by
|
|
5731
|
+
* <p>For supported engines, the character set (<code>CharacterSet</code>) to associate the DB instance with.</p>
|
|
5732
|
+
* <p>This setting doesn't apply to the following DB instances:</p>
|
|
5733
|
+
* <ul>
|
|
5734
|
+
* <li>
|
|
5735
|
+
* <p>Amazon Aurora - The character set is managed by
|
|
5732
5736
|
* the DB cluster. For more information, see <code>CreateDBCluster</code>.</p>
|
|
5737
|
+
* </li>
|
|
5738
|
+
* <li>
|
|
5739
|
+
* <p>RDS Custom - However, if you need to change the character set,
|
|
5740
|
+
* you can change it on the database itself.</p>
|
|
5741
|
+
* </li>
|
|
5742
|
+
* </ul>
|
|
5733
5743
|
*/
|
|
5734
5744
|
CharacterSetName?: string;
|
|
5735
5745
|
/**
|
|
5736
5746
|
* <p>The name of the NCHAR character set for the Oracle DB instance.</p>
|
|
5737
|
-
* <p>This
|
|
5747
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5738
5748
|
*/
|
|
5739
5749
|
NcharCharacterSetName?: string;
|
|
5740
5750
|
/**
|
|
5741
|
-
* <p>
|
|
5751
|
+
* <p>Specifies whether the DB instance is publicly accessible.</p>
|
|
5742
5752
|
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from
|
|
5743
5753
|
* within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC.
|
|
5744
5754
|
* Access to the DB instance is ultimately controlled by the security group it uses.
|
|
@@ -5770,99 +5780,84 @@ export interface CreateDBInstanceMessage {
|
|
|
5770
5780
|
*/
|
|
5771
5781
|
Tags?: Tag[];
|
|
5772
5782
|
/**
|
|
5773
|
-
* <p>The identifier of the DB cluster that
|
|
5774
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5783
|
+
* <p>The identifier of the DB cluster that this DB instance will belong to.</p>
|
|
5784
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5775
5785
|
*/
|
|
5776
5786
|
DBClusterIdentifier?: string;
|
|
5777
5787
|
/**
|
|
5778
|
-
* <p>
|
|
5779
|
-
* <p>Valid values: <code>gp2 | gp3 | io1 | standard</code>
|
|
5780
|
-
* </p>
|
|
5788
|
+
* <p>The storage type to associate with the DB instance.</p>
|
|
5781
5789
|
* <p>If you specify <code>io1</code> or <code>gp3</code>, you must also include a value for the
|
|
5782
5790
|
* <code>Iops</code> parameter.</p>
|
|
5783
|
-
* <p>
|
|
5784
|
-
*
|
|
5785
|
-
* </p>
|
|
5786
|
-
* <p>
|
|
5787
|
-
* <b>Amazon Aurora</b>
|
|
5791
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.</p>
|
|
5792
|
+
* <p>Valid Values: <code>gp2 | gp3 | io1 | standard</code>
|
|
5788
5793
|
* </p>
|
|
5789
|
-
* <p>
|
|
5794
|
+
* <p>Default: <code>io1</code>, if the <code>Iops</code> parameter
|
|
5795
|
+
* is specified. Otherwise, <code>gp2</code>.</p>
|
|
5790
5796
|
*/
|
|
5791
5797
|
StorageType?: string;
|
|
5792
5798
|
/**
|
|
5793
5799
|
* <p>The ARN from the key store with which to associate the instance for TDE encryption.</p>
|
|
5794
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5795
|
-
* <p>
|
|
5796
|
-
* <b>Amazon Aurora</b>
|
|
5797
|
-
* </p>
|
|
5798
|
-
* <p>Not applicable.</p>
|
|
5800
|
+
* <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>
|
|
5799
5801
|
*/
|
|
5800
5802
|
TdeCredentialArn?: string;
|
|
5801
5803
|
/**
|
|
5802
5804
|
* <p>The password for the given ARN from the key store in order to access the device.</p>
|
|
5803
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5805
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5804
5806
|
*/
|
|
5805
5807
|
TdeCredentialPassword?: string;
|
|
5806
5808
|
/**
|
|
5807
|
-
* <p>
|
|
5808
|
-
* <p>For RDS Custom instances, either
|
|
5809
|
-
*
|
|
5810
|
-
* <p>
|
|
5811
|
-
* <b>Amazon Aurora</b>
|
|
5812
|
-
* </p>
|
|
5813
|
-
* <p>Not applicable. The encryption for DB instances is managed by the DB cluster.</p>
|
|
5809
|
+
* <p>Specifes whether the DB instance is encrypted. By default, it isn't encrypted.</p>
|
|
5810
|
+
* <p>For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.</p>
|
|
5811
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.</p>
|
|
5814
5812
|
*/
|
|
5815
5813
|
StorageEncrypted?: boolean;
|
|
5816
5814
|
/**
|
|
5817
5815
|
* <p>The Amazon Web Services KMS key identifier for an encrypted DB instance.</p>
|
|
5818
5816
|
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
5819
5817
|
* To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p>
|
|
5820
|
-
* <p>
|
|
5821
|
-
* <b>Amazon Aurora</b>
|
|
5822
|
-
* </p>
|
|
5823
|
-
* <p>Not applicable. The Amazon Web Services KMS key identifier is managed by
|
|
5818
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by
|
|
5824
5819
|
* the DB cluster. For more information, see <code>CreateDBCluster</code>.</p>
|
|
5825
5820
|
* <p>If <code>StorageEncrypted</code> is enabled, and you do
|
|
5826
5821
|
* not specify a value for the <code>KmsKeyId</code> parameter, then
|
|
5827
5822
|
* Amazon RDS uses your default KMS key. There is a
|
|
5828
5823
|
* default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different
|
|
5829
5824
|
* default KMS key for each Amazon Web Services Region.</p>
|
|
5830
|
-
* <p>
|
|
5831
|
-
* <b>Amazon RDS Custom</b>
|
|
5832
|
-
* </p>
|
|
5833
|
-
* <p>A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty
|
|
5825
|
+
* <p>For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty
|
|
5834
5826
|
* while enabling <code>StorageEncrypted</code>, the engine uses the default KMS key. However, RDS Custom
|
|
5835
5827
|
* doesn't use the default key when this parameter is empty. You must explicitly specify a key.</p>
|
|
5836
5828
|
*/
|
|
5837
5829
|
KmsKeyId?: string;
|
|
5838
5830
|
/**
|
|
5839
|
-
* <p>The Active Directory directory ID to create the DB instance in. Currently, only
|
|
5840
|
-
* Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.</p>
|
|
5831
|
+
* <p>The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL
|
|
5832
|
+
* Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.</p>
|
|
5841
5833
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html">
|
|
5842
5834
|
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
5843
|
-
* <p>This setting doesn't apply to
|
|
5844
|
-
* <
|
|
5845
|
-
* <
|
|
5846
|
-
*
|
|
5847
|
-
*
|
|
5835
|
+
* <p>This setting doesn't apply to the following DB instances:</p>
|
|
5836
|
+
* <ul>
|
|
5837
|
+
* <li>
|
|
5838
|
+
* <p>Amazon Aurora (The domain is managed by the DB cluster.)</p>
|
|
5839
|
+
* </li>
|
|
5840
|
+
* <li>
|
|
5841
|
+
* <p>RDS Custom</p>
|
|
5842
|
+
* </li>
|
|
5843
|
+
* </ul>
|
|
5848
5844
|
*/
|
|
5849
5845
|
Domain?: string;
|
|
5850
5846
|
/**
|
|
5851
|
-
* <p>
|
|
5852
|
-
* <p>
|
|
5853
|
-
* <b>Amazon Aurora</b>
|
|
5854
|
-
* </p>
|
|
5855
|
-
* <p>Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this
|
|
5847
|
+
* <p>Spcifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.</p>
|
|
5848
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this
|
|
5856
5849
|
* value for an Aurora DB instance has no effect on the DB cluster setting.</p>
|
|
5857
5850
|
*/
|
|
5858
5851
|
CopyTagsToSnapshot?: boolean;
|
|
5859
5852
|
/**
|
|
5860
5853
|
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for
|
|
5861
|
-
* the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0
|
|
5854
|
+
* the DB instance. To disable collection of Enhanced Monitoring metrics, specify <code>0</code>.</p>
|
|
5862
5855
|
* <p>If <code>MonitoringRoleArn</code> is specified, then you must set <code>MonitoringInterval</code>
|
|
5863
|
-
* to a value other than 0
|
|
5864
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5865
|
-
* <p>Valid Values: <code>0
|
|
5856
|
+
* to a value other than <code>0</code>.</p>
|
|
5857
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5858
|
+
* <p>Valid Values: <code>0 | 1 | 5 | 10 | 15 | 30 | 60</code>
|
|
5859
|
+
* </p>
|
|
5860
|
+
* <p>Default: <code>0</code>
|
|
5866
5861
|
* </p>
|
|
5867
5862
|
*/
|
|
5868
5863
|
MonitoringInterval?: number;
|
|
@@ -5871,27 +5866,33 @@ export interface CreateDBInstanceMessage {
|
|
|
5871
5866
|
* example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role,
|
|
5872
5867
|
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling">Setting Up and Enabling Enhanced Monitoring</a>
|
|
5873
5868
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
5874
|
-
* <p>If <code>MonitoringInterval</code> is set to a value other than 0
|
|
5875
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5869
|
+
* <p>If <code>MonitoringInterval</code> is set to a value other than <code>0</code>, then you must supply a <code>MonitoringRoleArn</code> value.</p>
|
|
5870
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5876
5871
|
*/
|
|
5877
5872
|
MonitoringRoleArn?: string;
|
|
5878
5873
|
/**
|
|
5879
|
-
* <p>
|
|
5880
|
-
* <p>This setting doesn't apply to
|
|
5881
|
-
* <
|
|
5882
|
-
* <
|
|
5883
|
-
*
|
|
5884
|
-
*
|
|
5874
|
+
* <p>The name of the IAM role to use when making API calls to the Directory Service.</p>
|
|
5875
|
+
* <p>This setting doesn't apply to the following DB instances:</p>
|
|
5876
|
+
* <ul>
|
|
5877
|
+
* <li>
|
|
5878
|
+
* <p>Amazon Aurora (The domain is managed by the DB cluster.)</p>
|
|
5879
|
+
* </li>
|
|
5880
|
+
* <li>
|
|
5881
|
+
* <p>RDS Custom</p>
|
|
5882
|
+
* </li>
|
|
5883
|
+
* </ul>
|
|
5885
5884
|
*/
|
|
5886
5885
|
DomainIAMRoleName?: string;
|
|
5887
5886
|
/**
|
|
5888
|
-
* <p>
|
|
5887
|
+
* <p>The order of priority in which an Aurora Replica is promoted to the primary instance
|
|
5889
5888
|
* after a failure of the existing primary instance. For more information,
|
|
5890
|
-
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
|
5889
|
+
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance">
|
|
5891
5890
|
* Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
5892
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5893
|
-
* <p>Default: 1</
|
|
5894
|
-
*
|
|
5891
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5892
|
+
* <p>Default: <code>1</code>
|
|
5893
|
+
* </p>
|
|
5894
|
+
* <p>Valid Values: <code>0 - 15</code>
|
|
5895
|
+
* </p>
|
|
5895
5896
|
*/
|
|
5896
5897
|
PromotionTier?: number;
|
|
5897
5898
|
/**
|
|
@@ -5901,121 +5902,112 @@ export interface CreateDBInstanceMessage {
|
|
|
5901
5902
|
*/
|
|
5902
5903
|
Timezone?: string;
|
|
5903
5904
|
/**
|
|
5904
|
-
* <p>
|
|
5905
|
+
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
5905
5906
|
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
5906
5907
|
* <p>For more information, see
|
|
5907
5908
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
5908
5909
|
* IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
5909
|
-
* <p>This setting doesn't apply to
|
|
5910
|
-
* <
|
|
5911
|
-
* <
|
|
5912
|
-
*
|
|
5913
|
-
*
|
|
5910
|
+
* <p>This setting doesn't apply to the following DB instances:</p>
|
|
5911
|
+
* <ul>
|
|
5912
|
+
* <li>
|
|
5913
|
+
* <p>Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)</p>
|
|
5914
|
+
* </li>
|
|
5915
|
+
* <li>
|
|
5916
|
+
* <p>RDS Custom</p>
|
|
5917
|
+
* </li>
|
|
5918
|
+
* </ul>
|
|
5914
5919
|
*/
|
|
5915
5920
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
5916
5921
|
/**
|
|
5917
|
-
* <p>
|
|
5922
|
+
* <p>Specifies whether to enable Performance Insights for the DB instance. For more information, see
|
|
5918
5923
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
5919
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5924
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5920
5925
|
*/
|
|
5921
5926
|
EnablePerformanceInsights?: boolean;
|
|
5922
5927
|
/**
|
|
5923
5928
|
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
|
|
5924
5929
|
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
5925
|
-
* <p>If you
|
|
5930
|
+
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
5926
5931
|
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
5927
5932
|
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
5928
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5933
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5929
5934
|
*/
|
|
5930
5935
|
PerformanceInsightsKMSKeyId?: string;
|
|
5931
5936
|
/**
|
|
5932
|
-
* <p>The number of days to retain Performance Insights data
|
|
5937
|
+
* <p>The number of days to retain Performance Insights data.</p>
|
|
5938
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
5939
|
+
* <p>Valid Values:</p>
|
|
5933
5940
|
* <ul>
|
|
5934
5941
|
* <li>
|
|
5935
|
-
* <p>
|
|
5942
|
+
* <p>
|
|
5943
|
+
* <code>7</code>
|
|
5944
|
+
* </p>
|
|
5936
5945
|
* </li>
|
|
5937
5946
|
* <li>
|
|
5938
5947
|
* <p>
|
|
5939
|
-
* <i>month</i> * 31, where <i>month</i> is a number of months from 1-23
|
|
5948
|
+
* <i>month</i> * 31, where <i>month</i> is a number of months from 1-23.
|
|
5949
|
+
* Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31)</p>
|
|
5940
5950
|
* </li>
|
|
5941
5951
|
* <li>
|
|
5942
|
-
* <p>
|
|
5952
|
+
* <p>
|
|
5953
|
+
* <code>731</code>
|
|
5954
|
+
* </p>
|
|
5943
5955
|
* </li>
|
|
5944
5956
|
* </ul>
|
|
5945
|
-
* <p>
|
|
5957
|
+
* <p>Default: <code>7</code> days</p>
|
|
5958
|
+
* <p>If you specify a retention period that isn't valid, such as <code>94</code>, Amazon RDS returns an error.</p>
|
|
5959
|
+
*/
|
|
5960
|
+
PerformanceInsightsRetentionPeriod?: number;
|
|
5961
|
+
/**
|
|
5962
|
+
* <p>The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see
|
|
5963
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">
|
|
5964
|
+
* Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
5965
|
+
* <p>This setting doesn't apply to the following DB instances:</p>
|
|
5946
5966
|
* <ul>
|
|
5947
5967
|
* <li>
|
|
5948
|
-
* <p>
|
|
5968
|
+
* <p>Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)</p>
|
|
5949
5969
|
* </li>
|
|
5950
5970
|
* <li>
|
|
5951
|
-
* <p>
|
|
5971
|
+
* <p>RDS Custom</p>
|
|
5952
5972
|
* </li>
|
|
5973
|
+
* </ul>
|
|
5974
|
+
* <p>The following values are valid for each DB engine:</p>
|
|
5975
|
+
* <ul>
|
|
5953
5976
|
* <li>
|
|
5954
|
-
* <p>
|
|
5977
|
+
* <p>RDS for MariaDB - <code>audit | error | general | slowquery</code>
|
|
5978
|
+
* </p>
|
|
5955
5979
|
* </li>
|
|
5956
5980
|
* <li>
|
|
5957
|
-
* <p>
|
|
5981
|
+
* <p>RDS for Microsoft SQL Server - <code>agent | error</code>
|
|
5982
|
+
* </p>
|
|
5983
|
+
* </li>
|
|
5984
|
+
* <li>
|
|
5985
|
+
* <p>RDS for MySQL - <code>audit | error | general | slowquery</code>
|
|
5986
|
+
* </p>
|
|
5987
|
+
* </li>
|
|
5988
|
+
* <li>
|
|
5989
|
+
* <p>RDS for Oracle - <code>alert | audit | listener | trace | oemagent</code>
|
|
5990
|
+
* </p>
|
|
5991
|
+
* </li>
|
|
5992
|
+
* <li>
|
|
5993
|
+
* <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
|
|
5994
|
+
* </p>
|
|
5958
5995
|
* </li>
|
|
5959
5996
|
* </ul>
|
|
5960
|
-
* <p>If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.</p>
|
|
5961
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
5962
|
-
*/
|
|
5963
|
-
PerformanceInsightsRetentionPeriod?: number;
|
|
5964
|
-
/**
|
|
5965
|
-
* <p>The list of log types that need to be enabled for exporting to CloudWatch Logs. The values
|
|
5966
|
-
* in the list depend on the DB engine. For more information, see
|
|
5967
|
-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">
|
|
5968
|
-
* Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
5969
|
-
* <p>
|
|
5970
|
-
* <b>Amazon Aurora</b>
|
|
5971
|
-
* </p>
|
|
5972
|
-
* <p>Not applicable. CloudWatch Logs exports are managed by the DB cluster.</p>
|
|
5973
|
-
* <p>
|
|
5974
|
-
* <b>RDS Custom</b>
|
|
5975
|
-
* </p>
|
|
5976
|
-
* <p>Not applicable.</p>
|
|
5977
|
-
* <p>
|
|
5978
|
-
* <b>MariaDB</b>
|
|
5979
|
-
* </p>
|
|
5980
|
-
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p>
|
|
5981
|
-
* <p>
|
|
5982
|
-
* <b>Microsoft SQL Server</b>
|
|
5983
|
-
* </p>
|
|
5984
|
-
* <p>Possible values are <code>agent</code> and <code>error</code>.</p>
|
|
5985
|
-
* <p>
|
|
5986
|
-
* <b>MySQL</b>
|
|
5987
|
-
* </p>
|
|
5988
|
-
* <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p>
|
|
5989
|
-
* <p>
|
|
5990
|
-
* <b>Oracle</b>
|
|
5991
|
-
* </p>
|
|
5992
|
-
* <p>Possible values are <code>alert</code>, <code>audit</code>, <code>listener</code>, <code>trace</code>, and
|
|
5993
|
-
* <code>oemagent</code>.</p>
|
|
5994
|
-
* <p>
|
|
5995
|
-
* <b>PostgreSQL</b>
|
|
5996
|
-
* </p>
|
|
5997
|
-
* <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p>
|
|
5998
5997
|
*/
|
|
5999
5998
|
EnableCloudwatchLogsExports?: string[];
|
|
6000
5999
|
/**
|
|
6001
6000
|
* <p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.</p>
|
|
6002
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6003
|
-
* <p>
|
|
6004
|
-
* <b>Amazon Aurora</b>
|
|
6005
|
-
* </p>
|
|
6006
|
-
* <p>Not applicable.</p>
|
|
6001
|
+
* <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>
|
|
6007
6002
|
*/
|
|
6008
6003
|
ProcessorFeatures?: ProcessorFeature[];
|
|
6009
6004
|
/**
|
|
6010
|
-
* <p>
|
|
6005
|
+
* <p>Specifies whether the DB instance has deletion protection enabled.
|
|
6011
6006
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6012
6007
|
* deletion protection isn't enabled. For more information, see
|
|
6013
6008
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
6014
6009
|
* Deleting a DB Instance</a>.</p>
|
|
6015
|
-
* <p>
|
|
6016
|
-
* <b>Amazon Aurora</b>
|
|
6017
|
-
* </p>
|
|
6018
|
-
* <p>Not applicable. You can enable or disable deletion protection for the DB cluster.
|
|
6010
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster.
|
|
6019
6011
|
* For more information, see <code>CreateDBCluster</code>. DB instances in a DB
|
|
6020
6012
|
* cluster can be deleted even when deletion protection is enabled for the DB cluster.</p>
|
|
6021
6013
|
*/
|
|
@@ -6026,15 +6018,19 @@ export interface CreateDBInstanceMessage {
|
|
|
6026
6018
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling">
|
|
6027
6019
|
* Managing capacity automatically with Amazon RDS storage autoscaling</a>
|
|
6028
6020
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
6029
|
-
* <p>This setting doesn't apply to
|
|
6030
|
-
* <
|
|
6031
|
-
* <
|
|
6032
|
-
*
|
|
6033
|
-
*
|
|
6021
|
+
* <p>This setting doesn't apply to the following DB instances:</p>
|
|
6022
|
+
* <ul>
|
|
6023
|
+
* <li>
|
|
6024
|
+
* <p>Amazon Aurora (Storage is managed by the DB cluster.)</p>
|
|
6025
|
+
* </li>
|
|
6026
|
+
* <li>
|
|
6027
|
+
* <p>RDS Custom</p>
|
|
6028
|
+
* </li>
|
|
6029
|
+
* </ul>
|
|
6034
6030
|
*/
|
|
6035
6031
|
MaxAllocatedStorage?: number;
|
|
6036
6032
|
/**
|
|
6037
|
-
* <p>
|
|
6033
|
+
* <p>Specifies whether to enable a customer-owned IP address (CoIP) for an RDS
|
|
6038
6034
|
* on Outposts DB instance.</p>
|
|
6039
6035
|
* <p>A <i>CoIP</i> provides local or external connectivity to resources in
|
|
6040
6036
|
* your Outpost subnets through your on-premises network. For some use cases, a CoIP can
|
|
@@ -6048,7 +6044,9 @@ export interface CreateDBInstanceMessage {
|
|
|
6048
6044
|
EnableCustomerOwnedIp?: boolean;
|
|
6049
6045
|
/**
|
|
6050
6046
|
* <p>The instance profile associated with the underlying Amazon EC2 instance of an
|
|
6051
|
-
* RDS Custom DB instance
|
|
6047
|
+
* RDS Custom DB instance.</p>
|
|
6048
|
+
* <p>This setting is required for RDS Custom.</p>
|
|
6049
|
+
* <p>Constraints:</p>
|
|
6052
6050
|
* <ul>
|
|
6053
6051
|
* <li>
|
|
6054
6052
|
* <p>The profile must exist in your account.</p>
|
|
@@ -6063,31 +6061,29 @@ export interface CreateDBInstanceMessage {
|
|
|
6063
6061
|
* <p>For the list of permissions required for the IAM role, see
|
|
6064
6062
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc">
|
|
6065
6063
|
* Configure IAM and your VPC</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
6066
|
-
* <p>This setting is required for RDS Custom.</p>
|
|
6067
6064
|
*/
|
|
6068
6065
|
CustomIamInstanceProfile?: string;
|
|
6069
6066
|
/**
|
|
6070
|
-
* <p>
|
|
6071
|
-
* <p>
|
|
6072
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working
|
|
6073
|
-
* with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
6074
|
-
*/
|
|
6075
|
-
BackupTarget?: string;
|
|
6076
|
-
/**
|
|
6077
|
-
* <p>The network type of the DB instance.</p>
|
|
6078
|
-
* <p>Valid values:</p>
|
|
6067
|
+
* <p>The location for storing automated backups and manual snapshots.</p>
|
|
6068
|
+
* <p>Valie Values:</p>
|
|
6079
6069
|
* <ul>
|
|
6080
6070
|
* <li>
|
|
6081
6071
|
* <p>
|
|
6082
|
-
* <code>
|
|
6083
|
-
* </p>
|
|
6072
|
+
* <code>outposts</code> (Amazon Web Services Outposts)</p>
|
|
6084
6073
|
* </li>
|
|
6085
6074
|
* <li>
|
|
6086
6075
|
* <p>
|
|
6087
|
-
* <code>
|
|
6088
|
-
* </p>
|
|
6076
|
+
* <code>region</code> (Amazon Web Services Region)</p>
|
|
6089
6077
|
* </li>
|
|
6090
6078
|
* </ul>
|
|
6079
|
+
* <p>Default: <code>region</code>
|
|
6080
|
+
* </p>
|
|
6081
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working
|
|
6082
|
+
* with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
6083
|
+
*/
|
|
6084
|
+
BackupTarget?: string;
|
|
6085
|
+
/**
|
|
6086
|
+
* <p>The network type of the DB instance.</p>
|
|
6091
6087
|
* <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the DB instance.
|
|
6092
6088
|
* A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6
|
|
6093
6089
|
* protocols (<code>DUAL</code>).</p>
|
|
@@ -6095,16 +6091,18 @@ export interface CreateDBInstanceMessage {
|
|
|
6095
6091
|
* Working with a DB instance in a VPC</a> in the
|
|
6096
6092
|
* <i>Amazon RDS User Guide.</i>
|
|
6097
6093
|
* </p>
|
|
6094
|
+
* <p>Valid Values: <code>IPV4 | DUAL</code>
|
|
6095
|
+
* </p>
|
|
6098
6096
|
*/
|
|
6099
6097
|
NetworkType?: string;
|
|
6100
6098
|
/**
|
|
6101
|
-
* <p>
|
|
6099
|
+
* <p>The storage throughput value for the DB instance.</p>
|
|
6102
6100
|
* <p>This setting applies only to the <code>gp3</code> storage type.</p>
|
|
6103
|
-
* <p>This setting doesn't apply to RDS Custom
|
|
6101
|
+
* <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>
|
|
6104
6102
|
*/
|
|
6105
6103
|
StorageThroughput?: number;
|
|
6106
6104
|
/**
|
|
6107
|
-
* <p>
|
|
6105
|
+
* <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.</p>
|
|
6108
6106
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a>
|
|
6109
6107
|
* in the <i>Amazon RDS User Guide.</i>
|
|
6110
6108
|
* </p>
|
|
@@ -6133,8 +6131,8 @@ export interface CreateDBInstanceMessage {
|
|
|
6133
6131
|
*/
|
|
6134
6132
|
MasterUserSecretKmsKeyId?: string;
|
|
6135
6133
|
/**
|
|
6136
|
-
* <p>
|
|
6137
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
6134
|
+
* <p>The CA certificate identifier to use for the DB instance's server certificate.</p>
|
|
6135
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
6138
6136
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html">Using SSL/TLS to encrypt a connection to a DB
|
|
6139
6137
|
* instance</a> in the <i>Amazon RDS User Guide</i> and
|
|
6140
6138
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html">
|
|
@@ -6582,19 +6580,19 @@ export interface DBInstanceStatusInfo {
|
|
|
6582
6580
|
*/
|
|
6583
6581
|
export interface DBInstance {
|
|
6584
6582
|
/**
|
|
6585
|
-
* <p>
|
|
6583
|
+
* <p>The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.</p>
|
|
6586
6584
|
*/
|
|
6587
6585
|
DBInstanceIdentifier?: string;
|
|
6588
6586
|
/**
|
|
6589
|
-
* <p>
|
|
6587
|
+
* <p>The name of the compute and memory capacity class of the DB instance.</p>
|
|
6590
6588
|
*/
|
|
6591
6589
|
DBInstanceClass?: string;
|
|
6592
6590
|
/**
|
|
6593
|
-
* <p>The
|
|
6591
|
+
* <p>The database engine used for this DB instance.</p>
|
|
6594
6592
|
*/
|
|
6595
6593
|
Engine?: string;
|
|
6596
6594
|
/**
|
|
6597
|
-
* <p>
|
|
6595
|
+
* <p>The current state of this database.</p>
|
|
6598
6596
|
* <p>For information about DB instance statuses, see
|
|
6599
6597
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status">Viewing DB instance status</a>
|
|
6600
6598
|
* in the <i>Amazon RDS User Guide.</i>
|
|
@@ -6606,45 +6604,44 @@ export interface DBInstance {
|
|
|
6606
6604
|
*/
|
|
6607
6605
|
AutomaticRestartTime?: Date;
|
|
6608
6606
|
/**
|
|
6609
|
-
* <p>
|
|
6607
|
+
* <p>The master username for the DB instance.</p>
|
|
6610
6608
|
*/
|
|
6611
6609
|
MasterUsername?: string;
|
|
6612
6610
|
/**
|
|
6613
|
-
* <p>The meaning of this parameter differs
|
|
6614
|
-
* <
|
|
6615
|
-
* <
|
|
6616
|
-
*
|
|
6617
|
-
*
|
|
6618
|
-
*
|
|
6619
|
-
*
|
|
6620
|
-
*
|
|
6621
|
-
* </
|
|
6622
|
-
* <p>Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.</p>
|
|
6611
|
+
* <p>The meaning of this parameter differs depending on the database engine.</p>
|
|
6612
|
+
* <ul>
|
|
6613
|
+
* <li>
|
|
6614
|
+
* <p>For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.</p>
|
|
6615
|
+
* </li>
|
|
6616
|
+
* <li>
|
|
6617
|
+
* <p>For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.</p>
|
|
6618
|
+
* </li>
|
|
6619
|
+
* </ul>
|
|
6623
6620
|
*/
|
|
6624
6621
|
DBName?: string;
|
|
6625
6622
|
/**
|
|
6626
|
-
* <p>
|
|
6623
|
+
* <p>The connection endpoint for the DB instance.</p>
|
|
6627
6624
|
* <note>
|
|
6628
|
-
* <p>The endpoint might not be shown for instances
|
|
6625
|
+
* <p>The endpoint might not be shown for instances with the status of <code>creating</code>.</p>
|
|
6629
6626
|
* </note>
|
|
6630
6627
|
*/
|
|
6631
6628
|
Endpoint?: Endpoint;
|
|
6632
6629
|
/**
|
|
6633
|
-
* <p>
|
|
6630
|
+
* <p>The amount of storage in gibibytes (GiB) allocated for the DB instance.</p>
|
|
6634
6631
|
*/
|
|
6635
6632
|
AllocatedStorage?: number;
|
|
6636
6633
|
/**
|
|
6637
|
-
* <p>
|
|
6634
|
+
* <p>The date and time when the DB instance was created.</p>
|
|
6638
6635
|
*/
|
|
6639
6636
|
InstanceCreateTime?: Date;
|
|
6640
6637
|
/**
|
|
6641
|
-
* <p>
|
|
6638
|
+
* <p>The daily time range during which automated backups are
|
|
6642
6639
|
* created if automated backups are enabled, as determined
|
|
6643
6640
|
* by the <code>BackupRetentionPeriod</code>.</p>
|
|
6644
6641
|
*/
|
|
6645
6642
|
PreferredBackupWindow?: string;
|
|
6646
6643
|
/**
|
|
6647
|
-
* <p>
|
|
6644
|
+
* <p>The number of days for which automatic DB snapshots are retained.</p>
|
|
6648
6645
|
*/
|
|
6649
6646
|
BackupRetentionPeriod?: number;
|
|
6650
6647
|
/**
|
|
@@ -6653,57 +6650,57 @@ export interface DBInstance {
|
|
|
6653
6650
|
*/
|
|
6654
6651
|
DBSecurityGroups?: DBSecurityGroupMembership[];
|
|
6655
6652
|
/**
|
|
6656
|
-
* <p>
|
|
6653
|
+
* <p>The list of Amazon EC2 VPC security groups that the DB instance belongs to.</p>
|
|
6657
6654
|
*/
|
|
6658
6655
|
VpcSecurityGroups?: VpcSecurityGroupMembership[];
|
|
6659
6656
|
/**
|
|
6660
|
-
* <p>
|
|
6657
|
+
* <p>The list of DB parameter groups applied to this DB instance.</p>
|
|
6661
6658
|
*/
|
|
6662
6659
|
DBParameterGroups?: DBParameterGroupStatus[];
|
|
6663
6660
|
/**
|
|
6664
|
-
* <p>
|
|
6661
|
+
* <p>The name of the Availability Zone where the DB instance is located.</p>
|
|
6665
6662
|
*/
|
|
6666
6663
|
AvailabilityZone?: string;
|
|
6667
6664
|
/**
|
|
6668
|
-
* <p>
|
|
6665
|
+
* <p>Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.</p>
|
|
6669
6666
|
*/
|
|
6670
6667
|
DBSubnetGroup?: DBSubnetGroup;
|
|
6671
6668
|
/**
|
|
6672
|
-
* <p>
|
|
6669
|
+
* <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
|
|
6673
6670
|
*/
|
|
6674
6671
|
PreferredMaintenanceWindow?: string;
|
|
6675
6672
|
/**
|
|
6676
|
-
* <p>
|
|
6673
|
+
* <p>Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.</p>
|
|
6677
6674
|
*/
|
|
6678
6675
|
PendingModifiedValues?: PendingModifiedValues;
|
|
6679
6676
|
/**
|
|
6680
|
-
* <p>
|
|
6677
|
+
* <p>The latest time to which a database in this DB instance can be restored with point-in-time restore.</p>
|
|
6681
6678
|
*/
|
|
6682
6679
|
LatestRestorableTime?: Date;
|
|
6683
6680
|
/**
|
|
6684
|
-
* <p>
|
|
6681
|
+
* <p>Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.</p>
|
|
6685
6682
|
*/
|
|
6686
6683
|
MultiAZ?: boolean;
|
|
6687
6684
|
/**
|
|
6688
|
-
* <p>
|
|
6685
|
+
* <p>The version of the database engine.</p>
|
|
6689
6686
|
*/
|
|
6690
6687
|
EngineVersion?: string;
|
|
6691
6688
|
/**
|
|
6692
|
-
* <p>
|
|
6689
|
+
* <p>Indicates whether minor version patches are applied automatically.</p>
|
|
6693
6690
|
*/
|
|
6694
6691
|
AutoMinorVersionUpgrade?: boolean;
|
|
6695
6692
|
/**
|
|
6696
|
-
* <p>
|
|
6693
|
+
* <p>The identifier of the source DB instance if this DB instance is a read
|
|
6697
6694
|
* replica.</p>
|
|
6698
6695
|
*/
|
|
6699
6696
|
ReadReplicaSourceDBInstanceIdentifier?: string;
|
|
6700
6697
|
/**
|
|
6701
|
-
* <p>
|
|
6698
|
+
* <p>The identifiers of the read replicas associated with this DB
|
|
6702
6699
|
* instance.</p>
|
|
6703
6700
|
*/
|
|
6704
6701
|
ReadReplicaDBInstanceIdentifiers?: string[];
|
|
6705
6702
|
/**
|
|
6706
|
-
* <p>
|
|
6703
|
+
* <p>The identifiers of Aurora DB clusters to which the RDS DB instance
|
|
6707
6704
|
* is replicated as a read replica. For example, when you create an Aurora read replica of
|
|
6708
6705
|
* an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is
|
|
6709
6706
|
* shown. This output doesn't contain information about cross-Region Aurora read
|
|
@@ -6723,15 +6720,15 @@ export interface DBInstance {
|
|
|
6723
6720
|
*/
|
|
6724
6721
|
ReplicaMode?: ReplicaMode | string;
|
|
6725
6722
|
/**
|
|
6726
|
-
* <p>
|
|
6723
|
+
* <p>The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.</p>
|
|
6727
6724
|
*/
|
|
6728
6725
|
LicenseModel?: string;
|
|
6729
6726
|
/**
|
|
6730
|
-
* <p>
|
|
6727
|
+
* <p>The Provisioned IOPS (I/O operations per second) value for the DB instance.</p>
|
|
6731
6728
|
*/
|
|
6732
6729
|
Iops?: number;
|
|
6733
6730
|
/**
|
|
6734
|
-
* <p>
|
|
6731
|
+
* <p>The list of option group memberships for this DB instance.</p>
|
|
6735
6732
|
*/
|
|
6736
6733
|
OptionGroupMemberships?: OptionGroupMembership[];
|
|
6737
6734
|
/**
|
|
@@ -6748,7 +6745,7 @@ export interface DBInstance {
|
|
|
6748
6745
|
*/
|
|
6749
6746
|
SecondaryAvailabilityZone?: string;
|
|
6750
6747
|
/**
|
|
6751
|
-
* <p>
|
|
6748
|
+
* <p>Indicates whether the DB instance is publicly accessible.</p>
|
|
6752
6749
|
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
6753
6750
|
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
6754
6751
|
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
@@ -6760,12 +6757,12 @@ export interface DBInstance {
|
|
|
6760
6757
|
*/
|
|
6761
6758
|
PubliclyAccessible?: boolean;
|
|
6762
6759
|
/**
|
|
6763
|
-
* <p>The status of a read replica. If the instance isn't a read replica,
|
|
6760
|
+
* <p>The status of a read replica. If the DB instance isn't a read replica, the value is
|
|
6764
6761
|
* blank.</p>
|
|
6765
6762
|
*/
|
|
6766
6763
|
StatusInfos?: DBInstanceStatusInfo[];
|
|
6767
6764
|
/**
|
|
6768
|
-
* <p>
|
|
6765
|
+
* <p>The storage type associated with the DB instance.</p>
|
|
6769
6766
|
*/
|
|
6770
6767
|
StorageType?: string;
|
|
6771
6768
|
/**
|
|
@@ -6773,19 +6770,19 @@ export interface DBInstance {
|
|
|
6773
6770
|
*/
|
|
6774
6771
|
TdeCredentialArn?: string;
|
|
6775
6772
|
/**
|
|
6776
|
-
* <p>
|
|
6773
|
+
* <p>The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.</p>
|
|
6777
6774
|
*/
|
|
6778
6775
|
DbInstancePort?: number;
|
|
6779
6776
|
/**
|
|
6780
|
-
* <p>If the DB instance is a member of a DB cluster,
|
|
6777
|
+
* <p>If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.</p>
|
|
6781
6778
|
*/
|
|
6782
6779
|
DBClusterIdentifier?: string;
|
|
6783
6780
|
/**
|
|
6784
|
-
* <p>
|
|
6781
|
+
* <p>Indicates whether the DB instance is encrypted.</p>
|
|
6785
6782
|
*/
|
|
6786
6783
|
StorageEncrypted?: boolean;
|
|
6787
6784
|
/**
|
|
6788
|
-
* <p>If <code>StorageEncrypted</code> is
|
|
6785
|
+
* <p>If <code>StorageEncrypted</code> is enabled, the Amazon Web Services KMS key identifier
|
|
6789
6786
|
* for the encrypted DB instance.</p>
|
|
6790
6787
|
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
6791
6788
|
*/
|
|
@@ -6809,11 +6806,8 @@ export interface DBInstance {
|
|
|
6809
6806
|
*/
|
|
6810
6807
|
DomainMemberships?: DomainMembership[];
|
|
6811
6808
|
/**
|
|
6812
|
-
* <p>
|
|
6813
|
-
* <p>
|
|
6814
|
-
* <b>Amazon Aurora</b>
|
|
6815
|
-
* </p>
|
|
6816
|
-
* <p>Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this
|
|
6809
|
+
* <p>Indicates whether tags are copied from the DB instance to snapshots of the DB instance.</p>
|
|
6810
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this
|
|
6817
6811
|
* value for an Aurora DB instance has no effect on the DB cluster setting. For more
|
|
6818
6812
|
* information, see <code>DBCluster</code>.</p>
|
|
6819
6813
|
*/
|
|
@@ -6831,9 +6825,9 @@ export interface DBInstance {
|
|
|
6831
6825
|
*/
|
|
6832
6826
|
MonitoringRoleArn?: string;
|
|
6833
6827
|
/**
|
|
6834
|
-
* <p>
|
|
6835
|
-
*
|
|
6836
|
-
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
|
6828
|
+
* <p>The order of priority in which an Aurora Replica is promoted to the primary instance
|
|
6829
|
+
* after a failure of the existing primary instance. For more information,
|
|
6830
|
+
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance">
|
|
6837
6831
|
* Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
6838
6832
|
*/
|
|
6839
6833
|
PromotionTier?: number;
|
|
@@ -6850,7 +6844,7 @@ export interface DBInstance {
|
|
|
6850
6844
|
*/
|
|
6851
6845
|
Timezone?: string;
|
|
6852
6846
|
/**
|
|
6853
|
-
* <p>
|
|
6847
|
+
* <p>Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.</p>
|
|
6854
6848
|
* <p>For a list of engine versions that support IAM database authentication, see
|
|
6855
6849
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.html">IAM database authentication</a>
|
|
6856
6850
|
* in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.IAMdbauth.html">IAM
|
|
@@ -6858,7 +6852,7 @@ export interface DBInstance {
|
|
|
6858
6852
|
*/
|
|
6859
6853
|
IAMDatabaseAuthenticationEnabled?: boolean;
|
|
6860
6854
|
/**
|
|
6861
|
-
* <p>
|
|
6855
|
+
* <p>Indicates whether Performance Insights is enabled for the DB instance.</p>
|
|
6862
6856
|
*/
|
|
6863
6857
|
PerformanceInsightsEnabled?: boolean;
|
|
6864
6858
|
/**
|
|
@@ -6867,40 +6861,32 @@ export interface DBInstance {
|
|
|
6867
6861
|
*/
|
|
6868
6862
|
PerformanceInsightsKMSKeyId?: string;
|
|
6869
6863
|
/**
|
|
6870
|
-
* <p>The number of days to retain Performance Insights data
|
|
6864
|
+
* <p>The number of days to retain Performance Insights data.</p>
|
|
6865
|
+
* <p>Valid Values:</p>
|
|
6871
6866
|
* <ul>
|
|
6872
6867
|
* <li>
|
|
6873
|
-
* <p>7</p>
|
|
6874
|
-
* </li>
|
|
6875
|
-
* <li>
|
|
6876
6868
|
* <p>
|
|
6877
|
-
* <
|
|
6878
|
-
*
|
|
6879
|
-
* <li>
|
|
6880
|
-
* <p>731</p>
|
|
6881
|
-
* </li>
|
|
6882
|
-
* </ul>
|
|
6883
|
-
* <p>For example, the following values are valid:</p>
|
|
6884
|
-
* <ul>
|
|
6885
|
-
* <li>
|
|
6886
|
-
* <p>93 (3 months * 31)</p>
|
|
6887
|
-
* </li>
|
|
6888
|
-
* <li>
|
|
6889
|
-
* <p>341 (11 months * 31)</p>
|
|
6869
|
+
* <code>7</code>
|
|
6870
|
+
* </p>
|
|
6890
6871
|
* </li>
|
|
6891
6872
|
* <li>
|
|
6892
|
-
* <p>
|
|
6873
|
+
* <p>
|
|
6874
|
+
* <i>month</i> * 31, where <i>month</i> is a number of months from 1-23.
|
|
6875
|
+
* Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31)</p>
|
|
6893
6876
|
* </li>
|
|
6894
6877
|
* <li>
|
|
6895
|
-
* <p>
|
|
6878
|
+
* <p>
|
|
6879
|
+
* <code>731</code>
|
|
6880
|
+
* </p>
|
|
6896
6881
|
* </li>
|
|
6897
6882
|
* </ul>
|
|
6883
|
+
* <p>Default: <code>7</code> days</p>
|
|
6898
6884
|
*/
|
|
6899
6885
|
PerformanceInsightsRetentionPeriod?: number;
|
|
6900
6886
|
/**
|
|
6901
6887
|
* <p>A list of log types that this DB instance is configured to export to CloudWatch Logs.</p>
|
|
6902
6888
|
* <p>Log types vary by DB engine. For information about the log types for each DB engine, see
|
|
6903
|
-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html">Amazon RDS
|
|
6889
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html">Monitoring Amazon RDS log files</a> in the <i>Amazon RDS User Guide.</i>
|
|
6904
6890
|
* </p>
|
|
6905
6891
|
*/
|
|
6906
6892
|
EnabledCloudwatchLogsExports?: string[];
|
|
@@ -6909,7 +6895,7 @@ export interface DBInstance {
|
|
|
6909
6895
|
*/
|
|
6910
6896
|
ProcessorFeatures?: ProcessorFeature[];
|
|
6911
6897
|
/**
|
|
6912
|
-
* <p>Indicates
|
|
6898
|
+
* <p>Indicates whether the DB instance has deletion protection enabled.
|
|
6913
6899
|
* The database can't be deleted when deletion protection is enabled.
|
|
6914
6900
|
* For more information, see
|
|
6915
6901
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
@@ -6921,7 +6907,7 @@ export interface DBInstance {
|
|
|
6921
6907
|
*/
|
|
6922
6908
|
AssociatedRoles?: DBInstanceRole[];
|
|
6923
6909
|
/**
|
|
6924
|
-
* <p>
|
|
6910
|
+
* <p>The listener connection endpoint for SQL Server Always On.</p>
|
|
6925
6911
|
*/
|
|
6926
6912
|
ListenerEndpoint?: Endpoint;
|
|
6927
6913
|
/**
|
|
@@ -6939,7 +6925,7 @@ export interface DBInstance {
|
|
|
6939
6925
|
*/
|
|
6940
6926
|
DBInstanceAutomatedBackupsReplications?: DBInstanceAutomatedBackupsReplication[];
|
|
6941
6927
|
/**
|
|
6942
|
-
* <p>
|
|
6928
|
+
* <p>Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.</p>
|
|
6943
6929
|
* <p>A <i>CoIP </i>provides local or external connectivity to resources in
|
|
6944
6930
|
* your Outpost subnets through your on-premises network. For some use cases, a CoIP can
|
|
6945
6931
|
* provide lower latency for connections to the DB instance from outside of its virtual
|
|
@@ -7008,24 +6994,11 @@ export interface DBInstance {
|
|
|
7008
6994
|
*/
|
|
7009
6995
|
CustomIamInstanceProfile?: string;
|
|
7010
6996
|
/**
|
|
7011
|
-
* <p>
|
|
6997
|
+
* <p>The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.</p>
|
|
7012
6998
|
*/
|
|
7013
6999
|
BackupTarget?: string;
|
|
7014
7000
|
/**
|
|
7015
7001
|
* <p>The network type of the DB instance.</p>
|
|
7016
|
-
* <p>Valid values:</p>
|
|
7017
|
-
* <ul>
|
|
7018
|
-
* <li>
|
|
7019
|
-
* <p>
|
|
7020
|
-
* <code>IPV4</code>
|
|
7021
|
-
* </p>
|
|
7022
|
-
* </li>
|
|
7023
|
-
* <li>
|
|
7024
|
-
* <p>
|
|
7025
|
-
* <code>DUAL</code>
|
|
7026
|
-
* </p>
|
|
7027
|
-
* </li>
|
|
7028
|
-
* </ul>
|
|
7029
7002
|
* <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the DB instance.
|
|
7030
7003
|
* A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6
|
|
7031
7004
|
* protocols (<code>DUAL</code>).</p>
|
|
@@ -7036,6 +7009,8 @@ export interface DBInstance {
|
|
|
7036
7009
|
* Working with a DB instance in a VPC</a> in the
|
|
7037
7010
|
* <i>Amazon Aurora User Guide.</i>
|
|
7038
7011
|
* </p>
|
|
7012
|
+
* <p>Valid Values: <code>IPV4 | DUAL</code>
|
|
7013
|
+
* </p>
|
|
7039
7014
|
*/
|
|
7040
7015
|
NetworkType?: string;
|
|
7041
7016
|
/**
|
|
@@ -7043,17 +7018,17 @@ export interface DBInstance {
|
|
|
7043
7018
|
*/
|
|
7044
7019
|
ActivityStreamPolicyStatus?: ActivityStreamPolicyStatus | string;
|
|
7045
7020
|
/**
|
|
7046
|
-
* <p>
|
|
7021
|
+
* <p>The storage throughput for the DB instance.</p>
|
|
7047
7022
|
* <p>This setting applies only to the <code>gp3</code> storage type.</p>
|
|
7048
7023
|
*/
|
|
7049
7024
|
StorageThroughput?: number;
|
|
7050
7025
|
/**
|
|
7051
7026
|
* <p>The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also
|
|
7052
|
-
* the name of the CDB. This setting is valid for RDS Custom
|
|
7027
|
+
* the name of the CDB. This setting is only valid for RDS Custom DB instances.</p>
|
|
7053
7028
|
*/
|
|
7054
7029
|
DBSystemId?: string;
|
|
7055
7030
|
/**
|
|
7056
|
-
* <p>
|
|
7031
|
+
* <p>The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.</p>
|
|
7057
7032
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a>
|
|
7058
7033
|
* in the <i>Amazon RDS User Guide.</i>
|
|
7059
7034
|
* </p>
|
|
@@ -7064,7 +7039,7 @@ export interface DBInstance {
|
|
|
7064
7039
|
*/
|
|
7065
7040
|
CertificateDetails?: CertificateDetails;
|
|
7066
7041
|
/**
|
|
7067
|
-
* <p>
|
|
7042
|
+
* <p>The identifier of the source DB cluster if this DB instance is a read
|
|
7068
7043
|
* replica.</p>
|
|
7069
7044
|
*/
|
|
7070
7045
|
ReadReplicaSourceDBClusterIdentifier?: string;
|
|
@@ -10407,7 +10382,7 @@ export interface DescribeDBClusterParametersMessage {
|
|
|
10407
10382
|
*/
|
|
10408
10383
|
export interface DBClusterMessage {
|
|
10409
10384
|
/**
|
|
10410
|
-
* <p>A pagination token that can be used in a later DescribeDBClusters request.</p>
|
|
10385
|
+
* <p>A pagination token that can be used in a later <code>DescribeDBClusters</code> request.</p>
|
|
10411
10386
|
*/
|
|
10412
10387
|
Marker?: string;
|
|
10413
10388
|
/**
|
|
@@ -10422,18 +10397,18 @@ export interface DBClusterMessage {
|
|
|
10422
10397
|
export interface DescribeDBClustersMessage {
|
|
10423
10398
|
/**
|
|
10424
10399
|
* <p>The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified,
|
|
10425
|
-
* information
|
|
10400
|
+
* information for only the specific DB cluster is returned. This parameter isn't case-sensitive.</p>
|
|
10426
10401
|
* <p>Constraints:</p>
|
|
10427
10402
|
* <ul>
|
|
10428
10403
|
* <li>
|
|
10429
|
-
* <p>If supplied, must match an existing
|
|
10404
|
+
* <p>If supplied, must match an existing DB cluster identifier.</p>
|
|
10430
10405
|
* </li>
|
|
10431
10406
|
* </ul>
|
|
10432
10407
|
*/
|
|
10433
10408
|
DBClusterIdentifier?: string;
|
|
10434
10409
|
/**
|
|
10435
10410
|
* <p>A filter that specifies one or more DB clusters to describe.</p>
|
|
10436
|
-
* <p>Supported
|
|
10411
|
+
* <p>Supported Filters:</p>
|
|
10437
10412
|
* <ul>
|
|
10438
10413
|
* <li>
|
|
10439
10414
|
* <p>
|
|
@@ -10485,7 +10460,7 @@ export interface DescribeDBClustersMessage {
|
|
|
10485
10460
|
*/
|
|
10486
10461
|
Marker?: string;
|
|
10487
10462
|
/**
|
|
10488
|
-
* <p>
|
|
10463
|
+
* <p>Specifies whether the output includes information about clusters
|
|
10489
10464
|
* shared from other Amazon Web Services accounts.</p>
|
|
10490
10465
|
*/
|
|
10491
10466
|
IncludeShared?: boolean;
|
|
@@ -11043,14 +11018,14 @@ export interface DescribeDBInstancesMessage {
|
|
|
11043
11018
|
* <p>Constraints:</p>
|
|
11044
11019
|
* <ul>
|
|
11045
11020
|
* <li>
|
|
11046
|
-
* <p>If supplied, must match the identifier of an existing
|
|
11021
|
+
* <p>If supplied, must match the identifier of an existing DB instance.</p>
|
|
11047
11022
|
* </li>
|
|
11048
11023
|
* </ul>
|
|
11049
11024
|
*/
|
|
11050
11025
|
DBInstanceIdentifier?: string;
|
|
11051
11026
|
/**
|
|
11052
11027
|
* <p>A filter that specifies one or more DB instances to describe.</p>
|
|
11053
|
-
* <p>Supported
|
|
11028
|
+
* <p>Supported Filters:</p>
|
|
11054
11029
|
* <ul>
|
|
11055
11030
|
* <li>
|
|
11056
11031
|
* <p>
|
|
@@ -11066,8 +11041,8 @@ export interface DescribeDBInstancesMessage {
|
|
|
11066
11041
|
* </li>
|
|
11067
11042
|
* <li>
|
|
11068
11043
|
* <p>
|
|
11069
|
-
* <code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list
|
|
11070
|
-
* only
|
|
11044
|
+
* <code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list
|
|
11045
|
+
* only includes information about the DB instances identified by these DB instance resource identifiers.</p>
|
|
11071
11046
|
* </li>
|
|
11072
11047
|
* <li>
|
|
11073
11048
|
* <p>
|