@aws-sdk/client-rds 3.358.0 → 3.359.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 +3 -3
|
@@ -3218,32 +3218,36 @@ export interface CloudwatchLogsExportConfiguration {
|
|
|
3218
3218
|
export interface ModifyDBClusterMessage {
|
|
3219
3219
|
/**
|
|
3220
3220
|
* <p>The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.</p>
|
|
3221
|
-
* <p>
|
|
3222
|
-
*
|
|
3223
|
-
* <
|
|
3221
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3222
|
+
* <p>Constraints:</p>
|
|
3223
|
+
* <ul>
|
|
3224
|
+
* <li>
|
|
3225
|
+
* <p>Must match the identifier of an existing DB cluster.</p>
|
|
3226
|
+
* </li>
|
|
3227
|
+
* </ul>
|
|
3224
3228
|
*/
|
|
3225
3229
|
DBClusterIdentifier: string | undefined;
|
|
3226
3230
|
/**
|
|
3227
3231
|
* <p>The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.</p>
|
|
3232
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3228
3233
|
* <p>Constraints:</p>
|
|
3229
3234
|
* <ul>
|
|
3230
3235
|
* <li>
|
|
3231
|
-
* <p>Must contain from 1 to 63 letters, numbers, or hyphens
|
|
3236
|
+
* <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p>
|
|
3232
3237
|
* </li>
|
|
3233
3238
|
* <li>
|
|
3234
|
-
* <p>The first character must be a letter
|
|
3239
|
+
* <p>The first character must be a letter.</p>
|
|
3235
3240
|
* </li>
|
|
3236
3241
|
* <li>
|
|
3237
|
-
* <p>Can't end with a hyphen or contain two consecutive hyphens
|
|
3242
|
+
* <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
|
|
3238
3243
|
* </li>
|
|
3239
3244
|
* </ul>
|
|
3240
3245
|
* <p>Example: <code>my-cluster2</code>
|
|
3241
3246
|
* </p>
|
|
3242
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3243
3247
|
*/
|
|
3244
3248
|
NewDBClusterIdentifier?: string;
|
|
3245
3249
|
/**
|
|
3246
|
-
* <p>
|
|
3250
|
+
* <p>Specifies whether the modifications in this request and any pending modifications are
|
|
3247
3251
|
* asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting
|
|
3248
3252
|
* for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next
|
|
3249
3253
|
* maintenance window.</p>
|
|
@@ -3251,55 +3255,59 @@ export interface ModifyDBClusterMessage {
|
|
|
3251
3255
|
* modifications, such as turning on deletion protection and changing the master password, are applied
|
|
3252
3256
|
* immediately—regardless of when you choose to apply them.</p>
|
|
3253
3257
|
* <p>By default, this parameter is disabled.</p>
|
|
3254
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3258
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3255
3259
|
*/
|
|
3256
3260
|
ApplyImmediately?: boolean;
|
|
3257
3261
|
/**
|
|
3258
|
-
* <p>The number of days for which automated backups are retained. Specify a minimum value of 1
|
|
3259
|
-
* <p>
|
|
3262
|
+
* <p>The number of days for which automated backups are retained. Specify a minimum value of <code>1</code>.</p>
|
|
3263
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3264
|
+
* <p>Default: <code>1</code>
|
|
3265
|
+
* </p>
|
|
3260
3266
|
* <p>Constraints:</p>
|
|
3261
3267
|
* <ul>
|
|
3262
3268
|
* <li>
|
|
3263
|
-
* <p>Must be a value from 1 to 35
|
|
3269
|
+
* <p>Must be a value from 1 to 35.</p>
|
|
3264
3270
|
* </li>
|
|
3265
3271
|
* </ul>
|
|
3266
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3267
3272
|
*/
|
|
3268
3273
|
BackupRetentionPeriod?: number;
|
|
3269
3274
|
/**
|
|
3270
3275
|
* <p>The name of the DB cluster parameter group to use for the DB cluster.</p>
|
|
3271
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3276
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3272
3277
|
*/
|
|
3273
3278
|
DBClusterParameterGroupName?: string;
|
|
3274
3279
|
/**
|
|
3275
|
-
* <p>A list of VPC security groups
|
|
3276
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3280
|
+
* <p>A list of EC2 VPC security groups to associate with this DB cluster.</p>
|
|
3281
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3277
3282
|
*/
|
|
3278
3283
|
VpcSecurityGroupIds?: string[];
|
|
3279
3284
|
/**
|
|
3280
3285
|
* <p>The port number on which the DB cluster accepts connections.</p>
|
|
3281
|
-
* <p>
|
|
3286
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3287
|
+
* <p>Valid Values: <code>1150-65535</code>
|
|
3282
3288
|
* </p>
|
|
3283
3289
|
* <p>Default: The same port as the original DB cluster.</p>
|
|
3284
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3285
3290
|
*/
|
|
3286
3291
|
Port?: number;
|
|
3287
3292
|
/**
|
|
3288
|
-
* <p>The new password for the master database user
|
|
3293
|
+
* <p>The new password for the master database user.</p>
|
|
3294
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3289
3295
|
* <p>Constraints:</p>
|
|
3290
3296
|
* <ul>
|
|
3291
3297
|
* <li>
|
|
3292
3298
|
* <p>Must contain from 8 to 41 characters.</p>
|
|
3293
3299
|
* </li>
|
|
3294
3300
|
* <li>
|
|
3301
|
+
* <p>Can contain any printable ASCII character except "/", """, or "@".</p>
|
|
3302
|
+
* </li>
|
|
3303
|
+
* <li>
|
|
3295
3304
|
* <p>Can't be specified if <code>ManageMasterUserPassword</code> is turned on.</p>
|
|
3296
3305
|
* </li>
|
|
3297
3306
|
* </ul>
|
|
3298
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3299
3307
|
*/
|
|
3300
3308
|
MasterUserPassword?: string;
|
|
3301
3309
|
/**
|
|
3302
|
-
* <p>
|
|
3310
|
+
* <p>The option group to associate the DB cluster with.</p>
|
|
3303
3311
|
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
3304
3312
|
*/
|
|
3305
3313
|
OptionGroupName?: string;
|
|
@@ -3312,6 +3320,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3312
3320
|
* To view the time blocks available, see
|
|
3313
3321
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow">
|
|
3314
3322
|
* Backup window</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3323
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3315
3324
|
* <p>Constraints:</p>
|
|
3316
3325
|
* <ul>
|
|
3317
3326
|
* <li>
|
|
@@ -3327,69 +3336,82 @@ export interface ModifyDBClusterMessage {
|
|
|
3327
3336
|
* <p>Must be at least 30 minutes.</p>
|
|
3328
3337
|
* </li>
|
|
3329
3338
|
* </ul>
|
|
3330
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3331
3339
|
*/
|
|
3332
3340
|
PreferredBackupWindow?: string;
|
|
3333
3341
|
/**
|
|
3334
3342
|
* <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
|
|
3335
|
-
* <p>
|
|
3336
|
-
* </p>
|
|
3343
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3337
3344
|
* <p>The default is a 30-minute window selected at random from an
|
|
3338
3345
|
* 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the
|
|
3339
3346
|
* week. To see the time blocks available, see
|
|
3340
3347
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora">
|
|
3341
3348
|
* Adjusting the Preferred DB Cluster Maintenance Window</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3342
|
-
* <p>
|
|
3343
|
-
* <
|
|
3344
|
-
*
|
|
3349
|
+
* <p>Constraints:</p>
|
|
3350
|
+
* <ul>
|
|
3351
|
+
* <li>
|
|
3352
|
+
* <p>Must be in the format <code>ddd:hh24:mi-ddd:hh24:mi</code>.</p>
|
|
3353
|
+
* </li>
|
|
3354
|
+
* <li>
|
|
3355
|
+
* <p>Days must be one of <code>Mon | Tue | Wed | Thu | Fri | Sat | Sun</code>.</p>
|
|
3356
|
+
* </li>
|
|
3357
|
+
* <li>
|
|
3358
|
+
* <p>Must be in Universal Coordinated Time (UTC).</p>
|
|
3359
|
+
* </li>
|
|
3360
|
+
* <li>
|
|
3361
|
+
* <p>Must be at least 30 minutes.</p>
|
|
3362
|
+
* </li>
|
|
3363
|
+
* </ul>
|
|
3345
3364
|
*/
|
|
3346
3365
|
PreferredMaintenanceWindow?: string;
|
|
3347
3366
|
/**
|
|
3348
|
-
* <p>
|
|
3367
|
+
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access
|
|
3349
3368
|
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
3350
3369
|
* enabled.</p>
|
|
3351
3370
|
* <p>For more information, see
|
|
3352
3371
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
3353
3372
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3354
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3373
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3355
3374
|
*/
|
|
3356
3375
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
3357
3376
|
/**
|
|
3358
3377
|
* <p>The target backtrack window, in seconds. To disable backtracking, set this value to
|
|
3359
|
-
* 0
|
|
3360
|
-
* <p>
|
|
3378
|
+
* <code>0</code>.</p>
|
|
3379
|
+
* <p>Valid for Cluster Type: Aurora MySQL DB clusters only</p>
|
|
3380
|
+
* <p>Default: <code>0</code>
|
|
3381
|
+
* </p>
|
|
3361
3382
|
* <p>Constraints:</p>
|
|
3362
3383
|
* <ul>
|
|
3363
3384
|
* <li>
|
|
3364
3385
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
3365
3386
|
* </li>
|
|
3366
3387
|
* </ul>
|
|
3367
|
-
* <p>Valid for: Aurora MySQL DB clusters only</p>
|
|
3368
3388
|
*/
|
|
3369
3389
|
BacktrackWindow?: number;
|
|
3370
3390
|
/**
|
|
3371
|
-
* <p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster
|
|
3372
|
-
*
|
|
3373
|
-
* <p>
|
|
3374
|
-
*
|
|
3375
|
-
*
|
|
3376
|
-
*
|
|
3377
|
-
*
|
|
3378
|
-
*
|
|
3379
|
-
*
|
|
3380
|
-
*
|
|
3381
|
-
*
|
|
3382
|
-
*
|
|
3383
|
-
*
|
|
3384
|
-
*
|
|
3385
|
-
*
|
|
3386
|
-
*
|
|
3387
|
-
*
|
|
3388
|
-
*
|
|
3391
|
+
* <p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.</p>
|
|
3392
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3393
|
+
* <p>The following values are valid for each DB engine:</p>
|
|
3394
|
+
* <ul>
|
|
3395
|
+
* <li>
|
|
3396
|
+
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
|
|
3397
|
+
* </p>
|
|
3398
|
+
* </li>
|
|
3399
|
+
* <li>
|
|
3400
|
+
* <p>Aurora PostgreSQL - <code>postgresql</code>
|
|
3401
|
+
* </p>
|
|
3402
|
+
* </li>
|
|
3403
|
+
* <li>
|
|
3404
|
+
* <p>RDS for MySQL - <code>error | general | slowquery</code>
|
|
3405
|
+
* </p>
|
|
3406
|
+
* </li>
|
|
3407
|
+
* <li>
|
|
3408
|
+
* <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
|
|
3409
|
+
* </p>
|
|
3410
|
+
* </li>
|
|
3411
|
+
* </ul>
|
|
3389
3412
|
* <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">
|
|
3390
3413
|
* Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3391
3414
|
* <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>
|
|
3392
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3393
3415
|
*/
|
|
3394
3416
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
|
3395
3417
|
/**
|
|
@@ -3416,15 +3438,20 @@ export interface ModifyDBClusterMessage {
|
|
|
3416
3438
|
* <p>
|
|
3417
3439
|
* <code>aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"</code>
|
|
3418
3440
|
* </p>
|
|
3419
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3441
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3420
3442
|
*/
|
|
3421
3443
|
EngineVersion?: string;
|
|
3422
3444
|
/**
|
|
3423
|
-
* <p>
|
|
3424
|
-
* <p>
|
|
3445
|
+
* <p>Specifies whether major version upgrades are allowed.</p>
|
|
3446
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3447
|
+
* <p>Constraints:</p>
|
|
3448
|
+
* <ul>
|
|
3449
|
+
* <li>
|
|
3450
|
+
* <p>You must allow major version upgrades when specifying a value for the
|
|
3425
3451
|
* <code>EngineVersion</code> parameter that is a different major version than the DB
|
|
3426
3452
|
* cluster's current version.</p>
|
|
3427
|
-
*
|
|
3453
|
+
* </li>
|
|
3454
|
+
* </ul>
|
|
3428
3455
|
*/
|
|
3429
3456
|
AllowMajorVersionUpgrade?: boolean;
|
|
3430
3457
|
/**
|
|
@@ -3434,6 +3461,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3434
3461
|
* cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than
|
|
3435
3462
|
* during the next maintenance window.</p>
|
|
3436
3463
|
* </note>
|
|
3464
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3437
3465
|
* <p>Default: The existing name setting</p>
|
|
3438
3466
|
* <p>Constraints:</p>
|
|
3439
3467
|
* <ul>
|
|
@@ -3445,7 +3473,6 @@ export interface ModifyDBClusterMessage {
|
|
|
3445
3473
|
* <code>AllowMajorVersionUpgrade</code> parameter for a major version upgrade only.</p>
|
|
3446
3474
|
* </li>
|
|
3447
3475
|
* </ul>
|
|
3448
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3449
3476
|
*/
|
|
3450
3477
|
DBInstanceParameterGroupName?: string;
|
|
3451
3478
|
/**
|
|
@@ -3454,73 +3481,95 @@ export interface ModifyDBClusterMessage {
|
|
|
3454
3481
|
* The domain must be created prior to this operation.</p>
|
|
3455
3482
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html">Kerberos Authentication</a>
|
|
3456
3483
|
* in the <i>Amazon Aurora User Guide</i>.</p>
|
|
3457
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3484
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3458
3485
|
*/
|
|
3459
3486
|
Domain?: string;
|
|
3460
3487
|
/**
|
|
3461
|
-
* <p>
|
|
3462
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3488
|
+
* <p>The name of the IAM role to use when making API calls to the Directory Service.</p>
|
|
3489
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3463
3490
|
*/
|
|
3464
3491
|
DomainIAMRoleName?: string;
|
|
3465
3492
|
/**
|
|
3466
3493
|
* <p>The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in <code>serverless</code> DB engine mode.</p>
|
|
3467
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3494
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3468
3495
|
*/
|
|
3469
3496
|
ScalingConfiguration?: ScalingConfiguration;
|
|
3470
3497
|
/**
|
|
3471
|
-
* <p>
|
|
3498
|
+
* <p>Specifies whether the DB cluster has deletion protection enabled.
|
|
3472
3499
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
3473
3500
|
* deletion protection isn't enabled.</p>
|
|
3474
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3501
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3475
3502
|
*/
|
|
3476
3503
|
DeletionProtection?: boolean;
|
|
3477
3504
|
/**
|
|
3478
|
-
* <p>
|
|
3505
|
+
* <p>Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint
|
|
3479
3506
|
* is disabled.</p>
|
|
3480
3507
|
* <p>When enabled, the HTTP endpoint provides a connectionless web service API for running
|
|
3481
3508
|
* SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database
|
|
3482
3509
|
* from inside the RDS console with the query editor.</p>
|
|
3483
3510
|
* <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
|
|
3484
3511
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
3485
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3512
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3486
3513
|
*/
|
|
3487
3514
|
EnableHttpEndpoint?: boolean;
|
|
3488
3515
|
/**
|
|
3489
|
-
* <p>
|
|
3516
|
+
* <p>Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
|
3490
3517
|
* The default is not to copy them.</p>
|
|
3491
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3518
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3492
3519
|
*/
|
|
3493
3520
|
CopyTagsToSnapshot?: boolean;
|
|
3494
3521
|
/**
|
|
3495
|
-
* <p>
|
|
3496
|
-
* Aurora global database
|
|
3522
|
+
* <p>Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster
|
|
3523
|
+
* (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that
|
|
3497
3524
|
* are secondary clusters in an Aurora global database.</p>
|
|
3498
3525
|
* <p>You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter
|
|
3499
|
-
* enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to
|
|
3500
|
-
* this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the
|
|
3501
|
-
*
|
|
3502
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3526
|
+
* enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to
|
|
3527
|
+
* this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the
|
|
3528
|
+
* primary is demoted by a global cluster API operation, but it does nothing until then.</p>
|
|
3529
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3503
3530
|
*/
|
|
3504
3531
|
EnableGlobalWriteForwarding?: boolean;
|
|
3505
3532
|
/**
|
|
3506
|
-
* <p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge
|
|
3533
|
+
* <p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example <code>db.m6gd.xlarge</code>.
|
|
3507
3534
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p>
|
|
3508
3535
|
* <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">
|
|
3509
3536
|
* DB Instance Class</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3510
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3537
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3511
3538
|
*/
|
|
3512
3539
|
DBClusterInstanceClass?: string;
|
|
3513
3540
|
/**
|
|
3514
3541
|
* <p>The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.</p>
|
|
3515
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3542
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3516
3543
|
*/
|
|
3517
3544
|
AllocatedStorage?: number;
|
|
3518
3545
|
/**
|
|
3519
|
-
* <p>
|
|
3546
|
+
* <p>The storage type to associate with the DB cluster.</p>
|
|
3547
|
+
* <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
|
|
3548
|
+
* 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>
|
|
3520
3549
|
* <p>When specified for a Multi-AZ DB cluster, a value for the <code>Iops</code> parameter is required.</p>
|
|
3521
|
-
* <p>Valid
|
|
3522
|
-
* <p>
|
|
3523
|
-
* <
|
|
3550
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3551
|
+
* <p>Valid Values:</p>
|
|
3552
|
+
* <ul>
|
|
3553
|
+
* <li>
|
|
3554
|
+
* <p>Aurora DB clusters - <code>aurora | aurora-iopt1</code>
|
|
3555
|
+
* </p>
|
|
3556
|
+
* </li>
|
|
3557
|
+
* <li>
|
|
3558
|
+
* <p>Multi-AZ DB clusters - <code>io1</code>
|
|
3559
|
+
* </p>
|
|
3560
|
+
* </li>
|
|
3561
|
+
* </ul>
|
|
3562
|
+
* <p>Default:</p>
|
|
3563
|
+
* <ul>
|
|
3564
|
+
* <li>
|
|
3565
|
+
* <p>Aurora DB clusters - <code>aurora</code>
|
|
3566
|
+
* </p>
|
|
3567
|
+
* </li>
|
|
3568
|
+
* <li>
|
|
3569
|
+
* <p>Multi-AZ DB clusters - <code>io1</code>
|
|
3570
|
+
* </p>
|
|
3571
|
+
* </li>
|
|
3572
|
+
* </ul>
|
|
3524
3573
|
*/
|
|
3525
3574
|
StorageType?: string;
|
|
3526
3575
|
/**
|
|
@@ -3529,24 +3578,31 @@ export interface ModifyDBClusterMessage {
|
|
|
3529
3578
|
* <p>For information about valid IOPS values, see
|
|
3530
3579
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS">Amazon RDS Provisioned IOPS storage</a>
|
|
3531
3580
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
3532
|
-
* <p>
|
|
3533
|
-
* <p>
|
|
3581
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3582
|
+
* <p>Constraints:</p>
|
|
3583
|
+
* <ul>
|
|
3584
|
+
* <li>
|
|
3585
|
+
* <p>Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p>
|
|
3586
|
+
* </li>
|
|
3587
|
+
* </ul>
|
|
3534
3588
|
*/
|
|
3535
3589
|
Iops?: number;
|
|
3536
3590
|
/**
|
|
3537
|
-
* <p>
|
|
3591
|
+
* <p>Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
|
|
3538
3592
|
* By default, minor engine upgrades are applied automatically.</p>
|
|
3539
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3593
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3540
3594
|
*/
|
|
3541
3595
|
AutoMinorVersionUpgrade?: boolean;
|
|
3542
3596
|
/**
|
|
3543
3597
|
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
|
3544
|
-
* To turn off collecting Enhanced Monitoring metrics, specify 0
|
|
3598
|
+
* To turn off collecting Enhanced Monitoring metrics, specify <code>0</code>.</p>
|
|
3545
3599
|
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code>
|
|
3546
|
-
* to a value other than 0
|
|
3547
|
-
* <p>Valid
|
|
3600
|
+
* to a value other than <code>0</code>.</p>
|
|
3601
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3602
|
+
* <p>Valid Values: <code>0 | 1 | 5 | 10 | 15 | 30 | 60</code>
|
|
3603
|
+
* </p>
|
|
3604
|
+
* <p>Default: <code>0</code>
|
|
3548
3605
|
* </p>
|
|
3549
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3550
3606
|
*/
|
|
3551
3607
|
MonitoringInterval?: number;
|
|
3552
3608
|
/**
|
|
@@ -3555,15 +3611,15 @@ export interface ModifyDBClusterMessage {
|
|
|
3555
3611
|
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To
|
|
3556
3612
|
* create an IAM role for Amazon RDS Enhanced Monitoring</a> in the <i>Amazon RDS User Guide.</i>
|
|
3557
3613
|
* </p>
|
|
3558
|
-
* <p>If <code>MonitoringInterval</code> is set to a value other than 0
|
|
3559
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3614
|
+
* <p>If <code>MonitoringInterval</code> is set to a value other than <code>0</code>, supply a <code>MonitoringRoleArn</code> value.</p>
|
|
3615
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3560
3616
|
*/
|
|
3561
3617
|
MonitoringRoleArn?: string;
|
|
3562
3618
|
/**
|
|
3563
|
-
* <p>
|
|
3619
|
+
* <p>Specifies whether to turn on Performance Insights for the DB cluster.</p>
|
|
3564
3620
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
|
|
3565
3621
|
* Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
3566
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3622
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3567
3623
|
*/
|
|
3568
3624
|
EnablePerformanceInsights?: boolean;
|
|
3569
3625
|
/**
|
|
@@ -3572,40 +3628,32 @@ export interface ModifyDBClusterMessage {
|
|
|
3572
3628
|
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
3573
3629
|
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
3574
3630
|
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
3575
|
-
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3631
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3576
3632
|
*/
|
|
3577
3633
|
PerformanceInsightsKMSKeyId?: string;
|
|
3578
3634
|
/**
|
|
3579
|
-
* <p>The number of days to retain Performance Insights data
|
|
3635
|
+
* <p>The number of days to retain Performance Insights data.</p>
|
|
3636
|
+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
|
|
3637
|
+
* <p>Valid Values:</p>
|
|
3580
3638
|
* <ul>
|
|
3581
3639
|
* <li>
|
|
3582
|
-
* <p>7</p>
|
|
3583
|
-
* </li>
|
|
3584
|
-
* <li>
|
|
3585
3640
|
* <p>
|
|
3586
|
-
* <
|
|
3587
|
-
*
|
|
3588
|
-
* <li>
|
|
3589
|
-
* <p>731</p>
|
|
3590
|
-
* </li>
|
|
3591
|
-
* </ul>
|
|
3592
|
-
* <p>For example, the following values are valid:</p>
|
|
3593
|
-
* <ul>
|
|
3594
|
-
* <li>
|
|
3595
|
-
* <p>93 (3 months * 31)</p>
|
|
3596
|
-
* </li>
|
|
3597
|
-
* <li>
|
|
3598
|
-
* <p>341 (11 months * 31)</p>
|
|
3641
|
+
* <code>7</code>
|
|
3642
|
+
* </p>
|
|
3599
3643
|
* </li>
|
|
3600
3644
|
* <li>
|
|
3601
|
-
* <p>
|
|
3645
|
+
* <p>
|
|
3646
|
+
* <i>month</i> * 31, where <i>month</i> is a number of months from 1-23.
|
|
3647
|
+
* Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31)</p>
|
|
3602
3648
|
* </li>
|
|
3603
3649
|
* <li>
|
|
3604
|
-
* <p>
|
|
3650
|
+
* <p>
|
|
3651
|
+
* <code>731</code>
|
|
3652
|
+
* </p>
|
|
3605
3653
|
* </li>
|
|
3606
3654
|
* </ul>
|
|
3607
|
-
* <p>
|
|
3608
|
-
* <p>
|
|
3655
|
+
* <p>Default: <code>7</code> days</p>
|
|
3656
|
+
* <p>If you specify a retention period that isn't valid, such as <code>94</code>, Amazon RDS issues an error.</p>
|
|
3609
3657
|
*/
|
|
3610
3658
|
PerformanceInsightsRetentionPeriod?: number;
|
|
3611
3659
|
/**
|
|
@@ -3616,19 +3664,6 @@ export interface ModifyDBClusterMessage {
|
|
|
3616
3664
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
|
3617
3665
|
/**
|
|
3618
3666
|
* <p>The network type of the DB cluster.</p>
|
|
3619
|
-
* <p>Valid values:</p>
|
|
3620
|
-
* <ul>
|
|
3621
|
-
* <li>
|
|
3622
|
-
* <p>
|
|
3623
|
-
* <code>IPV4</code>
|
|
3624
|
-
* </p>
|
|
3625
|
-
* </li>
|
|
3626
|
-
* <li>
|
|
3627
|
-
* <p>
|
|
3628
|
-
* <code>DUAL</code>
|
|
3629
|
-
* </p>
|
|
3630
|
-
* </li>
|
|
3631
|
-
* </ul>
|
|
3632
3667
|
* <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the DB cluster.
|
|
3633
3668
|
* A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6
|
|
3634
3669
|
* protocols (<code>DUAL</code>).</p>
|
|
@@ -3636,11 +3671,13 @@ export interface ModifyDBClusterMessage {
|
|
|
3636
3671
|
* Working with a DB instance in a VPC</a> in the
|
|
3637
3672
|
* <i>Amazon Aurora User Guide.</i>
|
|
3638
3673
|
* </p>
|
|
3639
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3674
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3675
|
+
* <p>Valid Values: <code>IPV4 | DUAL</code>
|
|
3676
|
+
* </p>
|
|
3640
3677
|
*/
|
|
3641
3678
|
NetworkType?: string;
|
|
3642
3679
|
/**
|
|
3643
|
-
* <p>
|
|
3680
|
+
* <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.</p>
|
|
3644
3681
|
* <p>If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
|
|
3645
3682
|
* on this management. In this case, you can't specify <code>MasterUserPassword</code>.</p>
|
|
3646
3683
|
* <p>If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the
|
|
@@ -3651,11 +3688,11 @@ export interface ModifyDBClusterMessage {
|
|
|
3651
3688
|
* 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>
|
|
3652
3689
|
* in the <i>Amazon Aurora User Guide.</i>
|
|
3653
3690
|
* </p>
|
|
3654
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3691
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3655
3692
|
*/
|
|
3656
3693
|
ManageMasterUserPassword?: boolean;
|
|
3657
3694
|
/**
|
|
3658
|
-
* <p>
|
|
3695
|
+
* <p>Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the
|
|
3659
3696
|
* master user password.</p>
|
|
3660
3697
|
* <p>This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets
|
|
3661
3698
|
* Manager for the DB cluster. The secret value contains the updated password.</p>
|
|
@@ -3663,13 +3700,13 @@ export interface ModifyDBClusterMessage {
|
|
|
3663
3700
|
* 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>
|
|
3664
3701
|
* in the <i>Amazon Aurora User Guide.</i>
|
|
3665
3702
|
* </p>
|
|
3703
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3666
3704
|
* <p>Constraints:</p>
|
|
3667
3705
|
* <ul>
|
|
3668
3706
|
* <li>
|
|
3669
3707
|
* <p>You must apply the change immediately when rotating the master user password.</p>
|
|
3670
3708
|
* </li>
|
|
3671
3709
|
* </ul>
|
|
3672
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3673
3710
|
*/
|
|
3674
3711
|
RotateMasterUserPassword?: boolean;
|
|
3675
3712
|
/**
|
|
@@ -3696,7 +3733,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3696
3733
|
* To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p>
|
|
3697
3734
|
* <p>There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account
|
|
3698
3735
|
* has a different default KMS key for each Amazon Web Services Region.</p>
|
|
3699
|
-
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3736
|
+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3700
3737
|
*/
|
|
3701
3738
|
MasterUserSecretKmsKeyId?: string;
|
|
3702
3739
|
/**
|
|
@@ -3706,15 +3743,20 @@ export interface ModifyDBClusterMessage {
|
|
|
3706
3743
|
* </note>
|
|
3707
3744
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html">
|
|
3708
3745
|
* CreateDBCluster</a>.</p>
|
|
3709
|
-
* <p>Valid for: Aurora DB clusters only</p>
|
|
3746
|
+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
|
|
3710
3747
|
*/
|
|
3711
3748
|
EngineMode?: string;
|
|
3712
3749
|
/**
|
|
3713
|
-
* <p>
|
|
3750
|
+
* <p>Specifies whether engine mode changes from <code>serverless</code> to <code>provisioned</code>
|
|
3714
3751
|
* are allowed.</p>
|
|
3715
|
-
* <p>
|
|
3752
|
+
* <p>Valid for Cluster Type: Aurora Serverless v1 DB clusters only</p>
|
|
3753
|
+
* <p>Constraints:</p>
|
|
3754
|
+
* <ul>
|
|
3755
|
+
* <li>
|
|
3756
|
+
* <p>You must allow engine mode changes when specifying a different value for the <code>EngineMode</code> parameter
|
|
3716
3757
|
* from the DB cluster's current engine mode.</p>
|
|
3717
|
-
*
|
|
3758
|
+
* </li>
|
|
3759
|
+
* </ul>
|
|
3718
3760
|
*/
|
|
3719
3761
|
AllowEngineModeChange?: boolean;
|
|
3720
3762
|
}
|
|
@@ -3912,18 +3954,18 @@ export declare class DBUpgradeDependencyFailureFault extends __BaseException {
|
|
|
3912
3954
|
*/
|
|
3913
3955
|
export interface ModifyDBInstanceMessage {
|
|
3914
3956
|
/**
|
|
3915
|
-
* <p>The DB instance
|
|
3957
|
+
* <p>The identifier of DB instance to modify. This value is stored as a lowercase string.</p>
|
|
3916
3958
|
* <p>Constraints:</p>
|
|
3917
3959
|
* <ul>
|
|
3918
3960
|
* <li>
|
|
3919
|
-
* <p>Must match the identifier of an existing
|
|
3961
|
+
* <p>Must match the identifier of an existing DB instance.</p>
|
|
3920
3962
|
* </li>
|
|
3921
3963
|
* </ul>
|
|
3922
3964
|
*/
|
|
3923
3965
|
DBInstanceIdentifier: string | undefined;
|
|
3924
3966
|
/**
|
|
3925
3967
|
* <p>The new amount of storage in gibibytes (GiB) to allocate for the DB instance.</p>
|
|
3926
|
-
* <p>For MariaDB, MySQL, Oracle, and PostgreSQL,
|
|
3968
|
+
* <p>For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL,
|
|
3927
3969
|
* the value supplied must be at least 10% greater than the current value.
|
|
3928
3970
|
* Values that are not at least 10% greater than the existing value are rounded up
|
|
3929
3971
|
* so that they are 10% greater than the current value.</p>
|
|
@@ -3932,7 +3974,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3932
3974
|
*/
|
|
3933
3975
|
AllocatedStorage?: number;
|
|
3934
3976
|
/**
|
|
3935
|
-
* <p>The new compute and memory capacity of the DB instance, for example db.m4.large
|
|
3977
|
+
* <p>The new compute and memory capacity of the DB instance, for example <code>db.m4.large</code>. Not all DB instance classes are available in all
|
|
3936
3978
|
* Amazon Web Services Regions, or for all database engines. 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
|
|
3937
3979
|
* <i>Amazon RDS User Guide</i> or
|
|
3938
3980
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html">Aurora
|
|
@@ -3956,8 +3998,13 @@ export interface ModifyDBInstanceMessage {
|
|
|
3956
3998
|
* <p>Changing the subnet group causes an outage during the change.
|
|
3957
3999
|
* The change is applied during the next maintenance window,
|
|
3958
4000
|
* unless you enable <code>ApplyImmediately</code>.</p>
|
|
3959
|
-
* <p>This parameter doesn't apply to RDS Custom.</p>
|
|
3960
|
-
* <p>Constraints
|
|
4001
|
+
* <p>This parameter doesn't apply to RDS Custom DB instances.</p>
|
|
4002
|
+
* <p>Constraints:</p>
|
|
4003
|
+
* <ul>
|
|
4004
|
+
* <li>
|
|
4005
|
+
* <p>If supplied, must match existing DB subnet group.</p>
|
|
4006
|
+
* </li>
|
|
4007
|
+
* </ul>
|
|
3961
4008
|
* <p>Example: <code>mydbsubnetgroup</code>
|
|
3962
4009
|
* </p>
|
|
3963
4010
|
*/
|
|
@@ -3965,34 +4012,38 @@ export interface ModifyDBInstanceMessage {
|
|
|
3965
4012
|
/**
|
|
3966
4013
|
* <p>A list of DB security groups to authorize on this DB instance. Changing this setting doesn't
|
|
3967
4014
|
* result in an outage and the change is asynchronously applied as soon as possible.</p>
|
|
3968
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4015
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
3969
4016
|
* <p>Constraints:</p>
|
|
3970
4017
|
* <ul>
|
|
3971
4018
|
* <li>
|
|
3972
|
-
* <p>If supplied, must match existing
|
|
4019
|
+
* <p>If supplied, must match existing DB security groups.</p>
|
|
3973
4020
|
* </li>
|
|
3974
4021
|
* </ul>
|
|
3975
4022
|
*/
|
|
3976
4023
|
DBSecurityGroups?: string[];
|
|
3977
4024
|
/**
|
|
3978
|
-
* <p>A list of Amazon EC2 VPC security groups to
|
|
4025
|
+
* <p>A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is
|
|
3979
4026
|
* asynchronously applied as soon as possible.</p>
|
|
3980
|
-
* <p>This setting doesn't apply to
|
|
3981
|
-
* <
|
|
3982
|
-
* <
|
|
3983
|
-
*
|
|
3984
|
-
*
|
|
3985
|
-
*
|
|
4027
|
+
* <p>This setting doesn't apply to the following DB instances:</p>
|
|
4028
|
+
* <ul>
|
|
4029
|
+
* <li>
|
|
4030
|
+
* <p>Amazon Aurora (The associated list of EC2 VPC security groups is managed by
|
|
4031
|
+
* the DB cluster. For more information, see <code>ModifyDBCluster</code>.)</p>
|
|
4032
|
+
* </li>
|
|
4033
|
+
* <li>
|
|
4034
|
+
* <p>RDS Custom</p>
|
|
4035
|
+
* </li>
|
|
4036
|
+
* </ul>
|
|
3986
4037
|
* <p>Constraints:</p>
|
|
3987
4038
|
* <ul>
|
|
3988
4039
|
* <li>
|
|
3989
|
-
* <p>If supplied, must match existing
|
|
4040
|
+
* <p>If supplied, must match existing VPC security group IDs.</p>
|
|
3990
4041
|
* </li>
|
|
3991
4042
|
* </ul>
|
|
3992
4043
|
*/
|
|
3993
4044
|
VpcSecurityGroupIds?: string[];
|
|
3994
4045
|
/**
|
|
3995
|
-
* <p>
|
|
4046
|
+
* <p>Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible,
|
|
3996
4047
|
* regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. By default, this parameter is disabled.</p>
|
|
3997
4048
|
* <p>If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage
|
|
3998
4049
|
* and are applied on the next call to <a>RebootDBInstance</a>, or the next failure reboot. Review the table of parameters in
|
|
@@ -4002,45 +4053,54 @@ export interface ModifyDBInstanceMessage {
|
|
|
4002
4053
|
*/
|
|
4003
4054
|
ApplyImmediately?: boolean;
|
|
4004
4055
|
/**
|
|
4005
|
-
* <p>The new password for the master user
|
|
4006
|
-
* character except "/", """, or "@".</p>
|
|
4056
|
+
* <p>The new password for the master user.</p>
|
|
4007
4057
|
* <p>Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
|
|
4008
4058
|
* Between the time of the request and the completion of the request,
|
|
4009
4059
|
* the <code>MasterUserPassword</code> element exists in the
|
|
4010
4060
|
* <code>PendingModifiedValues</code> element of the operation response.</p>
|
|
4011
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4012
|
-
* <p>
|
|
4013
|
-
* <b>Amazon Aurora</b>
|
|
4014
|
-
* </p>
|
|
4015
|
-
* <p>Not applicable. The password for the master user is managed by the DB cluster. For
|
|
4016
|
-
* more information, see <code>ModifyDBCluster</code>.</p>
|
|
4017
|
-
* <p>Default: Uses existing setting</p>
|
|
4018
|
-
* <p>Constraints: Can't be specified if <code>ManageMasterUserPassword</code> is turned on.</p>
|
|
4019
|
-
* <p>
|
|
4020
|
-
* <b>MariaDB</b>
|
|
4021
|
-
* </p>
|
|
4022
|
-
* <p>Constraints: Must contain from 8 to 41 characters.</p>
|
|
4023
|
-
* <p>
|
|
4024
|
-
* <b>Microsoft SQL Server</b>
|
|
4025
|
-
* </p>
|
|
4026
|
-
* <p>Constraints: Must contain from 8 to 128 characters.</p>
|
|
4027
|
-
* <p>
|
|
4028
|
-
* <b>MySQL</b>
|
|
4029
|
-
* </p>
|
|
4030
|
-
* <p>Constraints: Must contain from 8 to 41 characters.</p>
|
|
4031
|
-
* <p>
|
|
4032
|
-
* <b>Oracle</b>
|
|
4033
|
-
* </p>
|
|
4034
|
-
* <p>Constraints: Must contain from 8 to 30 characters.</p>
|
|
4035
|
-
* <p>
|
|
4036
|
-
* <b>PostgreSQL</b>
|
|
4037
|
-
* </p>
|
|
4038
|
-
* <p>Constraints: Must contain from 8 to 128 characters.</p>
|
|
4039
4061
|
* <note>
|
|
4040
4062
|
* <p>Amazon RDS API operations never return the password,
|
|
4041
4063
|
* so this action provides a way to regain access to a primary instance user if the password is lost.
|
|
4042
4064
|
* This includes restoring privileges that might have been accidentally revoked.</p>
|
|
4043
4065
|
* </note>
|
|
4066
|
+
* <p>This setting doesn't apply to the following DB instances:</p>
|
|
4067
|
+
* <ul>
|
|
4068
|
+
* <li>
|
|
4069
|
+
* <p>Amazon Aurora (The password for the master user is managed by the DB cluster. For
|
|
4070
|
+
* more information, see <code>ModifyDBCluster</code>.)</p>
|
|
4071
|
+
* </li>
|
|
4072
|
+
* <li>
|
|
4073
|
+
* <p>RDS Custom</p>
|
|
4074
|
+
* </li>
|
|
4075
|
+
* </ul>
|
|
4076
|
+
* <p>Default: Uses existing setting</p>
|
|
4077
|
+
* <p>Constraints:</p>
|
|
4078
|
+
* <ul>
|
|
4079
|
+
* <li>
|
|
4080
|
+
* <p>Can't be specified if <code>ManageMasterUserPassword</code> is turned on.</p>
|
|
4081
|
+
* </li>
|
|
4082
|
+
* <li>
|
|
4083
|
+
* <p>Can include any printable ASCII character except "/", """, or "@".</p>
|
|
4084
|
+
* </li>
|
|
4085
|
+
* </ul>
|
|
4086
|
+
* <p>Length Constraints:</p>
|
|
4087
|
+
* <ul>
|
|
4088
|
+
* <li>
|
|
4089
|
+
* <p>RDS for MariaDB - Must contain from 8 to 41 characters.</p>
|
|
4090
|
+
* </li>
|
|
4091
|
+
* <li>
|
|
4092
|
+
* <p>RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.</p>
|
|
4093
|
+
* </li>
|
|
4094
|
+
* <li>
|
|
4095
|
+
* <p>RDS for MySQL - Must contain from 8 to 41 characters.</p>
|
|
4096
|
+
* </li>
|
|
4097
|
+
* <li>
|
|
4098
|
+
* <p>RDS for Oracle - Must contain from 8 to 30 characters.</p>
|
|
4099
|
+
* </li>
|
|
4100
|
+
* <li>
|
|
4101
|
+
* <p>RDS for PostgreSQL - Must contain from 8 to 128 characters.</p>
|
|
4102
|
+
* </li>
|
|
4103
|
+
* </ul>
|
|
4044
4104
|
*/
|
|
4045
4105
|
MasterUserPassword?: string;
|
|
4046
4106
|
/**
|
|
@@ -4051,9 +4111,14 @@ export interface ModifyDBInstanceMessage {
|
|
|
4051
4111
|
* parameter changes aren't applied during the next maintenance window. However, if you modify
|
|
4052
4112
|
* dynamic parameters in the newly associated DB parameter group, these changes are applied
|
|
4053
4113
|
* immediately without a reboot.</p>
|
|
4054
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4114
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4055
4115
|
* <p>Default: Uses existing setting</p>
|
|
4056
|
-
* <p>Constraints
|
|
4116
|
+
* <p>Constraints:</p>
|
|
4117
|
+
* <ul>
|
|
4118
|
+
* <li>
|
|
4119
|
+
* <p>Must be in the same DB parameter group family as the DB instance.</p>
|
|
4120
|
+
* </li>
|
|
4121
|
+
* </ul>
|
|
4057
4122
|
*/
|
|
4058
4123
|
DBParameterGroupName?: string;
|
|
4059
4124
|
/**
|
|
@@ -4064,25 +4129,20 @@ export interface ModifyDBInstanceMessage {
|
|
|
4064
4129
|
* <p>These changes are applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is enabled
|
|
4065
4130
|
* for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously
|
|
4066
4131
|
* applied as soon as possible.</p>
|
|
4067
|
-
* <p>
|
|
4068
|
-
* <b>Amazon Aurora</b>
|
|
4069
|
-
* </p>
|
|
4070
|
-
* <p>Not applicable. The retention period for automated backups is managed by the DB
|
|
4132
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB
|
|
4071
4133
|
* cluster. For more information, see <code>ModifyDBCluster</code>.</p>
|
|
4072
4134
|
* <p>Default: Uses existing setting</p>
|
|
4073
4135
|
* <p>Constraints:</p>
|
|
4074
4136
|
* <ul>
|
|
4075
4137
|
* <li>
|
|
4076
|
-
* <p>
|
|
4077
|
-
* read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.</p>
|
|
4138
|
+
* <p>Must be a value from 0 to 35.</p>
|
|
4078
4139
|
* </li>
|
|
4079
4140
|
* <li>
|
|
4080
|
-
* <p>
|
|
4081
|
-
*
|
|
4141
|
+
* <p>Can't be set to 0 if the DB instance is a source to
|
|
4142
|
+
* read replicas.</p>
|
|
4082
4143
|
* </li>
|
|
4083
4144
|
* <li>
|
|
4084
|
-
* <p>
|
|
4085
|
-
* 9.3.5.</p>
|
|
4145
|
+
* <p>Can't be set to 0 for an RDS Custom for Oracle DB instance.</p>
|
|
4086
4146
|
* </li>
|
|
4087
4147
|
* </ul>
|
|
4088
4148
|
*/
|
|
@@ -4092,53 +4152,64 @@ export interface ModifyDBInstanceMessage {
|
|
|
4092
4152
|
* if automated backups are enabled,
|
|
4093
4153
|
* as determined by the <code>BackupRetentionPeriod</code> parameter.
|
|
4094
4154
|
* Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
|
|
4095
|
-
*
|
|
4096
|
-
*
|
|
4097
|
-
*
|
|
4098
|
-
*
|
|
4099
|
-
* <b>Amazon Aurora</b>
|
|
4100
|
-
* </p>
|
|
4101
|
-
* <p>Not applicable. The daily time range for creating automated backups is managed by
|
|
4102
|
-
* the DB cluster. For more information, see <code>ModifyDBCluster</code>.</p>
|
|
4155
|
+
* The default is a 30-minute window selected at random from an
|
|
4156
|
+
* 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>
|
|
4157
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by
|
|
4158
|
+
* the DB cluster. For more information, see <code>ModifyDBCluster</code>.</p>
|
|
4103
4159
|
* <p>Constraints:</p>
|
|
4104
4160
|
* <ul>
|
|
4105
4161
|
* <li>
|
|
4106
|
-
* <p>Must be in the format hh24:mi-hh24:mi</p>
|
|
4162
|
+
* <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p>
|
|
4107
4163
|
* </li>
|
|
4108
4164
|
* <li>
|
|
4109
|
-
* <p>Must be in Universal Time
|
|
4165
|
+
* <p>Must be in Universal Coordinated Time (UTC).</p>
|
|
4110
4166
|
* </li>
|
|
4111
4167
|
* <li>
|
|
4112
|
-
* <p>Must not conflict with the preferred maintenance window
|
|
4168
|
+
* <p>Must not conflict with the preferred maintenance window.</p>
|
|
4113
4169
|
* </li>
|
|
4114
4170
|
* <li>
|
|
4115
|
-
* <p>Must be at least 30 minutes
|
|
4171
|
+
* <p>Must be at least 30 minutes.</p>
|
|
4116
4172
|
* </li>
|
|
4117
4173
|
* </ul>
|
|
4118
4174
|
*/
|
|
4119
4175
|
PreferredBackupWindow?: string;
|
|
4120
4176
|
/**
|
|
4121
|
-
* <p>The weekly time range
|
|
4177
|
+
* <p>The weekly time range during which system maintenance can occur, which
|
|
4122
4178
|
* might result in an outage. Changing this parameter doesn't result in an outage, except
|
|
4123
4179
|
* in the following situation, and the change is asynchronously applied as soon as
|
|
4124
4180
|
* possible. If there are pending actions that cause a reboot, and the maintenance window
|
|
4125
|
-
* is changed to include the current time, then changing this parameter
|
|
4126
|
-
* of the DB instance. If
|
|
4181
|
+
* is changed to include the current time, then changing this parameter causes a reboot
|
|
4182
|
+
* of the DB instance. If you change this window to the current time, there must be at least 30
|
|
4127
4183
|
* minutes between the current time and end of the window to ensure pending changes are
|
|
4128
4184
|
* applied.</p>
|
|
4129
4185
|
* <p>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> in the <i>Amazon RDS User Guide.</i>
|
|
4130
4186
|
* </p>
|
|
4131
4187
|
* <p>Default: Uses existing setting</p>
|
|
4132
|
-
* <p>
|
|
4133
|
-
* <
|
|
4134
|
-
*
|
|
4188
|
+
* <p>Constraints:</p>
|
|
4189
|
+
* <ul>
|
|
4190
|
+
* <li>
|
|
4191
|
+
* <p>Must be in the format <code>ddd:hh24:mi-ddd:hh24:mi</code>.</p>
|
|
4192
|
+
* </li>
|
|
4193
|
+
* <li>
|
|
4194
|
+
* <p>The day values must be <code>mon | tue | wed | thu | fri | sat | sun</code>. </p>
|
|
4195
|
+
* </li>
|
|
4196
|
+
* <li>
|
|
4197
|
+
* <p>Must be in Universal Coordinated Time (UTC).</p>
|
|
4198
|
+
* </li>
|
|
4199
|
+
* <li>
|
|
4200
|
+
* <p>Must not conflict with the preferred backup window.</p>
|
|
4201
|
+
* </li>
|
|
4202
|
+
* <li>
|
|
4203
|
+
* <p>Must be at least 30 minutes.</p>
|
|
4204
|
+
* </li>
|
|
4205
|
+
* </ul>
|
|
4135
4206
|
*/
|
|
4136
4207
|
PreferredMaintenanceWindow?: string;
|
|
4137
4208
|
/**
|
|
4138
|
-
* <p>
|
|
4209
|
+
* <p>Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result
|
|
4139
4210
|
* in an outage. The change is applied during the next maintenance window unless the <code>ApplyImmediately</code>
|
|
4140
4211
|
* parameter is enabled for this request.</p>
|
|
4141
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4212
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4142
4213
|
*/
|
|
4143
4214
|
MultiAZ?: boolean;
|
|
4144
4215
|
/**
|
|
@@ -4150,27 +4221,32 @@ export interface ModifyDBInstanceMessage {
|
|
|
4150
4221
|
* new DB parameter group in the DB parameter group family for the new engine version must
|
|
4151
4222
|
* be specified. The new DB parameter group can be the default for that DB parameter group
|
|
4152
4223
|
* family.</p>
|
|
4153
|
-
* <p>If you specify only a major version, Amazon RDS
|
|
4224
|
+
* <p>If you specify only a major version, Amazon RDS updates the DB instance to the
|
|
4154
4225
|
* default minor version if the current minor version is lower.
|
|
4155
4226
|
* For information about valid engine versions, see <code>CreateDBInstance</code>,
|
|
4156
4227
|
* or call <code>DescribeDBEngineVersions</code>.</p>
|
|
4157
4228
|
* <p>If the instance that you're modifying is acting as a read replica, the engine version
|
|
4158
|
-
* that you specify must be the same or
|
|
4229
|
+
* that you specify must be the same or higher than the version that the source DB instance
|
|
4159
4230
|
* or cluster is running.</p>
|
|
4160
4231
|
* <p>In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
|
|
4161
4232
|
* <code>PATCH_DB_FAILURE</code> lifecycle.</p>
|
|
4162
4233
|
*/
|
|
4163
4234
|
EngineVersion?: string;
|
|
4164
4235
|
/**
|
|
4165
|
-
* <p>
|
|
4236
|
+
* <p>Specifies whether major version upgrades are allowed. Changing this parameter doesn't
|
|
4166
4237
|
* result in an outage and the change is asynchronously applied as soon as possible.</p>
|
|
4167
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4168
|
-
* <p>Constraints
|
|
4169
|
-
*
|
|
4238
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4239
|
+
* <p>Constraints:</p>
|
|
4240
|
+
* <ul>
|
|
4241
|
+
* <li>
|
|
4242
|
+
* <p>Major version upgrades must be allowed when specifying a value
|
|
4243
|
+
* for the <code>EngineVersion</code> parameter that's a different major version than the DB instance's current version.</p>
|
|
4244
|
+
* </li>
|
|
4245
|
+
* </ul>
|
|
4170
4246
|
*/
|
|
4171
4247
|
AllowMajorVersionUpgrade?: boolean;
|
|
4172
4248
|
/**
|
|
4173
|
-
* <p>
|
|
4249
|
+
* <p>Specifies whether minor version upgrades are applied automatically to the DB instance
|
|
4174
4250
|
* during the maintenance window. An outage occurs when all the following conditions are met:</p>
|
|
4175
4251
|
* <ul>
|
|
4176
4252
|
* <li>
|
|
@@ -4183,18 +4259,37 @@ export interface ModifyDBInstanceMessage {
|
|
|
4183
4259
|
* <p>RDS has enabled automatic patching for the engine version.</p>
|
|
4184
4260
|
* </li>
|
|
4185
4261
|
* </ul>
|
|
4186
|
-
* <p>If any of the preceding conditions isn't met, RDS applies the change as soon as possible and
|
|
4262
|
+
* <p>If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and
|
|
4187
4263
|
* doesn't cause an outage.</p>
|
|
4188
|
-
* <p>For an RDS Custom DB instance,
|
|
4189
|
-
* to <code>false</code>. Otherwise, the operation returns an error.</p>
|
|
4264
|
+
* <p>For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.</p>
|
|
4190
4265
|
*/
|
|
4191
4266
|
AutoMinorVersionUpgrade?: boolean;
|
|
4192
4267
|
/**
|
|
4193
4268
|
* <p>The license model for the DB instance.</p>
|
|
4194
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4195
|
-
* <p>Valid
|
|
4196
|
-
*
|
|
4197
|
-
*
|
|
4269
|
+
* <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>
|
|
4270
|
+
* <p>Valid Values:</p>
|
|
4271
|
+
* <ul>
|
|
4272
|
+
* <li>
|
|
4273
|
+
* <p>RDS for MariaDB - <code>general-public-license</code>
|
|
4274
|
+
* </p>
|
|
4275
|
+
* </li>
|
|
4276
|
+
* <li>
|
|
4277
|
+
* <p>RDS for Microsoft SQL Server - <code>license-included</code>
|
|
4278
|
+
* </p>
|
|
4279
|
+
* </li>
|
|
4280
|
+
* <li>
|
|
4281
|
+
* <p>RDS for MySQL - <code>general-public-license</code>
|
|
4282
|
+
* </p>
|
|
4283
|
+
* </li>
|
|
4284
|
+
* <li>
|
|
4285
|
+
* <p>RDS for Oracle - <code>bring-your-own-license | license-included</code>
|
|
4286
|
+
* </p>
|
|
4287
|
+
* </li>
|
|
4288
|
+
* <li>
|
|
4289
|
+
* <p>RDS for PostgreSQL - <code>postgresql-license</code>
|
|
4290
|
+
* </p>
|
|
4291
|
+
* </li>
|
|
4292
|
+
* </ul>
|
|
4198
4293
|
*/
|
|
4199
4294
|
LicenseModel?: string;
|
|
4200
4295
|
/**
|
|
@@ -4215,14 +4310,18 @@ export interface ModifyDBInstanceMessage {
|
|
|
4215
4310
|
* instance are suspended. No other Amazon RDS operations can take place for the instance,
|
|
4216
4311
|
* including modifying the instance, rebooting the instance, deleting the instance,
|
|
4217
4312
|
* creating a read replica for the instance, and creating a DB snapshot of the instance.</p>
|
|
4218
|
-
* <p>Constraints
|
|
4219
|
-
*
|
|
4313
|
+
* <p>Constraints:</p>
|
|
4314
|
+
* <ul>
|
|
4315
|
+
* <li>
|
|
4316
|
+
* <p>For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value.
|
|
4220
4317
|
* Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.</p>
|
|
4318
|
+
* </li>
|
|
4319
|
+
* </ul>
|
|
4221
4320
|
* <p>Default: Uses existing setting</p>
|
|
4222
4321
|
*/
|
|
4223
4322
|
Iops?: number;
|
|
4224
4323
|
/**
|
|
4225
|
-
* <p>
|
|
4324
|
+
* <p>The option group to associate the DB instance with.</p>
|
|
4226
4325
|
* <p>Changing this parameter doesn't result in an outage, with one exception. If the parameter change results
|
|
4227
4326
|
* in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which
|
|
4228
4327
|
* new connections are rejected but existing connections aren't interrupted.</p>
|
|
@@ -4231,14 +4330,14 @@ export interface ModifyDBInstanceMessage {
|
|
|
4231
4330
|
* <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed
|
|
4232
4331
|
* from an option group, and that option group can't be removed from a DB instance after
|
|
4233
4332
|
* it is associated with a DB instance.</p>
|
|
4234
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4333
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4235
4334
|
*/
|
|
4236
4335
|
OptionGroupName?: string;
|
|
4237
4336
|
/**
|
|
4238
|
-
* <p>The new
|
|
4337
|
+
* <p>The new identifier for the DB instance when renaming a DB instance. When you change the DB instance
|
|
4239
4338
|
* identifier, an instance reboot occurs immediately if you enable <code>ApplyImmediately</code>, or will occur
|
|
4240
|
-
* during the next maintenance window if you disable
|
|
4241
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4339
|
+
* during the next maintenance window if you disable <code>ApplyImmediately</code>. This value is stored as a lowercase string.</p>
|
|
4340
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4242
4341
|
* <p>Constraints:</p>
|
|
4243
4342
|
* <ul>
|
|
4244
4343
|
* <li>
|
|
@@ -4256,7 +4355,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
4256
4355
|
*/
|
|
4257
4356
|
NewDBInstanceIdentifier?: string;
|
|
4258
4357
|
/**
|
|
4259
|
-
* <p>
|
|
4358
|
+
* <p>The storage type to associate with the DB instance.</p>
|
|
4260
4359
|
* <p>If you specify Provisioned IOPS (<code>io1</code>),
|
|
4261
4360
|
* you must also include a value for the <code>Iops</code> parameter.</p>
|
|
4262
4361
|
* <p>If you choose to migrate your DB instance from using standard storage to using
|
|
@@ -4270,26 +4369,25 @@ export interface ModifyDBInstanceMessage {
|
|
|
4270
4369
|
* instance are suspended. No other Amazon RDS operations can take place for the instance,
|
|
4271
4370
|
* including modifying the instance, rebooting the instance, deleting the instance,
|
|
4272
4371
|
* creating a read replica for the instance, and creating a DB snapshot of the instance.</p>
|
|
4273
|
-
* <p>Valid
|
|
4274
|
-
* </p>
|
|
4275
|
-
* <p>Default: <code>io1</code> if the <code>Iops</code> parameter
|
|
4276
|
-
* is specified, otherwise <code>gp2</code>
|
|
4372
|
+
* <p>Valid Values: <code>gp2 | gp3 | io1 | standard</code>
|
|
4277
4373
|
* </p>
|
|
4374
|
+
* <p>Default: <code>io1</code>, if the <code>Iops</code> parameter
|
|
4375
|
+
* is specified. Otherwise, <code>gp2</code>.</p>
|
|
4278
4376
|
*/
|
|
4279
4377
|
StorageType?: string;
|
|
4280
4378
|
/**
|
|
4281
4379
|
* <p>The ARN from the key store with which to associate the instance for TDE encryption.</p>
|
|
4282
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4380
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4283
4381
|
*/
|
|
4284
4382
|
TdeCredentialArn?: string;
|
|
4285
4383
|
/**
|
|
4286
4384
|
* <p>The password for the given ARN from the key store in order to access the device.</p>
|
|
4287
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4385
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4288
4386
|
*/
|
|
4289
4387
|
TdeCredentialPassword?: string;
|
|
4290
4388
|
/**
|
|
4291
|
-
* <p>
|
|
4292
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4389
|
+
* <p>The CA certificate identifier to use for the DB instance6's server certificate.</p>
|
|
4390
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4293
4391
|
* <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
|
|
4294
4392
|
* instance</a> in the <i>Amazon RDS User Guide</i> and
|
|
4295
4393
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html">
|
|
@@ -4304,25 +4402,25 @@ export interface ModifyDBInstanceMessage {
|
|
|
4304
4402
|
* Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.</p>
|
|
4305
4403
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html">
|
|
4306
4404
|
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
4307
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4405
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4308
4406
|
*/
|
|
4309
4407
|
Domain?: string;
|
|
4310
4408
|
/**
|
|
4311
|
-
* <p>
|
|
4312
|
-
* <p>
|
|
4313
|
-
* <b>Amazon Aurora</b>
|
|
4314
|
-
* </p>
|
|
4315
|
-
* <p>Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this
|
|
4409
|
+
* <p>Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.</p>
|
|
4410
|
+
* <p>This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this
|
|
4316
4411
|
* value for an Aurora DB instance has no effect on the DB cluster setting. For more
|
|
4317
4412
|
* information, see <code>ModifyDBCluster</code>.</p>
|
|
4318
4413
|
*/
|
|
4319
4414
|
CopyTagsToSnapshot?: boolean;
|
|
4320
4415
|
/**
|
|
4321
|
-
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected
|
|
4322
|
-
*
|
|
4323
|
-
* <p>If <code>MonitoringRoleArn</code> is specified, set <code>MonitoringInterval</code>
|
|
4324
|
-
*
|
|
4325
|
-
* <p>
|
|
4416
|
+
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for
|
|
4417
|
+
* the DB instance. To disable collection of Enhanced Monitoring metrics, specify <code>0</code>.</p>
|
|
4418
|
+
* <p>If <code>MonitoringRoleArn</code> is specified, set <code>MonitoringInterval</code>
|
|
4419
|
+
* to a value other than <code>0</code>.</p>
|
|
4420
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4421
|
+
* <p>Valid Values: <code>0 | 1 | 5 | 10 | 15 | 30 | 60</code>
|
|
4422
|
+
* </p>
|
|
4423
|
+
* <p>Default: <code>0</code>
|
|
4326
4424
|
* </p>
|
|
4327
4425
|
*/
|
|
4328
4426
|
MonitoringInterval?: number;
|
|
@@ -4332,55 +4430,48 @@ export interface ModifyDBInstanceMessage {
|
|
|
4332
4430
|
* specified for options in the option group for the DB instance.</p>
|
|
4333
4431
|
* <p>If you change the <code>DBPortNumber</code> value, your database restarts regardless of
|
|
4334
4432
|
* the value of the <code>ApplyImmediately</code> parameter.</p>
|
|
4335
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4336
|
-
* <p>
|
|
4337
|
-
* <b>MySQL</b>
|
|
4338
|
-
* </p>
|
|
4339
|
-
* <p>Default: <code>3306</code>
|
|
4340
|
-
* </p>
|
|
4341
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
4342
|
-
* </p>
|
|
4343
|
-
* <p>
|
|
4344
|
-
* <b>MariaDB</b>
|
|
4345
|
-
* </p>
|
|
4346
|
-
* <p>Default: <code>3306</code>
|
|
4347
|
-
* </p>
|
|
4348
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
4349
|
-
* </p>
|
|
4350
|
-
* <p>
|
|
4351
|
-
* <b>PostgreSQL</b>
|
|
4433
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4434
|
+
* <p>Valid Values: <code>1150-65535</code>
|
|
4352
4435
|
* </p>
|
|
4353
|
-
* <p>Default
|
|
4354
|
-
*
|
|
4355
|
-
*
|
|
4356
|
-
*
|
|
4357
|
-
*
|
|
4358
|
-
*
|
|
4359
|
-
* <
|
|
4360
|
-
*
|
|
4361
|
-
*
|
|
4362
|
-
*
|
|
4363
|
-
*
|
|
4364
|
-
*
|
|
4365
|
-
*
|
|
4366
|
-
*
|
|
4367
|
-
*
|
|
4368
|
-
*
|
|
4369
|
-
*
|
|
4370
|
-
*
|
|
4371
|
-
*
|
|
4436
|
+
* <p>Default:</p>
|
|
4437
|
+
* <ul>
|
|
4438
|
+
* <li>
|
|
4439
|
+
* <p>Amazon Aurora - <code>3306</code>
|
|
4440
|
+
* </p>
|
|
4441
|
+
* </li>
|
|
4442
|
+
* <li>
|
|
4443
|
+
* <p>RDS for MariaDB - <code>3306</code>
|
|
4444
|
+
* </p>
|
|
4445
|
+
* </li>
|
|
4446
|
+
* <li>
|
|
4447
|
+
* <p>RDS for Microsoft SQL Server - <code>1433</code>
|
|
4448
|
+
* </p>
|
|
4449
|
+
* </li>
|
|
4450
|
+
* <li>
|
|
4451
|
+
* <p>RDS for MySQL - <code>3306</code>
|
|
4452
|
+
* </p>
|
|
4453
|
+
* </li>
|
|
4454
|
+
* <li>
|
|
4455
|
+
* <p>RDS for Oracle - <code>1521</code>
|
|
4456
|
+
* </p>
|
|
4457
|
+
* </li>
|
|
4458
|
+
* <li>
|
|
4459
|
+
* <p>RDS for PostgreSQL - <code>5432</code>
|
|
4460
|
+
* </p>
|
|
4461
|
+
* </li>
|
|
4462
|
+
* </ul>
|
|
4463
|
+
* <p>Constraints:</p>
|
|
4464
|
+
* <ul>
|
|
4465
|
+
* <li>
|
|
4466
|
+
* <p>For RDS for Microsoft SQL Server, the value can't be <code>1234</code>, <code>1434</code>,
|
|
4467
|
+
* <code>3260</code>, <code>3343</code>, <code>3389</code>, <code>47001</code>, or
|
|
4372
4468
|
* <code>49152-49156</code>.</p>
|
|
4373
|
-
*
|
|
4374
|
-
*
|
|
4375
|
-
* </p>
|
|
4376
|
-
* <p>Default: <code>3306</code>
|
|
4377
|
-
* </p>
|
|
4378
|
-
* <p>Valid values: <code>1150-65535</code>
|
|
4379
|
-
* </p>
|
|
4469
|
+
* </li>
|
|
4470
|
+
* </ul>
|
|
4380
4471
|
*/
|
|
4381
4472
|
DBPortNumber?: number;
|
|
4382
4473
|
/**
|
|
4383
|
-
* <p>
|
|
4474
|
+
* <p>Specifies whether the DB instance is publicly accessible.</p>
|
|
4384
4475
|
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
4385
4476
|
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
4386
4477
|
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
@@ -4401,28 +4492,30 @@ export interface ModifyDBInstanceMessage {
|
|
|
4401
4492
|
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To
|
|
4402
4493
|
* create an IAM role for Amazon RDS Enhanced Monitoring</a> in the <i>Amazon RDS User Guide.</i>
|
|
4403
4494
|
* </p>
|
|
4404
|
-
* <p>If <code>MonitoringInterval</code> is set to a value other than 0
|
|
4495
|
+
* <p>If <code>MonitoringInterval</code> is set to a value other than <code>0</code>, supply a <code>MonitoringRoleArn</code>
|
|
4405
4496
|
* value.</p>
|
|
4406
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4497
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4407
4498
|
*/
|
|
4408
4499
|
MonitoringRoleArn?: string;
|
|
4409
4500
|
/**
|
|
4410
4501
|
* <p>The name of the IAM role to use when making API calls to the Directory Service.</p>
|
|
4411
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4502
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4412
4503
|
*/
|
|
4413
4504
|
DomainIAMRoleName?: string;
|
|
4414
4505
|
/**
|
|
4415
|
-
* <p>
|
|
4416
|
-
*
|
|
4417
|
-
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
|
4506
|
+
* <p>The order of priority in which an Aurora Replica is promoted to the primary instance
|
|
4507
|
+
* after a failure of the existing primary instance. For more information,
|
|
4508
|
+
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance">
|
|
4418
4509
|
* Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
4419
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4420
|
-
* <p>Default: 1</
|
|
4421
|
-
*
|
|
4510
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4511
|
+
* <p>Default: <code>1</code>
|
|
4512
|
+
* </p>
|
|
4513
|
+
* <p>Valid Values: <code>0 - 15</code>
|
|
4514
|
+
* </p>
|
|
4422
4515
|
*/
|
|
4423
4516
|
PromotionTier?: number;
|
|
4424
4517
|
/**
|
|
4425
|
-
* <p>
|
|
4518
|
+
* <p>Specifies whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
4426
4519
|
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
4427
4520
|
* <p>This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB
|
|
4428
4521
|
* cluster.</p>
|
|
@@ -4430,79 +4523,71 @@ export interface ModifyDBInstanceMessage {
|
|
|
4430
4523
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
4431
4524
|
* IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i>
|
|
4432
4525
|
* </p>
|
|
4433
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4526
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4434
4527
|
*/
|
|
4435
4528
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
4436
4529
|
/**
|
|
4437
|
-
* <p>
|
|
4530
|
+
* <p>Specifies whether to enable Performance Insights for the DB instance.</p>
|
|
4438
4531
|
* <p>For more information, see
|
|
4439
4532
|
* <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>
|
|
4440
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4533
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4441
4534
|
*/
|
|
4442
4535
|
EnablePerformanceInsights?: boolean;
|
|
4443
4536
|
/**
|
|
4444
4537
|
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
|
|
4445
4538
|
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
4446
|
-
* <p>If you
|
|
4539
|
+
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
4447
4540
|
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
4448
4541
|
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
4449
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4542
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4450
4543
|
*/
|
|
4451
4544
|
PerformanceInsightsKMSKeyId?: string;
|
|
4452
4545
|
/**
|
|
4453
|
-
* <p>The number of days to retain Performance Insights data
|
|
4546
|
+
* <p>The number of days to retain Performance Insights data.</p>
|
|
4547
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4548
|
+
* <p>Valid Values:</p>
|
|
4454
4549
|
* <ul>
|
|
4455
4550
|
* <li>
|
|
4456
|
-
* <p>7</p>
|
|
4457
|
-
* </li>
|
|
4458
|
-
* <li>
|
|
4459
4551
|
* <p>
|
|
4460
|
-
* <
|
|
4461
|
-
*
|
|
4462
|
-
* <li>
|
|
4463
|
-
* <p>731</p>
|
|
4464
|
-
* </li>
|
|
4465
|
-
* </ul>
|
|
4466
|
-
* <p>For example, the following values are valid:</p>
|
|
4467
|
-
* <ul>
|
|
4468
|
-
* <li>
|
|
4469
|
-
* <p>93 (3 months * 31)</p>
|
|
4470
|
-
* </li>
|
|
4471
|
-
* <li>
|
|
4472
|
-
* <p>341 (11 months * 31)</p>
|
|
4552
|
+
* <code>7</code>
|
|
4553
|
+
* </p>
|
|
4473
4554
|
* </li>
|
|
4474
4555
|
* <li>
|
|
4475
|
-
* <p>
|
|
4556
|
+
* <p>
|
|
4557
|
+
* <i>month</i> * 31, where <i>month</i> is a number of months from 1-23.
|
|
4558
|
+
* Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31)</p>
|
|
4476
4559
|
* </li>
|
|
4477
4560
|
* <li>
|
|
4478
|
-
* <p>
|
|
4561
|
+
* <p>
|
|
4562
|
+
* <code>731</code>
|
|
4563
|
+
* </p>
|
|
4479
4564
|
* </li>
|
|
4480
4565
|
* </ul>
|
|
4481
|
-
* <p>
|
|
4482
|
-
* <p>
|
|
4566
|
+
* <p>Default: <code>7</code> days</p>
|
|
4567
|
+
* <p>If you specify a retention period that isn't valid, such as <code>94</code>, Amazon RDS returns an error.</p>
|
|
4483
4568
|
*/
|
|
4484
4569
|
PerformanceInsightsRetentionPeriod?: number;
|
|
4485
4570
|
/**
|
|
4486
|
-
* <p>The
|
|
4571
|
+
* <p>The log types to be enabled for export to CloudWatch Logs for a
|
|
4487
4572
|
* specific DB instance.</p>
|
|
4488
4573
|
* <p>A change to the <code>CloudwatchLogsExportConfiguration</code> parameter is always applied to the DB instance
|
|
4489
4574
|
* immediately. Therefore, the <code>ApplyImmediately</code> parameter has no effect.</p>
|
|
4490
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4575
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4491
4576
|
*/
|
|
4492
4577
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
|
4493
4578
|
/**
|
|
4494
4579
|
* <p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.</p>
|
|
4495
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4580
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4496
4581
|
*/
|
|
4497
4582
|
ProcessorFeatures?: ProcessorFeature[];
|
|
4498
4583
|
/**
|
|
4499
|
-
* <p>
|
|
4584
|
+
* <p>Specifies whether the DB instance class of the DB instance uses its default
|
|
4500
4585
|
* processor features.</p>
|
|
4501
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4586
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4502
4587
|
*/
|
|
4503
4588
|
UseDefaultProcessorFeatures?: boolean;
|
|
4504
4589
|
/**
|
|
4505
|
-
* <p>
|
|
4590
|
+
* <p>Specifies whether the DB instance has deletion protection enabled.
|
|
4506
4591
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
4507
4592
|
* deletion protection isn't enabled. For more information, see
|
|
4508
4593
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
@@ -4515,11 +4600,11 @@ export interface ModifyDBInstanceMessage {
|
|
|
4515
4600
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling">
|
|
4516
4601
|
* Managing capacity automatically with Amazon RDS storage autoscaling</a>
|
|
4517
4602
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
4518
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4603
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4519
4604
|
*/
|
|
4520
4605
|
MaxAllocatedStorage?: number;
|
|
4521
4606
|
/**
|
|
4522
|
-
* <p>
|
|
4607
|
+
* <p>Specifies whether the DB instance is restarted when you rotate your
|
|
4523
4608
|
* SSL/TLS certificate.</p>
|
|
4524
4609
|
* <p>By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate
|
|
4525
4610
|
* is not updated until the DB instance is restarted.</p>
|
|
@@ -4541,7 +4626,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
4541
4626
|
* Rotating Your SSL/TLS Certificate</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
4542
4627
|
* </li>
|
|
4543
4628
|
* </ul>
|
|
4544
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4629
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4545
4630
|
*/
|
|
4546
4631
|
CertificateRotationRestart?: boolean;
|
|
4547
4632
|
/**
|
|
@@ -4555,11 +4640,11 @@ export interface ModifyDBInstanceMessage {
|
|
|
4555
4640
|
* accept user connections, a mounted replica can't serve a read-only workload.
|
|
4556
4641
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with Oracle Read Replicas for Amazon RDS</a>
|
|
4557
4642
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
4558
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4643
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4559
4644
|
*/
|
|
4560
4645
|
ReplicaMode?: ReplicaMode | string;
|
|
4561
4646
|
/**
|
|
4562
|
-
* <p>
|
|
4647
|
+
* <p>Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.</p>
|
|
4563
4648
|
* <p>A <i>CoIP</i> provides local or external connectivity to resources in
|
|
4564
4649
|
* your Outpost subnets through your on-premises network. For some use cases, a CoIP can
|
|
4565
4650
|
* provide lower latency for connections to the DB instance from outside of its virtual
|
|
@@ -4572,11 +4657,11 @@ export interface ModifyDBInstanceMessage {
|
|
|
4572
4657
|
EnableCustomerOwnedIp?: boolean;
|
|
4573
4658
|
/**
|
|
4574
4659
|
* <p>The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.</p>
|
|
4575
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4660
|
+
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
|
|
4576
4661
|
*/
|
|
4577
4662
|
AwsBackupRecoveryPointArn?: string;
|
|
4578
4663
|
/**
|
|
4579
|
-
* <p>The automation mode of the RDS Custom DB instance
|
|
4664
|
+
* <p>The automation mode of the RDS Custom DB instance.
|
|
4580
4665
|
* If <code>full</code>, the DB instance automates monitoring and instance recovery. If
|
|
4581
4666
|
* <code>all paused</code>, the instance pauses automation for the duration set by
|
|
4582
4667
|
* <code>ResumeFullAutomationModeMinutes</code>.</p>
|
|
@@ -4584,24 +4669,22 @@ export interface ModifyDBInstanceMessage {
|
|
|
4584
4669
|
AutomationMode?: AutomationMode | string;
|
|
4585
4670
|
/**
|
|
4586
4671
|
* <p>The number of minutes to pause the automation. When the time period ends, RDS Custom resumes
|
|
4587
|
-
* full automation
|
|
4588
|
-
|
|
4589
|
-
|
|
4590
|
-
|
|
4591
|
-
* <p>The network type of the DB instance.</p>
|
|
4592
|
-
* <p>Valid values:</p>
|
|
4672
|
+
* full automation.</p>
|
|
4673
|
+
* <p>Default: <code>60</code>
|
|
4674
|
+
* </p>
|
|
4675
|
+
* <p>Constraints:</p>
|
|
4593
4676
|
* <ul>
|
|
4594
4677
|
* <li>
|
|
4595
|
-
* <p>
|
|
4596
|
-
* <code>IPV4</code>
|
|
4597
|
-
* </p>
|
|
4678
|
+
* <p>Must be at least 60.</p>
|
|
4598
4679
|
* </li>
|
|
4599
4680
|
* <li>
|
|
4600
|
-
* <p>
|
|
4601
|
-
* <code>DUAL</code>
|
|
4602
|
-
* </p>
|
|
4681
|
+
* <p>Must be no more than 1,440.</p>
|
|
4603
4682
|
* </li>
|
|
4604
4683
|
* </ul>
|
|
4684
|
+
*/
|
|
4685
|
+
ResumeFullAutomationModeMinutes?: number;
|
|
4686
|
+
/**
|
|
4687
|
+
* <p>The network type of the DB instance.</p>
|
|
4605
4688
|
* <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the DB instance.
|
|
4606
4689
|
* A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6
|
|
4607
4690
|
* protocols (<code>DUAL</code>).</p>
|
|
@@ -4609,21 +4692,23 @@ export interface ModifyDBInstanceMessage {
|
|
|
4609
4692
|
* Working with a DB instance in a VPC</a> in the
|
|
4610
4693
|
* <i>Amazon RDS User Guide.</i>
|
|
4611
4694
|
* </p>
|
|
4695
|
+
* <p>Valid Values: <code>IPV4 | DUAL</code>
|
|
4696
|
+
* </p>
|
|
4612
4697
|
*/
|
|
4613
4698
|
NetworkType?: string;
|
|
4614
4699
|
/**
|
|
4615
|
-
* <p>
|
|
4700
|
+
* <p>The storage throughput value for the DB instance.</p>
|
|
4616
4701
|
* <p>This setting applies only to the <code>gp3</code> storage type.</p>
|
|
4617
|
-
* <p>This setting doesn't apply to RDS Custom
|
|
4702
|
+
* <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>
|
|
4618
4703
|
*/
|
|
4619
4704
|
StorageThroughput?: number;
|
|
4620
4705
|
/**
|
|
4621
|
-
* <p>
|
|
4706
|
+
* <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.</p>
|
|
4622
4707
|
* <p>If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
|
|
4623
4708
|
* on this management. In this case, you can't specify <code>MasterUserPassword</code>.</p>
|
|
4624
4709
|
* <p>If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the
|
|
4625
4710
|
* master user password is not managed with Amazon Web Services Secrets Manager, then you must specify <code>MasterUserPassword</code>.
|
|
4626
|
-
* In this case, RDS deletes the secret and uses the new password for the master user specified by
|
|
4711
|
+
* In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by
|
|
4627
4712
|
* <code>MasterUserPassword</code>.</p>
|
|
4628
4713
|
* <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>
|
|
4629
4714
|
* in the <i>Amazon RDS User Guide.</i>
|
|
@@ -4638,7 +4723,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
4638
4723
|
*/
|
|
4639
4724
|
ManageMasterUserPassword?: boolean;
|
|
4640
4725
|
/**
|
|
4641
|
-
* <p>
|
|
4726
|
+
* <p>Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the
|
|
4642
4727
|
* master user password.</p>
|
|
4643
4728
|
* <p>This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets
|
|
4644
4729
|
* Manager for the DB cluster. The secret value contains the updated password.</p>
|
|
@@ -4962,6 +5047,16 @@ export interface ModifyDBSnapshotMessage {
|
|
|
4962
5047
|
* <ul>
|
|
4963
5048
|
* <li>
|
|
4964
5049
|
* <p>
|
|
5050
|
+
* <code>19.0.0.0.ru-2022-01.rur-2022-01.r1</code> (supported for 12.2.0.1 DB
|
|
5051
|
+
* snapshots)</p>
|
|
5052
|
+
* </li>
|
|
5053
|
+
* <li>
|
|
5054
|
+
* <p>
|
|
5055
|
+
* <code>19.0.0.0.ru-2022-07.rur-2022-07.r1</code> (supported for 12.1.0.2 DB
|
|
5056
|
+
* snapshots)</p>
|
|
5057
|
+
* </li>
|
|
5058
|
+
* <li>
|
|
5059
|
+
* <p>
|
|
4965
5060
|
* <code>12.1.0.2.v8</code> (supported for 12.1.0.1 DB snapshots)</p>
|
|
4966
5061
|
* </li>
|
|
4967
5062
|
* <li>
|