@aws-sdk/client-rds 3.42.0 → 3.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +52 -0
- package/dist-cjs/RDS.js +15 -0
- package/dist-cjs/commands/RebootDBClusterCommand.js +36 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoints.js +1 -28
- package/dist-cjs/models/models_0.js +4 -594
- package/dist-cjs/models/models_1.js +11 -137
- package/dist-cjs/protocols/Aws_query.js +248 -4
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +9 -3
- package/dist-es/RDS.js +15 -0
- package/dist-es/commands/RebootDBClusterCommand.js +39 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoints.js +1 -28
- package/dist-es/models/models_0.js +0 -392
- package/dist-es/models/models_1.js +8 -92
- package/dist-es/protocols/Aws_query.js +250 -0
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -6
- package/dist-types/RDS.d.ts +199 -118
- package/dist-types/RDSClient.d.ts +8 -3
- package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +1 -6
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +1 -1
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +0 -3
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +11 -7
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +5 -9
- package/dist-types/commands/CreateDBClusterCommand.d.ts +11 -8
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +3 -3
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -5
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +8 -4
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +6 -3
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +6 -2
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +6 -2
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +6 -2
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +6 -2
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +0 -3
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +7 -3
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +9 -4
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +1 -1
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +16 -8
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +11 -7
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +9 -5
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +0 -3
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +0 -3
- package/dist-types/commands/RebootDBClusterCommand.d.ts +52 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +11 -4
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +7 -4
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +1 -1
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +8 -5
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +8 -4
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +571 -809
- package/dist-types/models/models_1.d.ts +686 -285
- package/dist-types/protocols/Aws_query.d.ts +3 -0
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/RDS.d.ts +5 -0
- package/dist-types/ts3.4/RDSClient.d.ts +6 -3
- package/dist-types/ts3.4/commands/RebootDBClusterCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +50 -392
- package/dist-types/ts3.4/models/models_1.d.ts +56 -90
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +3 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +40 -47
|
@@ -989,6 +989,11 @@ export interface DescribeExportTasksMessage {
|
|
|
989
989
|
* </li>
|
|
990
990
|
* <li>
|
|
991
991
|
* <p>
|
|
992
|
+
* <code>in_progress</code>
|
|
993
|
+
* </p>
|
|
994
|
+
* </li>
|
|
995
|
+
* <li>
|
|
996
|
+
* <p>
|
|
992
997
|
* <code>starting</code>
|
|
993
998
|
* </p>
|
|
994
999
|
* </li>
|
|
@@ -1599,7 +1604,7 @@ export interface DescribeOrderableDBInstanceOptionsMessage {
|
|
|
1599
1604
|
* </li>
|
|
1600
1605
|
* <li>
|
|
1601
1606
|
* <p>
|
|
1602
|
-
* <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora)</p>
|
|
1607
|
+
* <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
|
|
1603
1608
|
* </li>
|
|
1604
1609
|
* <li>
|
|
1605
1610
|
* <p>
|
|
@@ -1875,6 +1880,15 @@ export interface OrderableDBInstanceOption {
|
|
|
1875
1880
|
* <p>A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.</p>
|
|
1876
1881
|
*/
|
|
1877
1882
|
SupportsGlobalDatabases?: boolean;
|
|
1883
|
+
/**
|
|
1884
|
+
* <p>Whether DB instances can be configured as a Multi-AZ DB cluster.</p>
|
|
1885
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1886
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1887
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1888
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
1889
|
+
* </p>
|
|
1890
|
+
*/
|
|
1891
|
+
SupportsClusters?: boolean;
|
|
1878
1892
|
}
|
|
1879
1893
|
export declare namespace OrderableDBInstanceOption {
|
|
1880
1894
|
/**
|
|
@@ -2200,12 +2214,6 @@ export interface ReservedDBInstanceNotFoundFault extends __SmithyException, $Met
|
|
|
2200
2214
|
$fault: "client";
|
|
2201
2215
|
message?: string;
|
|
2202
2216
|
}
|
|
2203
|
-
export declare namespace ReservedDBInstanceNotFoundFault {
|
|
2204
|
-
/**
|
|
2205
|
-
* @internal
|
|
2206
|
-
*/
|
|
2207
|
-
const filterSensitiveLog: (obj: ReservedDBInstanceNotFoundFault) => any;
|
|
2208
|
-
}
|
|
2209
2217
|
/**
|
|
2210
2218
|
* <p></p>
|
|
2211
2219
|
*/
|
|
@@ -2360,12 +2368,6 @@ export interface ReservedDBInstancesOfferingNotFoundFault extends __SmithyExcept
|
|
|
2360
2368
|
$fault: "client";
|
|
2361
2369
|
message?: string;
|
|
2362
2370
|
}
|
|
2363
|
-
export declare namespace ReservedDBInstancesOfferingNotFoundFault {
|
|
2364
|
-
/**
|
|
2365
|
-
* @internal
|
|
2366
|
-
*/
|
|
2367
|
-
const filterSensitiveLog: (obj: ReservedDBInstancesOfferingNotFoundFault) => any;
|
|
2368
|
-
}
|
|
2369
2371
|
/**
|
|
2370
2372
|
* <p></p>
|
|
2371
2373
|
*/
|
|
@@ -2617,12 +2619,6 @@ export interface DBLogFileNotFoundFault extends __SmithyException, $MetadataBear
|
|
|
2617
2619
|
$fault: "client";
|
|
2618
2620
|
message?: string;
|
|
2619
2621
|
}
|
|
2620
|
-
export declare namespace DBLogFileNotFoundFault {
|
|
2621
|
-
/**
|
|
2622
|
-
* @internal
|
|
2623
|
-
*/
|
|
2624
|
-
const filterSensitiveLog: (obj: DBLogFileNotFoundFault) => any;
|
|
2625
|
-
}
|
|
2626
2622
|
/**
|
|
2627
2623
|
* <p>This data type is used as a response element to <code>DownloadDBLogFilePortion</code>.</p>
|
|
2628
2624
|
*/
|
|
@@ -2718,9 +2714,10 @@ export interface FailoverDBClusterMessage {
|
|
|
2718
2714
|
*/
|
|
2719
2715
|
DBClusterIdentifier: string | undefined;
|
|
2720
2716
|
/**
|
|
2721
|
-
* <p>The name of the instance to promote to the primary instance.</p>
|
|
2722
|
-
* <p>
|
|
2723
|
-
*
|
|
2717
|
+
* <p>The name of the DB instance to promote to the primary DB instance.</p>
|
|
2718
|
+
* <p>Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,
|
|
2719
|
+
* for example <code>mydbcluster-replica1</code>.</p>
|
|
2720
|
+
* <p>This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.</p>
|
|
2724
2721
|
*/
|
|
2725
2722
|
TargetDBInstanceIdentifier?: string;
|
|
2726
2723
|
}
|
|
@@ -2732,11 +2729,28 @@ export declare namespace FailoverDBClusterMessage {
|
|
|
2732
2729
|
}
|
|
2733
2730
|
export interface FailoverDBClusterResult {
|
|
2734
2731
|
/**
|
|
2735
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
2736
|
-
* </p>
|
|
2737
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
2738
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
2732
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
2739
2733
|
* </p>
|
|
2734
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
2735
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
2736
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
2737
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
2738
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
2739
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
2740
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
2741
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
2742
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
2743
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
2744
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
2745
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
2746
|
+
* </p>
|
|
2747
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
2748
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
2749
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
2750
|
+
* </p>
|
|
2751
|
+
* <note>
|
|
2752
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
2753
|
+
* </note>
|
|
2740
2754
|
*/
|
|
2741
2755
|
DBCluster?: DBCluster;
|
|
2742
2756
|
}
|
|
@@ -2869,12 +2883,6 @@ export interface InstallationMediaAlreadyExistsFault extends __SmithyException,
|
|
|
2869
2883
|
$fault: "client";
|
|
2870
2884
|
message?: string;
|
|
2871
2885
|
}
|
|
2872
|
-
export declare namespace InstallationMediaAlreadyExistsFault {
|
|
2873
|
-
/**
|
|
2874
|
-
* @internal
|
|
2875
|
-
*/
|
|
2876
|
-
const filterSensitiveLog: (obj: InstallationMediaAlreadyExistsFault) => any;
|
|
2877
|
-
}
|
|
2878
2886
|
/**
|
|
2879
2887
|
* <p></p>
|
|
2880
2888
|
*/
|
|
@@ -2985,12 +2993,6 @@ export interface InvalidDBClusterCapacityFault extends __SmithyException, $Metad
|
|
|
2985
2993
|
$fault: "client";
|
|
2986
2994
|
message?: string;
|
|
2987
2995
|
}
|
|
2988
|
-
export declare namespace InvalidDBClusterCapacityFault {
|
|
2989
|
-
/**
|
|
2990
|
-
* @internal
|
|
2991
|
-
*/
|
|
2992
|
-
const filterSensitiveLog: (obj: InvalidDBClusterCapacityFault) => any;
|
|
2993
|
-
}
|
|
2994
2996
|
export interface ModifyCurrentDBClusterCapacityMessage {
|
|
2995
2997
|
/**
|
|
2996
2998
|
* <p>The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.</p>
|
|
@@ -3050,7 +3052,7 @@ export interface ModifyCustomDBEngineVersionMessage {
|
|
|
3050
3052
|
Engine: string | undefined;
|
|
3051
3053
|
/**
|
|
3052
3054
|
* <p>The custom engine version (CEV) that you want to modify. This option is required for
|
|
3053
|
-
* RDS Custom, but optional for Amazon RDS. The combination of <code>Engine</code> and
|
|
3055
|
+
* RDS Custom for Oracle, but optional for Amazon RDS. The combination of <code>Engine</code> and
|
|
3054
3056
|
* <code>EngineVersion</code> is unique per customer per Amazon Web Services Region.</p>
|
|
3055
3057
|
*/
|
|
3056
3058
|
EngineVersion: string | undefined;
|
|
@@ -3119,6 +3121,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3119
3121
|
* <p>The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.</p>
|
|
3120
3122
|
* <p>Constraints: This identifier must match the identifier of an existing DB
|
|
3121
3123
|
* cluster.</p>
|
|
3124
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3122
3125
|
*/
|
|
3123
3126
|
DBClusterIdentifier: string | undefined;
|
|
3124
3127
|
/**
|
|
@@ -3137,6 +3140,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3137
3140
|
* </ul>
|
|
3138
3141
|
* <p>Example: <code>my-cluster2</code>
|
|
3139
3142
|
* </p>
|
|
3143
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3140
3144
|
*/
|
|
3141
3145
|
NewDBClusterIdentifier?: string;
|
|
3142
3146
|
/**
|
|
@@ -3152,10 +3156,11 @@ export interface ModifyDBClusterMessage {
|
|
|
3152
3156
|
* and <code>NewDBClusterIdentifier</code> values are applied during the next maintenance window. All other changes are
|
|
3153
3157
|
* applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p>
|
|
3154
3158
|
* <p>By default, this parameter is disabled.</p>
|
|
3159
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3155
3160
|
*/
|
|
3156
3161
|
ApplyImmediately?: boolean;
|
|
3157
3162
|
/**
|
|
3158
|
-
* <p>The number of days for which automated backups are retained.
|
|
3163
|
+
* <p>The number of days for which automated backups are retained. Specify a minimum value of 1.</p>
|
|
3159
3164
|
* <p>Default: 1</p>
|
|
3160
3165
|
* <p>Constraints:</p>
|
|
3161
3166
|
* <ul>
|
|
@@ -3163,14 +3168,17 @@ export interface ModifyDBClusterMessage {
|
|
|
3163
3168
|
* <p>Must be a value from 1 to 35</p>
|
|
3164
3169
|
* </li>
|
|
3165
3170
|
* </ul>
|
|
3171
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3166
3172
|
*/
|
|
3167
3173
|
BackupRetentionPeriod?: number;
|
|
3168
3174
|
/**
|
|
3169
3175
|
* <p>The name of the DB cluster parameter group to use for the DB cluster.</p>
|
|
3176
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3170
3177
|
*/
|
|
3171
3178
|
DBClusterParameterGroupName?: string;
|
|
3172
3179
|
/**
|
|
3173
3180
|
* <p>A list of VPC security groups that the DB cluster will belong to.</p>
|
|
3181
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3174
3182
|
*/
|
|
3175
3183
|
VpcSecurityGroupIds?: string[];
|
|
3176
3184
|
/**
|
|
@@ -3178,22 +3186,18 @@ export interface ModifyDBClusterMessage {
|
|
|
3178
3186
|
* <p>Constraints: Value must be <code>1150-65535</code>
|
|
3179
3187
|
* </p>
|
|
3180
3188
|
* <p>Default: The same port as the original DB cluster.</p>
|
|
3189
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3181
3190
|
*/
|
|
3182
3191
|
Port?: number;
|
|
3183
3192
|
/**
|
|
3184
3193
|
* <p>The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".</p>
|
|
3185
3194
|
* <p>Constraints: Must contain from 8 to 41 characters.</p>
|
|
3195
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3186
3196
|
*/
|
|
3187
3197
|
MasterUserPassword?: string;
|
|
3188
3198
|
/**
|
|
3189
|
-
* <p>A value that indicates that the DB cluster should be associated with the specified option group
|
|
3190
|
-
*
|
|
3191
|
-
* is applied during the next maintenance window
|
|
3192
|
-
* unless the <code>ApplyImmediately</code> is enabled for this request. If the parameter change results in an option group that
|
|
3193
|
-
* enables OEM, this change can cause a brief (sub-second) period during which new connections
|
|
3194
|
-
* are rejected but existing connections are not interrupted.
|
|
3195
|
-
* </p>
|
|
3196
|
-
* <p>Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.</p>
|
|
3199
|
+
* <p>A value that indicates that the DB cluster should be associated with the specified option group.</p>
|
|
3200
|
+
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
3197
3201
|
*/
|
|
3198
3202
|
OptionGroupName?: string;
|
|
3199
3203
|
/**
|
|
@@ -3222,6 +3226,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3222
3226
|
* <p>Must be at least 30 minutes.</p>
|
|
3223
3227
|
* </li>
|
|
3224
3228
|
* </ul>
|
|
3229
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3225
3230
|
*/
|
|
3226
3231
|
PreferredBackupWindow?: string;
|
|
3227
3232
|
/**
|
|
@@ -3236,24 +3241,23 @@ export interface ModifyDBClusterMessage {
|
|
|
3236
3241
|
* </p>
|
|
3237
3242
|
* <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p>
|
|
3238
3243
|
* <p>Constraints: Minimum 30-minute window.</p>
|
|
3244
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3239
3245
|
*/
|
|
3240
3246
|
PreferredMaintenanceWindow?: string;
|
|
3241
3247
|
/**
|
|
3242
3248
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
3243
|
-
* Management (IAM) accounts to database accounts. By default, mapping
|
|
3244
|
-
*
|
|
3249
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
3250
|
+
* enabled.</p>
|
|
3245
3251
|
* <p>For more information, see
|
|
3246
3252
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
3247
3253
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>
|
|
3248
3254
|
* </p>
|
|
3255
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3249
3256
|
*/
|
|
3250
3257
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
3251
3258
|
/**
|
|
3252
3259
|
* <p>The target backtrack window, in seconds. To disable backtracking, set this value to
|
|
3253
3260
|
* 0.</p>
|
|
3254
|
-
* <note>
|
|
3255
|
-
* <p>Currently, Backtrack is only supported for Aurora MySQL DB clusters.</p>
|
|
3256
|
-
* </note>
|
|
3257
3261
|
* <p>Default: 0</p>
|
|
3258
3262
|
* <p>Constraints:</p>
|
|
3259
3263
|
* <ul>
|
|
@@ -3261,28 +3265,39 @@ export interface ModifyDBClusterMessage {
|
|
|
3261
3265
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
3262
3266
|
* </li>
|
|
3263
3267
|
* </ul>
|
|
3268
|
+
* <p>Valid for: Aurora MySQL DB clusters only</p>
|
|
3264
3269
|
*/
|
|
3265
3270
|
BacktrackWindow?: number;
|
|
3266
3271
|
/**
|
|
3267
3272
|
* <p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.</p>
|
|
3273
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3268
3274
|
*/
|
|
3269
3275
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
|
3270
3276
|
/**
|
|
3271
3277
|
* <p>The version number of the database engine to which you want to upgrade.
|
|
3272
3278
|
* Changing this parameter results in an outage. The change is applied during
|
|
3273
3279
|
* the next maintenance window unless <code>ApplyImmediately</code> is enabled.</p>
|
|
3274
|
-
* <p>To list all of the available engine versions for
|
|
3280
|
+
* <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p>
|
|
3275
3281
|
* <p>
|
|
3276
3282
|
* <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
|
|
3277
3283
|
* </p>
|
|
3278
|
-
* <p>To list all of the available engine versions for
|
|
3284
|
+
* <p>To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:</p>
|
|
3279
3285
|
* <p>
|
|
3280
3286
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
3281
3287
|
* </p>
|
|
3282
|
-
* <p>To list all of the available engine versions for
|
|
3288
|
+
* <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p>
|
|
3283
3289
|
* <p>
|
|
3284
3290
|
* <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"</code>
|
|
3285
3291
|
* </p>
|
|
3292
|
+
* <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p>
|
|
3293
|
+
* <p>
|
|
3294
|
+
* <code>aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
3295
|
+
* </p>
|
|
3296
|
+
* <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p>
|
|
3297
|
+
* <p>
|
|
3298
|
+
* <code>aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"</code>
|
|
3299
|
+
* </p>
|
|
3300
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3286
3301
|
*/
|
|
3287
3302
|
EngineVersion?: string;
|
|
3288
3303
|
/**
|
|
@@ -3290,6 +3305,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3290
3305
|
* <p>Constraints: You must allow major version upgrades when specifying a value for the
|
|
3291
3306
|
* <code>EngineVersion</code> parameter that is a different major version than the DB
|
|
3292
3307
|
* cluster's current version.</p>
|
|
3308
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3293
3309
|
*/
|
|
3294
3310
|
AllowMajorVersionUpgrade?: boolean;
|
|
3295
3311
|
/**
|
|
@@ -3310,6 +3326,7 @@ export interface ModifyDBClusterMessage {
|
|
|
3310
3326
|
* the <code>AllowMajorVersionUpgrade</code> parameter.</p>
|
|
3311
3327
|
* </li>
|
|
3312
3328
|
* </ul>
|
|
3329
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3313
3330
|
*/
|
|
3314
3331
|
DBInstanceParameterGroupName?: string;
|
|
3315
3332
|
/**
|
|
@@ -3320,21 +3337,24 @@ export interface ModifyDBClusterMessage {
|
|
|
3320
3337
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html">Kerberos Authentication</a>
|
|
3321
3338
|
* in the <i>Amazon Aurora User Guide</i>.
|
|
3322
3339
|
* </p>
|
|
3340
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3323
3341
|
*/
|
|
3324
3342
|
Domain?: string;
|
|
3325
3343
|
/**
|
|
3326
3344
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
3345
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3327
3346
|
*/
|
|
3328
3347
|
DomainIAMRoleName?: string;
|
|
3329
3348
|
/**
|
|
3330
3349
|
* <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>
|
|
3350
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3331
3351
|
*/
|
|
3332
3352
|
ScalingConfiguration?: ScalingConfiguration;
|
|
3333
3353
|
/**
|
|
3334
3354
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
3335
3355
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
3336
|
-
* deletion protection
|
|
3337
|
-
* </p>
|
|
3356
|
+
* deletion protection isn't enabled.</p>
|
|
3357
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
3338
3358
|
*/
|
|
3339
3359
|
DeletionProtection?: boolean;
|
|
3340
3360
|
/**
|
|
@@ -3345,11 +3365,13 @@ export interface ModifyDBClusterMessage {
|
|
|
3345
3365
|
* from inside the RDS console with the query editor.</p>
|
|
3346
3366
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using the Data API for Aurora Serverless</a> in the
|
|
3347
3367
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
3368
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3348
3369
|
*/
|
|
3349
3370
|
EnableHttpEndpoint?: boolean;
|
|
3350
3371
|
/**
|
|
3351
3372
|
* <p>A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
|
3352
3373
|
* The default is not to copy them.</p>
|
|
3374
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3353
3375
|
*/
|
|
3354
3376
|
CopyTagsToSnapshot?: boolean;
|
|
3355
3377
|
/**
|
|
@@ -3361,8 +3383,94 @@ export interface ModifyDBClusterMessage {
|
|
|
3361
3383
|
* this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is
|
|
3362
3384
|
* demoted by the <a>FailoverGlobalCluster</a> API operation, but it does nothing until then.
|
|
3363
3385
|
* </p>
|
|
3386
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
3364
3387
|
*/
|
|
3365
3388
|
EnableGlobalWriteForwarding?: boolean;
|
|
3389
|
+
/**
|
|
3390
|
+
* <p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
|
3391
|
+
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p>
|
|
3392
|
+
* <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>
|
|
3393
|
+
* </p>
|
|
3394
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3395
|
+
*/
|
|
3396
|
+
DBClusterInstanceClass?: string;
|
|
3397
|
+
/**
|
|
3398
|
+
* <p>The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.</p>
|
|
3399
|
+
* <p>Type: Integer</p>
|
|
3400
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3401
|
+
*/
|
|
3402
|
+
AllocatedStorage?: number;
|
|
3403
|
+
/**
|
|
3404
|
+
* <p>Specifies the storage type to be associated with the DB cluster.</p>
|
|
3405
|
+
* <p>
|
|
3406
|
+
* Valid values: <code>io1</code>
|
|
3407
|
+
* </p>
|
|
3408
|
+
* <p>
|
|
3409
|
+
* When specified, a value for the <code>Iops</code> parameter is required.
|
|
3410
|
+
* </p>
|
|
3411
|
+
* <p>
|
|
3412
|
+
* Default: <code>io1</code>
|
|
3413
|
+
* </p>
|
|
3414
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3415
|
+
*/
|
|
3416
|
+
StorageType?: string;
|
|
3417
|
+
/**
|
|
3418
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated
|
|
3419
|
+
* for each DB instance in the Multi-AZ DB cluster.</p>
|
|
3420
|
+
* <p>For information about valid Iops values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>.
|
|
3421
|
+
* </p>
|
|
3422
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p>
|
|
3423
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3424
|
+
*/
|
|
3425
|
+
Iops?: number;
|
|
3426
|
+
/**
|
|
3427
|
+
* <p>A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
|
|
3428
|
+
* By default, minor engine upgrades are applied automatically.</p>
|
|
3429
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3430
|
+
*/
|
|
3431
|
+
AutoMinorVersionUpgrade?: boolean;
|
|
3432
|
+
/**
|
|
3433
|
+
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
|
3434
|
+
* To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.</p>
|
|
3435
|
+
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code>
|
|
3436
|
+
* to a value other than 0.</p>
|
|
3437
|
+
* <p>Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code>
|
|
3438
|
+
* </p>
|
|
3439
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3440
|
+
*/
|
|
3441
|
+
MonitoringInterval?: number;
|
|
3442
|
+
/**
|
|
3443
|
+
* <p>The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An
|
|
3444
|
+
* example is <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role,
|
|
3445
|
+
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To
|
|
3446
|
+
* create an IAM role for Amazon RDS Enhanced Monitoring</a> in the <i>Amazon RDS User Guide.</i>
|
|
3447
|
+
* </p>
|
|
3448
|
+
* <p>If <code>MonitoringInterval</code> is set to a value other than 0, supply a <code>MonitoringRoleArn</code> value.</p>
|
|
3449
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3450
|
+
*/
|
|
3451
|
+
MonitoringRoleArn?: string;
|
|
3452
|
+
/**
|
|
3453
|
+
* <p>A value that indicates whether to turn on Performance Insights for the DB cluster.</p>
|
|
3454
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
|
|
3455
|
+
* Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.
|
|
3456
|
+
* </p>
|
|
3457
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3458
|
+
*/
|
|
3459
|
+
EnablePerformanceInsights?: boolean;
|
|
3460
|
+
/**
|
|
3461
|
+
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
|
|
3462
|
+
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
|
|
3463
|
+
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
|
|
3464
|
+
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
|
|
3465
|
+
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
|
|
3466
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3467
|
+
*/
|
|
3468
|
+
PerformanceInsightsKMSKeyId?: string;
|
|
3469
|
+
/**
|
|
3470
|
+
* <p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p>
|
|
3471
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
3472
|
+
*/
|
|
3473
|
+
PerformanceInsightsRetentionPeriod?: number;
|
|
3366
3474
|
}
|
|
3367
3475
|
export declare namespace ModifyDBClusterMessage {
|
|
3368
3476
|
/**
|
|
@@ -3372,11 +3480,28 @@ export declare namespace ModifyDBClusterMessage {
|
|
|
3372
3480
|
}
|
|
3373
3481
|
export interface ModifyDBClusterResult {
|
|
3374
3482
|
/**
|
|
3375
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
3376
|
-
* </p>
|
|
3377
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
3378
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
3483
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
3379
3484
|
* </p>
|
|
3485
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
3486
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
3487
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
3488
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
3489
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
3490
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
3491
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
3492
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
3493
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
3494
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
3495
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
3496
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
3497
|
+
* </p>
|
|
3498
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
3499
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
3500
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
3501
|
+
* </p>
|
|
3502
|
+
* <note>
|
|
3503
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
3504
|
+
* </note>
|
|
3380
3505
|
*/
|
|
3381
3506
|
DBCluster?: DBCluster;
|
|
3382
3507
|
}
|
|
@@ -3539,12 +3664,6 @@ export interface SharedSnapshotQuotaExceededFault extends __SmithyException, $Me
|
|
|
3539
3664
|
$fault: "client";
|
|
3540
3665
|
message?: string;
|
|
3541
3666
|
}
|
|
3542
|
-
export declare namespace SharedSnapshotQuotaExceededFault {
|
|
3543
|
-
/**
|
|
3544
|
-
* @internal
|
|
3545
|
-
*/
|
|
3546
|
-
const filterSensitiveLog: (obj: SharedSnapshotQuotaExceededFault) => any;
|
|
3547
|
-
}
|
|
3548
3667
|
/**
|
|
3549
3668
|
* <p>The DB upgrade failed because a resource the DB depends on can't be
|
|
3550
3669
|
* modified.</p>
|
|
@@ -3554,12 +3673,6 @@ export interface DBUpgradeDependencyFailureFault extends __SmithyException, $Met
|
|
|
3554
3673
|
$fault: "client";
|
|
3555
3674
|
message?: string;
|
|
3556
3675
|
}
|
|
3557
|
-
export declare namespace DBUpgradeDependencyFailureFault {
|
|
3558
|
-
/**
|
|
3559
|
-
* @internal
|
|
3560
|
-
*/
|
|
3561
|
-
const filterSensitiveLog: (obj: DBUpgradeDependencyFailureFault) => any;
|
|
3562
|
-
}
|
|
3563
3676
|
/**
|
|
3564
3677
|
* <p></p>
|
|
3565
3678
|
*/
|
|
@@ -3590,7 +3703,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3590
3703
|
*/
|
|
3591
3704
|
AllocatedStorage?: number;
|
|
3592
3705
|
/**
|
|
3593
|
-
* <p>The new compute and memory capacity of the DB instance, for example
|
|
3706
|
+
* <p>The new compute and memory capacity of the DB instance, for example db.m4.large.
|
|
3594
3707
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
|
|
3595
3708
|
* For the full list of DB instance classes,
|
|
3596
3709
|
* and availability for your engine, see
|
|
@@ -3600,7 +3713,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3600
3713
|
* The change is applied during the next maintenance window,
|
|
3601
3714
|
* unless <code>ApplyImmediately</code> is enabled for this request.
|
|
3602
3715
|
* </p>
|
|
3603
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
3716
|
+
* <p>This setting doesn't apply to RDS Custom for Oracle.</p>
|
|
3604
3717
|
* <p>Default: Uses existing setting</p>
|
|
3605
3718
|
*/
|
|
3606
3719
|
DBInstanceClass?: string;
|
|
@@ -3652,19 +3765,14 @@ export interface ModifyDBInstanceMessage {
|
|
|
3652
3765
|
*/
|
|
3653
3766
|
VpcSecurityGroupIds?: string[];
|
|
3654
3767
|
/**
|
|
3655
|
-
* <p>A value that indicates whether the modifications in this request and
|
|
3656
|
-
*
|
|
3657
|
-
* as soon as possible, regardless of the
|
|
3658
|
-
* <code>PreferredMaintenanceWindow</code> setting for the DB instance. By default, this parameter is
|
|
3659
|
-
* disabled.
|
|
3660
|
-
* </p>
|
|
3768
|
+
* <p>A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible,
|
|
3769
|
+
* regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. By default, this parameter is disabled.</p>
|
|
3661
3770
|
* <p>
|
|
3662
|
-
* If this parameter is disabled, changes to the
|
|
3663
|
-
*
|
|
3664
|
-
*
|
|
3665
|
-
*
|
|
3666
|
-
*
|
|
3667
|
-
* or disabling <code>ApplyImmediately</code> for each modified parameter and to determine when the changes are applied.
|
|
3771
|
+
* If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage
|
|
3772
|
+
* and are applied on the next call to <a>RebootDBInstance</a>, or the next failure reboot. Review the table of parameters in
|
|
3773
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html">Modifying a DB Instance</a> in the
|
|
3774
|
+
* <i>Amazon RDS User Guide</i> to see the impact of enabling or disabling <code>ApplyImmediately</code> for each modified parameter and to
|
|
3775
|
+
* determine when the changes are applied.
|
|
3668
3776
|
* </p>
|
|
3669
3777
|
*/
|
|
3670
3778
|
ApplyImmediately?: boolean;
|
|
@@ -3751,7 +3859,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3751
3859
|
* <ul>
|
|
3752
3860
|
* <li>
|
|
3753
3861
|
* <p>It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to
|
|
3754
|
-
* read replicas. It can't be set to 0 or 35 for an RDS Custom DB instance.</p>
|
|
3862
|
+
* read replicas. It can't be set to 0 or 35 for an RDS Custom for Oracle DB instance.</p>
|
|
3755
3863
|
* </li>
|
|
3756
3864
|
* <li>
|
|
3757
3865
|
* <p>It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or
|
|
@@ -3837,7 +3945,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
3837
3945
|
* default minor version if the current minor version is lower.
|
|
3838
3946
|
* For information about valid engine versions, see <code>CreateDBInstance</code>,
|
|
3839
3947
|
* or call <code>DescribeDBEngineVersions</code>.</p>
|
|
3840
|
-
* <p>In RDS Custom, this parameter is supported for read replicas only if they are in the
|
|
3948
|
+
* <p>In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
|
|
3841
3949
|
* <code>PATCH_DB_FAILURE</code> lifecycle.
|
|
3842
3950
|
* </p>
|
|
3843
3951
|
*/
|
|
@@ -4071,9 +4179,12 @@ export interface ModifyDBInstanceMessage {
|
|
|
4071
4179
|
/**
|
|
4072
4180
|
* <p>A value that indicates whether the DB instance is publicly accessible.
|
|
4073
4181
|
* </p>
|
|
4074
|
-
* <p>When the DB
|
|
4075
|
-
*
|
|
4076
|
-
*
|
|
4182
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
4183
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
4184
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
4185
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
4186
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
4187
|
+
* it.</p>
|
|
4077
4188
|
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
|
|
4078
4189
|
* <p>
|
|
4079
4190
|
* <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a
|
|
@@ -4081,7 +4192,6 @@ export interface ModifyDBInstanceMessage {
|
|
|
4081
4192
|
* </p>
|
|
4082
4193
|
* <p>Changes to the <code>PubliclyAccessible</code> parameter are applied immediately regardless
|
|
4083
4194
|
* of the value of the <code>ApplyImmediately</code> parameter.</p>
|
|
4084
|
-
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
4085
4195
|
*/
|
|
4086
4196
|
PubliclyAccessible?: boolean;
|
|
4087
4197
|
/**
|
|
@@ -4112,8 +4222,8 @@ export interface ModifyDBInstanceMessage {
|
|
|
4112
4222
|
*/
|
|
4113
4223
|
PromotionTier?: number;
|
|
4114
4224
|
/**
|
|
4115
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
4116
|
-
*
|
|
4225
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
4226
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
4117
4227
|
* <p>This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB
|
|
4118
4228
|
* cluster.</p>
|
|
4119
4229
|
* <p>For more information about IAM database authentication, see
|
|
@@ -4168,7 +4278,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
4168
4278
|
/**
|
|
4169
4279
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
4170
4280
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
4171
|
-
* deletion protection
|
|
4281
|
+
* deletion protection isn't enabled. For more information, see
|
|
4172
4282
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
4173
4283
|
* Deleting a DB Instance</a>.
|
|
4174
4284
|
* </p>
|
|
@@ -4265,7 +4375,11 @@ export interface ModifyDBInstanceResult {
|
|
|
4265
4375
|
/**
|
|
4266
4376
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
4267
4377
|
* </p>
|
|
4268
|
-
* <p>This data type is used as a response element in the <code>
|
|
4378
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
4379
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
4380
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
4381
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
4382
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
4269
4383
|
* </p>
|
|
4270
4384
|
*/
|
|
4271
4385
|
DBInstance?: DBInstance;
|
|
@@ -4310,17 +4424,20 @@ export interface ModifyDBParameterGroupMessage {
|
|
|
4310
4424
|
DBParameterGroupName: string | undefined;
|
|
4311
4425
|
/**
|
|
4312
4426
|
* <p>An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and
|
|
4313
|
-
* application method
|
|
4427
|
+
* application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.</p>
|
|
4314
4428
|
* <p>Valid Values (for the application method): <code>immediate | pending-reboot</code>
|
|
4315
4429
|
* </p>
|
|
4430
|
+
* <p>You can use the <code>immediate</code> value with dynamic parameters only. You can use the <code>pending-reboot</code> value for both dynamic
|
|
4431
|
+
* and static parameters.</p>
|
|
4432
|
+
* <p>When the application method is <code>immediate</code>, changes to dynamic parameters are applied immediately to the DB instances associated with
|
|
4433
|
+
* the parameter group.</p>
|
|
4434
|
+
* <p>When the application method is <code>pending-reboot</code>, changes to dynamic and static parameters are applied after a reboot without failover
|
|
4435
|
+
* to the DB instances associated with the parameter group.</p>
|
|
4316
4436
|
* <note>
|
|
4317
|
-
* <p>You can use
|
|
4318
|
-
* <code>pending-reboot</code> value for both dynamic and static parameters.</p>
|
|
4319
|
-
* <p>When the application method is <code>immediate</code>, changes to dynamic parameters are applied immediately
|
|
4320
|
-
* to the DB instances associated with the parameter group. When the application method is <code>pending-reboot</code>,
|
|
4321
|
-
* changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the
|
|
4322
|
-
* parameter group.</p>
|
|
4437
|
+
* <p>You can't use <code>pending-reboot</code> with dynamic parameters on RDS for SQL Server DB instances. Use <code>immediate</code>.</p>
|
|
4323
4438
|
* </note>
|
|
4439
|
+
* <p>For more information on modifying DB parameters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html">Working
|
|
4440
|
+
* with DB parameter groups</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
4324
4441
|
*/
|
|
4325
4442
|
Parameters: Parameter[] | undefined;
|
|
4326
4443
|
}
|
|
@@ -4716,12 +4833,6 @@ export interface SubnetAlreadyInUse extends __SmithyException, $MetadataBearer {
|
|
|
4716
4833
|
$fault: "client";
|
|
4717
4834
|
message?: string;
|
|
4718
4835
|
}
|
|
4719
|
-
export declare namespace SubnetAlreadyInUse {
|
|
4720
|
-
/**
|
|
4721
|
-
* @internal
|
|
4722
|
-
*/
|
|
4723
|
-
const filterSensitiveLog: (obj: SubnetAlreadyInUse) => any;
|
|
4724
|
-
}
|
|
4725
4836
|
/**
|
|
4726
4837
|
* <p></p>
|
|
4727
4838
|
*/
|
|
@@ -4823,7 +4934,7 @@ export interface ModifyGlobalClusterMessage {
|
|
|
4823
4934
|
* <p>
|
|
4824
4935
|
* <code>aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'</code>
|
|
4825
4936
|
* </p>
|
|
4826
|
-
* <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), use the following command:</p>
|
|
4937
|
+
* <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:</p>
|
|
4827
4938
|
* <p>
|
|
4828
4939
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'</code>
|
|
4829
4940
|
* </p>
|
|
@@ -5008,7 +5119,11 @@ export interface PromoteReadReplicaResult {
|
|
|
5008
5119
|
/**
|
|
5009
5120
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
5010
5121
|
* </p>
|
|
5011
|
-
* <p>This data type is used as a response element in the <code>
|
|
5122
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
5123
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
5124
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
5125
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
5126
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
5012
5127
|
* </p>
|
|
5013
5128
|
*/
|
|
5014
5129
|
DBInstance?: DBInstance;
|
|
@@ -5045,11 +5160,28 @@ export declare namespace PromoteReadReplicaDBClusterMessage {
|
|
|
5045
5160
|
}
|
|
5046
5161
|
export interface PromoteReadReplicaDBClusterResult {
|
|
5047
5162
|
/**
|
|
5048
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
5049
|
-
* </p>
|
|
5050
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
5051
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
5163
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
5052
5164
|
* </p>
|
|
5165
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
5166
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5167
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
5168
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
5169
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
5170
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
5171
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5172
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
5173
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
5174
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
5175
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
5176
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5177
|
+
* </p>
|
|
5178
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
5179
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
5180
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
5181
|
+
* </p>
|
|
5182
|
+
* <note>
|
|
5183
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
5184
|
+
* </note>
|
|
5053
5185
|
*/
|
|
5054
5186
|
DBCluster?: DBCluster;
|
|
5055
5187
|
}
|
|
@@ -5116,12 +5248,6 @@ export interface ReservedDBInstanceAlreadyExistsFault extends __SmithyException,
|
|
|
5116
5248
|
$fault: "client";
|
|
5117
5249
|
message?: string;
|
|
5118
5250
|
}
|
|
5119
|
-
export declare namespace ReservedDBInstanceAlreadyExistsFault {
|
|
5120
|
-
/**
|
|
5121
|
-
* @internal
|
|
5122
|
-
*/
|
|
5123
|
-
const filterSensitiveLog: (obj: ReservedDBInstanceAlreadyExistsFault) => any;
|
|
5124
|
-
}
|
|
5125
5251
|
/**
|
|
5126
5252
|
* <p>Request would exceed the user's DB Instance quota.</p>
|
|
5127
5253
|
*/
|
|
@@ -5130,11 +5256,56 @@ export interface ReservedDBInstanceQuotaExceededFault extends __SmithyException,
|
|
|
5130
5256
|
$fault: "client";
|
|
5131
5257
|
message?: string;
|
|
5132
5258
|
}
|
|
5133
|
-
export
|
|
5259
|
+
export interface RebootDBClusterMessage {
|
|
5260
|
+
/**
|
|
5261
|
+
* <p>The DB cluster identifier. This parameter is stored as a lowercase string.</p>
|
|
5262
|
+
* <p>Constraints:</p>
|
|
5263
|
+
* <ul>
|
|
5264
|
+
* <li>
|
|
5265
|
+
* <p>Must match the identifier of an existing DBCluster.</p>
|
|
5266
|
+
* </li>
|
|
5267
|
+
* </ul>
|
|
5268
|
+
*/
|
|
5269
|
+
DBClusterIdentifier: string | undefined;
|
|
5270
|
+
}
|
|
5271
|
+
export declare namespace RebootDBClusterMessage {
|
|
5134
5272
|
/**
|
|
5135
5273
|
* @internal
|
|
5136
5274
|
*/
|
|
5137
|
-
const filterSensitiveLog: (obj:
|
|
5275
|
+
const filterSensitiveLog: (obj: RebootDBClusterMessage) => any;
|
|
5276
|
+
}
|
|
5277
|
+
export interface RebootDBClusterResult {
|
|
5278
|
+
/**
|
|
5279
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
5280
|
+
* </p>
|
|
5281
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
5282
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5283
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
5284
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
5285
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
5286
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
5287
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5288
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
5289
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
5290
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
5291
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
5292
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5293
|
+
* </p>
|
|
5294
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
5295
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
5296
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
5297
|
+
* </p>
|
|
5298
|
+
* <note>
|
|
5299
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
5300
|
+
* </note>
|
|
5301
|
+
*/
|
|
5302
|
+
DBCluster?: DBCluster;
|
|
5303
|
+
}
|
|
5304
|
+
export declare namespace RebootDBClusterResult {
|
|
5305
|
+
/**
|
|
5306
|
+
* @internal
|
|
5307
|
+
*/
|
|
5308
|
+
const filterSensitiveLog: (obj: RebootDBClusterResult) => any;
|
|
5138
5309
|
}
|
|
5139
5310
|
/**
|
|
5140
5311
|
* <p></p>
|
|
@@ -5168,7 +5339,11 @@ export interface RebootDBInstanceResult {
|
|
|
5168
5339
|
/**
|
|
5169
5340
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
5170
5341
|
* </p>
|
|
5171
|
-
* <p>This data type is used as a response element in the <code>
|
|
5342
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
5343
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
5344
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
5345
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
5346
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
5172
5347
|
* </p>
|
|
5173
5348
|
*/
|
|
5174
5349
|
DBInstance?: DBInstance;
|
|
@@ -5187,12 +5362,6 @@ export interface DBProxyTargetAlreadyRegisteredFault extends __SmithyException,
|
|
|
5187
5362
|
$fault: "client";
|
|
5188
5363
|
message?: string;
|
|
5189
5364
|
}
|
|
5190
|
-
export declare namespace DBProxyTargetAlreadyRegisteredFault {
|
|
5191
|
-
/**
|
|
5192
|
-
* @internal
|
|
5193
|
-
*/
|
|
5194
|
-
const filterSensitiveLog: (obj: DBProxyTargetAlreadyRegisteredFault) => any;
|
|
5195
|
-
}
|
|
5196
5365
|
/**
|
|
5197
5366
|
* <p>The requested operation can't be performed because there aren't enough available IP addresses
|
|
5198
5367
|
* in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required
|
|
@@ -5203,12 +5372,6 @@ export interface InsufficientAvailableIPsInSubnetFault extends __SmithyException
|
|
|
5203
5372
|
$fault: "client";
|
|
5204
5373
|
message?: string;
|
|
5205
5374
|
}
|
|
5206
|
-
export declare namespace InsufficientAvailableIPsInSubnetFault {
|
|
5207
|
-
/**
|
|
5208
|
-
* @internal
|
|
5209
|
-
*/
|
|
5210
|
-
const filterSensitiveLog: (obj: InsufficientAvailableIPsInSubnetFault) => any;
|
|
5211
|
-
}
|
|
5212
5375
|
export interface RegisterDBProxyTargetsRequest {
|
|
5213
5376
|
/**
|
|
5214
5377
|
* <p>The identifier of the <code>DBProxy</code> that is associated with the <code>DBProxyTargetGroup</code>.</p>
|
|
@@ -5285,12 +5448,6 @@ export interface DBClusterRoleNotFoundFault extends __SmithyException, $Metadata
|
|
|
5285
5448
|
$fault: "client";
|
|
5286
5449
|
message?: string;
|
|
5287
5450
|
}
|
|
5288
|
-
export declare namespace DBClusterRoleNotFoundFault {
|
|
5289
|
-
/**
|
|
5290
|
-
* @internal
|
|
5291
|
-
*/
|
|
5292
|
-
const filterSensitiveLog: (obj: DBClusterRoleNotFoundFault) => any;
|
|
5293
|
-
}
|
|
5294
5451
|
export interface RemoveRoleFromDBClusterMessage {
|
|
5295
5452
|
/**
|
|
5296
5453
|
* <p>The name of the DB cluster to disassociate the IAM role from.</p>
|
|
@@ -5322,12 +5479,6 @@ export interface DBInstanceRoleNotFoundFault extends __SmithyException, $Metadat
|
|
|
5322
5479
|
$fault: "client";
|
|
5323
5480
|
message?: string;
|
|
5324
5481
|
}
|
|
5325
|
-
export declare namespace DBInstanceRoleNotFoundFault {
|
|
5326
|
-
/**
|
|
5327
|
-
* @internal
|
|
5328
|
-
*/
|
|
5329
|
-
const filterSensitiveLog: (obj: DBInstanceRoleNotFoundFault) => any;
|
|
5330
|
-
}
|
|
5331
5482
|
export interface RemoveRoleFromDBInstanceMessage {
|
|
5332
5483
|
/**
|
|
5333
5484
|
* <p>The name of the DB instance to disassociate the IAM role from.</p>
|
|
@@ -5500,12 +5651,6 @@ export interface InvalidS3BucketFault extends __SmithyException, $MetadataBearer
|
|
|
5500
5651
|
$fault: "client";
|
|
5501
5652
|
message?: string;
|
|
5502
5653
|
}
|
|
5503
|
-
export declare namespace InvalidS3BucketFault {
|
|
5504
|
-
/**
|
|
5505
|
-
* @internal
|
|
5506
|
-
*/
|
|
5507
|
-
const filterSensitiveLog: (obj: InvalidS3BucketFault) => any;
|
|
5508
|
-
}
|
|
5509
5654
|
export interface RestoreDBClusterFromS3Message {
|
|
5510
5655
|
/**
|
|
5511
5656
|
* <p>A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.</p>
|
|
@@ -5574,7 +5719,7 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5574
5719
|
DBSubnetGroupName?: string;
|
|
5575
5720
|
/**
|
|
5576
5721
|
* <p>The name of the database engine to be used for this DB cluster.</p>
|
|
5577
|
-
* <p>Valid Values: <code>aurora</code> (for MySQL 5.6-compatible Aurora), <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), and <code>aurora-postgresql</code>
|
|
5722
|
+
* <p>Valid Values: <code>aurora</code> (for MySQL 5.6-compatible Aurora), <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), and <code>aurora-postgresql</code>
|
|
5578
5723
|
* </p>
|
|
5579
5724
|
*/
|
|
5580
5725
|
Engine: string | undefined;
|
|
@@ -5584,7 +5729,7 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5584
5729
|
* <p>
|
|
5585
5730
|
* <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
|
|
5586
5731
|
* </p>
|
|
5587
|
-
* <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), use the following command:</p>
|
|
5732
|
+
* <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:</p>
|
|
5588
5733
|
* <p>
|
|
5589
5734
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
5590
5735
|
* </p>
|
|
@@ -5595,7 +5740,7 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5595
5740
|
* <p>
|
|
5596
5741
|
* <b>Aurora MySQL</b>
|
|
5597
5742
|
* </p>
|
|
5598
|
-
* <p>Example: <code>5.6.10a</code>, <code>5.6.mysql_aurora.1.19.2</code>, <code>5.7.12</code>, <code>5.7.mysql_aurora.2.04.5</code>
|
|
5743
|
+
* <p>Example: <code>5.6.10a</code>, <code>5.6.mysql_aurora.1.19.2</code>, <code>5.7.12</code>, <code>5.7.mysql_aurora.2.04.5</code>, <code>8.0.mysql_aurora.3.01.0</code>
|
|
5599
5744
|
* </p>
|
|
5600
5745
|
* <p>
|
|
5601
5746
|
* <b>Aurora PostgreSQL</b>
|
|
@@ -5703,7 +5848,8 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5703
5848
|
KmsKeyId?: string;
|
|
5704
5849
|
/**
|
|
5705
5850
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
5706
|
-
* Management (IAM) accounts to database accounts. By default, mapping
|
|
5851
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
5852
|
+
* enabled.</p>
|
|
5707
5853
|
*
|
|
5708
5854
|
* <p>For more information, see
|
|
5709
5855
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
@@ -5766,7 +5912,7 @@ export interface RestoreDBClusterFromS3Message {
|
|
|
5766
5912
|
/**
|
|
5767
5913
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
5768
5914
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
5769
|
-
* deletion protection
|
|
5915
|
+
* deletion protection isn't enabled.
|
|
5770
5916
|
* </p>
|
|
5771
5917
|
*/
|
|
5772
5918
|
DeletionProtection?: boolean;
|
|
@@ -5798,11 +5944,28 @@ export declare namespace RestoreDBClusterFromS3Message {
|
|
|
5798
5944
|
}
|
|
5799
5945
|
export interface RestoreDBClusterFromS3Result {
|
|
5800
5946
|
/**
|
|
5801
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
5802
|
-
* </p>
|
|
5803
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
5804
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
5947
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
5805
5948
|
* </p>
|
|
5949
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
5950
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5951
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
5952
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
5953
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
5954
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
5955
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
5956
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
5957
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
5958
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
5959
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
5960
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5961
|
+
* </p>
|
|
5962
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
5963
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
5964
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
5965
|
+
* </p>
|
|
5966
|
+
* <note>
|
|
5967
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
5968
|
+
* </note>
|
|
5806
5969
|
*/
|
|
5807
5970
|
DBCluster?: DBCluster;
|
|
5808
5971
|
}
|
|
@@ -5820,12 +5983,6 @@ export interface InsufficientDBClusterCapacityFault extends __SmithyException, $
|
|
|
5820
5983
|
$fault: "client";
|
|
5821
5984
|
message?: string;
|
|
5822
5985
|
}
|
|
5823
|
-
export declare namespace InsufficientDBClusterCapacityFault {
|
|
5824
|
-
/**
|
|
5825
|
-
* @internal
|
|
5826
|
-
*/
|
|
5827
|
-
const filterSensitiveLog: (obj: InsufficientDBClusterCapacityFault) => any;
|
|
5828
|
-
}
|
|
5829
5986
|
/**
|
|
5830
5987
|
* <p>Cannot restore from VPC backup to non-VPC DB instance.</p>
|
|
5831
5988
|
*/
|
|
@@ -5834,12 +5991,6 @@ export interface InvalidRestoreFault extends __SmithyException, $MetadataBearer
|
|
|
5834
5991
|
$fault: "client";
|
|
5835
5992
|
message?: string;
|
|
5836
5993
|
}
|
|
5837
|
-
export declare namespace InvalidRestoreFault {
|
|
5838
|
-
/**
|
|
5839
|
-
* @internal
|
|
5840
|
-
*/
|
|
5841
|
-
const filterSensitiveLog: (obj: InvalidRestoreFault) => any;
|
|
5842
|
-
}
|
|
5843
5994
|
/**
|
|
5844
5995
|
* <p></p>
|
|
5845
5996
|
*/
|
|
@@ -5847,6 +5998,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5847
5998
|
/**
|
|
5848
5999
|
* <p>Provides the list of Availability Zones (AZs) where instances in the restored DB
|
|
5849
6000
|
* cluster can be created.</p>
|
|
6001
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
5850
6002
|
*/
|
|
5851
6003
|
AvailabilityZones?: string[];
|
|
5852
6004
|
/**
|
|
@@ -5866,6 +6018,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5866
6018
|
* </ul>
|
|
5867
6019
|
* <p>Example: <code>my-snapshot-id</code>
|
|
5868
6020
|
* </p>
|
|
6021
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5869
6022
|
*/
|
|
5870
6023
|
DBClusterIdentifier: string | undefined;
|
|
5871
6024
|
/**
|
|
@@ -5878,41 +6031,63 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5878
6031
|
* <p>Must match the identifier of an existing Snapshot.</p>
|
|
5879
6032
|
* </li>
|
|
5880
6033
|
* </ul>
|
|
6034
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5881
6035
|
*/
|
|
5882
6036
|
SnapshotIdentifier: string | undefined;
|
|
5883
6037
|
/**
|
|
5884
6038
|
* <p>The database engine to use for the new DB cluster.</p>
|
|
5885
6039
|
* <p>Default: The same as source</p>
|
|
5886
6040
|
* <p>Constraint: Must be compatible with the engine of the source</p>
|
|
6041
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5887
6042
|
*/
|
|
5888
6043
|
Engine: string | undefined;
|
|
5889
6044
|
/**
|
|
5890
6045
|
* <p>The version of the database engine to use for the new DB cluster.</p>
|
|
5891
|
-
* <p>To list all of the available engine versions for
|
|
6046
|
+
* <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p>
|
|
5892
6047
|
* <p>
|
|
5893
6048
|
* <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
|
|
5894
6049
|
* </p>
|
|
5895
|
-
* <p>To list all of the available engine versions for
|
|
6050
|
+
* <p>To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:</p>
|
|
5896
6051
|
* <p>
|
|
5897
6052
|
* <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
5898
6053
|
* </p>
|
|
5899
|
-
* <p>To list all of the available engine versions for
|
|
6054
|
+
* <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p>
|
|
5900
6055
|
* <p>
|
|
5901
6056
|
* <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"</code>
|
|
5902
6057
|
* </p>
|
|
5903
|
-
* <
|
|
5904
|
-
*
|
|
5905
|
-
*
|
|
6058
|
+
* <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p>
|
|
6059
|
+
* <p>
|
|
6060
|
+
* <code>aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"</code>
|
|
6061
|
+
* </p>
|
|
6062
|
+
* <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p>
|
|
6063
|
+
* <p>
|
|
6064
|
+
* <code>aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"</code>
|
|
6065
|
+
* </p>
|
|
5906
6066
|
* <p>
|
|
5907
6067
|
* <b>Aurora MySQL</b>
|
|
5908
6068
|
* </p>
|
|
5909
|
-
* <p>
|
|
6069
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html">MySQL on Amazon RDS Versions</a> in the
|
|
6070
|
+
* <i>Amazon Aurora User Guide.</i>
|
|
5910
6071
|
* </p>
|
|
5911
6072
|
* <p>
|
|
5912
6073
|
* <b>Aurora PostgreSQL</b>
|
|
5913
6074
|
* </p>
|
|
5914
|
-
* <p>
|
|
6075
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html">Amazon Aurora PostgreSQL releases and engine versions</a> in the
|
|
6076
|
+
* <i>Amazon Aurora User Guide.</i>
|
|
6077
|
+
* </p>
|
|
6078
|
+
* <p>
|
|
6079
|
+
* <b>MySQL</b>
|
|
6080
|
+
* </p>
|
|
6081
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt">MySQL on Amazon RDS Versions</a> in the
|
|
6082
|
+
* <i>Amazon RDS User Guide.</i>
|
|
6083
|
+
* </p>
|
|
6084
|
+
* <p>
|
|
6085
|
+
* <b>PostgreSQL</b>
|
|
6086
|
+
* </p>
|
|
6087
|
+
* <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts">Amazon RDS for PostgreSQL versions and extensions</a> in the
|
|
6088
|
+
* <i>Amazon RDS User Guide.</i>
|
|
5915
6089
|
* </p>
|
|
6090
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5916
6091
|
*/
|
|
5917
6092
|
EngineVersion?: string;
|
|
5918
6093
|
/**
|
|
@@ -5920,6 +6095,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5920
6095
|
* <p>Constraints: This value must be <code>1150-65535</code>
|
|
5921
6096
|
* </p>
|
|
5922
6097
|
* <p>Default: The same port as the original DB cluster.</p>
|
|
6098
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5923
6099
|
*/
|
|
5924
6100
|
Port?: number;
|
|
5925
6101
|
/**
|
|
@@ -5927,22 +6103,27 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5927
6103
|
* <p>Constraints: If supplied, must match the name of an existing DB subnet group.</p>
|
|
5928
6104
|
* <p>Example: <code>mySubnetgroup</code>
|
|
5929
6105
|
* </p>
|
|
6106
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5930
6107
|
*/
|
|
5931
6108
|
DBSubnetGroupName?: string;
|
|
5932
6109
|
/**
|
|
5933
6110
|
* <p>The database name for the restored DB cluster.</p>
|
|
6111
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5934
6112
|
*/
|
|
5935
6113
|
DatabaseName?: string;
|
|
5936
6114
|
/**
|
|
5937
6115
|
* <p>The name of the option group to use for the restored DB cluster.</p>
|
|
6116
|
+
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
5938
6117
|
*/
|
|
5939
6118
|
OptionGroupName?: string;
|
|
5940
6119
|
/**
|
|
5941
6120
|
* <p>A list of VPC security groups that the new DB cluster will belong to.</p>
|
|
6121
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5942
6122
|
*/
|
|
5943
6123
|
VpcSecurityGroupIds?: string[];
|
|
5944
6124
|
/**
|
|
5945
6125
|
* <p>The tags to be assigned to the restored DB cluster.</p>
|
|
6126
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5946
6127
|
*/
|
|
5947
6128
|
Tags?: Tag[];
|
|
5948
6129
|
/**
|
|
@@ -5965,16 +6146,18 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5965
6146
|
* isn't encrypted.</p>
|
|
5966
6147
|
* </li>
|
|
5967
6148
|
* </ul>
|
|
6149
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
5968
6150
|
*/
|
|
5969
6151
|
KmsKeyId?: string;
|
|
5970
6152
|
/**
|
|
5971
6153
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
5972
|
-
* Management (IAM) accounts to database accounts. By default, mapping
|
|
5973
|
-
*
|
|
6154
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
6155
|
+
* enabled.</p>
|
|
5974
6156
|
* <p>For more information, see
|
|
5975
6157
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
5976
6158
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>
|
|
5977
6159
|
* </p>
|
|
6160
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
5978
6161
|
*/
|
|
5979
6162
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
5980
6163
|
/**
|
|
@@ -5990,13 +6173,15 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
5990
6173
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
5991
6174
|
* </li>
|
|
5992
6175
|
* </ul>
|
|
6176
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
5993
6177
|
*/
|
|
5994
6178
|
BacktrackWindow?: number;
|
|
5995
6179
|
/**
|
|
5996
6180
|
* <p>The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
|
5997
|
-
* The values in the list depend on the DB engine being used
|
|
5998
|
-
*
|
|
5999
|
-
*
|
|
6181
|
+
* The values in the list depend on the DB engine being used.</p>
|
|
6182
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon
|
|
6183
|
+
* Aurora User Guide</i>.</p>
|
|
6184
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6000
6185
|
*/
|
|
6001
6186
|
EnableCloudwatchLogsExports?: string[];
|
|
6002
6187
|
/**
|
|
@@ -6004,10 +6189,12 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
6004
6189
|
* <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p>
|
|
6005
6190
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html">
|
|
6006
6191
|
* CreateDBCluster</a>.</p>
|
|
6192
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6007
6193
|
*/
|
|
6008
6194
|
EngineMode?: string;
|
|
6009
6195
|
/**
|
|
6010
6196
|
* <p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>
|
|
6197
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6011
6198
|
*/
|
|
6012
6199
|
ScalingConfiguration?: ScalingConfiguration;
|
|
6013
6200
|
/**
|
|
@@ -6029,17 +6216,19 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
6029
6216
|
* <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
|
|
6030
6217
|
* </li>
|
|
6031
6218
|
* </ul>
|
|
6219
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6032
6220
|
*/
|
|
6033
6221
|
DBClusterParameterGroupName?: string;
|
|
6034
6222
|
/**
|
|
6035
6223
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
6036
6224
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6037
|
-
* deletion protection
|
|
6038
|
-
* </p>
|
|
6225
|
+
* deletion protection isn't enabled.</p>
|
|
6226
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6039
6227
|
*/
|
|
6040
6228
|
DeletionProtection?: boolean;
|
|
6041
6229
|
/**
|
|
6042
6230
|
* <p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p>
|
|
6231
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6043
6232
|
*/
|
|
6044
6233
|
CopyTagsToSnapshot?: boolean;
|
|
6045
6234
|
/**
|
|
@@ -6047,14 +6236,76 @@ export interface RestoreDBClusterFromSnapshotMessage {
|
|
|
6047
6236
|
* The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL
|
|
6048
6237
|
* Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.</p>
|
|
6049
6238
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html">
|
|
6050
|
-
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i
|
|
6051
|
-
*
|
|
6239
|
+
* Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
6240
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6052
6241
|
*/
|
|
6053
6242
|
Domain?: string;
|
|
6054
6243
|
/**
|
|
6055
6244
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
6245
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6056
6246
|
*/
|
|
6057
6247
|
DomainIAMRoleName?: string;
|
|
6248
|
+
/**
|
|
6249
|
+
* <p>The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
|
6250
|
+
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p>
|
|
6251
|
+
* <p>For the full list of DB instance classes, and availability for your engine, see
|
|
6252
|
+
* <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>
|
|
6253
|
+
* </p>
|
|
6254
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6255
|
+
*/
|
|
6256
|
+
DBClusterInstanceClass?: string;
|
|
6257
|
+
/**
|
|
6258
|
+
* <p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p>
|
|
6259
|
+
* <p>
|
|
6260
|
+
* Valid values: <code>io1</code>
|
|
6261
|
+
* </p>
|
|
6262
|
+
* <p>
|
|
6263
|
+
* When specified, a value for the <code>Iops</code> parameter is required.
|
|
6264
|
+
* </p>
|
|
6265
|
+
* <p>
|
|
6266
|
+
* Default: <code>io1</code>
|
|
6267
|
+
* </p>
|
|
6268
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6269
|
+
*/
|
|
6270
|
+
StorageType?: string;
|
|
6271
|
+
/**
|
|
6272
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for
|
|
6273
|
+
* each DB instance in the Multi-AZ DB cluster.</p>
|
|
6274
|
+
* <p>For information about valid Iops values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>.
|
|
6275
|
+
* </p>
|
|
6276
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.</p>
|
|
6277
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6278
|
+
*/
|
|
6279
|
+
Iops?: number;
|
|
6280
|
+
/**
|
|
6281
|
+
* <p>A value that indicates whether the DB cluster is publicly accessible.</p>
|
|
6282
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
6283
|
+
* from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC.
|
|
6284
|
+
* Access to the DB cluster is ultimately controlled by the security group it uses.
|
|
6285
|
+
* That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.</p>
|
|
6286
|
+
* <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>
|
|
6287
|
+
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
|
|
6288
|
+
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6289
|
+
* <ul>
|
|
6290
|
+
* <li>
|
|
6291
|
+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6292
|
+
* </li>
|
|
6293
|
+
* <li>
|
|
6294
|
+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6295
|
+
* </li>
|
|
6296
|
+
* </ul>
|
|
6297
|
+
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6298
|
+
* <ul>
|
|
6299
|
+
* <li>
|
|
6300
|
+
* <p>If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6301
|
+
* </li>
|
|
6302
|
+
* <li>
|
|
6303
|
+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6304
|
+
* </li>
|
|
6305
|
+
* </ul>
|
|
6306
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6307
|
+
*/
|
|
6308
|
+
PubliclyAccessible?: boolean;
|
|
6058
6309
|
}
|
|
6059
6310
|
export declare namespace RestoreDBClusterFromSnapshotMessage {
|
|
6060
6311
|
/**
|
|
@@ -6064,11 +6315,28 @@ export declare namespace RestoreDBClusterFromSnapshotMessage {
|
|
|
6064
6315
|
}
|
|
6065
6316
|
export interface RestoreDBClusterFromSnapshotResult {
|
|
6066
6317
|
/**
|
|
6067
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
6068
|
-
* </p>
|
|
6069
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
6070
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
6318
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
6071
6319
|
* </p>
|
|
6320
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
6321
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6322
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
6323
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
6324
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
6325
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
6326
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6327
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
6328
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
6329
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
6330
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
6331
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6332
|
+
* </p>
|
|
6333
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
6334
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
6335
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
6336
|
+
* </p>
|
|
6337
|
+
* <note>
|
|
6338
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
6339
|
+
* </note>
|
|
6072
6340
|
*/
|
|
6073
6341
|
DBCluster?: DBCluster;
|
|
6074
6342
|
}
|
|
@@ -6096,6 +6364,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6096
6364
|
* <p>Can't end with a hyphen or contain two consecutive hyphens</p>
|
|
6097
6365
|
* </li>
|
|
6098
6366
|
* </ul>
|
|
6367
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6099
6368
|
*/
|
|
6100
6369
|
DBClusterIdentifier: string | undefined;
|
|
6101
6370
|
/**
|
|
@@ -6115,6 +6384,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6115
6384
|
* <p>Constraints: You can't specify <code>copy-on-write</code> if the engine version of the source DB cluster is earlier than 1.11.</p>
|
|
6116
6385
|
* <p>If you don't specify a <code>RestoreType</code> value, then the new DB cluster is
|
|
6117
6386
|
* restored as a full copy of the source DB cluster.</p>
|
|
6387
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6118
6388
|
*/
|
|
6119
6389
|
RestoreType?: string;
|
|
6120
6390
|
/**
|
|
@@ -6125,6 +6395,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6125
6395
|
* <p>Must match the identifier of an existing DBCluster.</p>
|
|
6126
6396
|
* </li>
|
|
6127
6397
|
* </ul>
|
|
6398
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6128
6399
|
*/
|
|
6129
6400
|
SourceDBClusterIdentifier: string | undefined;
|
|
6130
6401
|
/**
|
|
@@ -6148,6 +6419,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6148
6419
|
* </ul>
|
|
6149
6420
|
* <p>Example: <code>2015-03-07T23:45:00Z</code>
|
|
6150
6421
|
* </p>
|
|
6422
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6151
6423
|
*/
|
|
6152
6424
|
RestoreToTime?: Date;
|
|
6153
6425
|
/**
|
|
@@ -6156,6 +6428,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6156
6428
|
* restorable backup time.
|
|
6157
6429
|
* </p>
|
|
6158
6430
|
* <p>Constraints: Can't be specified if <code>RestoreToTime</code> parameter is provided.</p>
|
|
6431
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6159
6432
|
*/
|
|
6160
6433
|
UseLatestRestorableTime?: boolean;
|
|
6161
6434
|
/**
|
|
@@ -6163,6 +6436,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6163
6436
|
* <p>Constraints: A value from <code>1150-65535</code>.
|
|
6164
6437
|
* </p>
|
|
6165
6438
|
* <p>Default: The default port for the engine.</p>
|
|
6439
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6166
6440
|
*/
|
|
6167
6441
|
Port?: number;
|
|
6168
6442
|
/**
|
|
@@ -6170,14 +6444,17 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6170
6444
|
* <p>Constraints: If supplied, must match the name of an existing DBSubnetGroup.</p>
|
|
6171
6445
|
* <p>Example: <code>mySubnetgroup</code>
|
|
6172
6446
|
* </p>
|
|
6447
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6173
6448
|
*/
|
|
6174
6449
|
DBSubnetGroupName?: string;
|
|
6175
6450
|
/**
|
|
6176
6451
|
* <p>The name of the option group for the new DB cluster.</p>
|
|
6452
|
+
* <p>DB clusters are associated with a default option group that can't be modified.</p>
|
|
6177
6453
|
*/
|
|
6178
6454
|
OptionGroupName?: string;
|
|
6179
6455
|
/**
|
|
6180
6456
|
* <p>A list of VPC security groups that the new DB cluster belongs to.</p>
|
|
6457
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6181
6458
|
*/
|
|
6182
6459
|
VpcSecurityGroupIds?: string[];
|
|
6183
6460
|
/**
|
|
@@ -6202,27 +6479,25 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6202
6479
|
* <p>If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.</p>
|
|
6203
6480
|
* </li>
|
|
6204
6481
|
* </ul>
|
|
6205
|
-
*
|
|
6206
6482
|
* <p>If <code>DBClusterIdentifier</code> refers to a DB cluster that isn't encrypted, then the restore request
|
|
6207
6483
|
* is rejected.</p>
|
|
6484
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6208
6485
|
*/
|
|
6209
6486
|
KmsKeyId?: string;
|
|
6210
6487
|
/**
|
|
6211
6488
|
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
6212
|
-
* Management (IAM) accounts to database accounts. By default, mapping
|
|
6213
|
-
*
|
|
6489
|
+
* Management (IAM) accounts to database accounts. By default, mapping isn't
|
|
6490
|
+
* enabled.</p>
|
|
6214
6491
|
* <p>For more information, see
|
|
6215
6492
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
6216
6493
|
* IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6217
6494
|
* </p>
|
|
6495
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6218
6496
|
*/
|
|
6219
6497
|
EnableIAMDatabaseAuthentication?: boolean;
|
|
6220
6498
|
/**
|
|
6221
6499
|
* <p>The target backtrack window, in seconds. To disable backtracking, set this value to
|
|
6222
6500
|
* 0.</p>
|
|
6223
|
-
* <note>
|
|
6224
|
-
* <p>Currently, Backtrack is only supported for Aurora MySQL DB clusters.</p>
|
|
6225
|
-
* </note>
|
|
6226
6501
|
* <p>Default: 0</p>
|
|
6227
6502
|
* <p>Constraints:</p>
|
|
6228
6503
|
* <ul>
|
|
@@ -6230,12 +6505,14 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6230
6505
|
* <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p>
|
|
6231
6506
|
* </li>
|
|
6232
6507
|
* </ul>
|
|
6508
|
+
* <p>Valid for: Aurora MySQL DB clusters only</p>
|
|
6233
6509
|
*/
|
|
6234
6510
|
BacktrackWindow?: number;
|
|
6235
6511
|
/**
|
|
6236
6512
|
* <p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values
|
|
6237
|
-
* in the list depend on the DB engine being used
|
|
6238
|
-
*
|
|
6513
|
+
* in the list depend on the DB engine being used.</p>
|
|
6514
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
6515
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6239
6516
|
*/
|
|
6240
6517
|
EnableCloudwatchLogsExports?: string[];
|
|
6241
6518
|
/**
|
|
@@ -6256,17 +6533,19 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6256
6533
|
* <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
|
|
6257
6534
|
* </li>
|
|
6258
6535
|
* </ul>
|
|
6536
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6259
6537
|
*/
|
|
6260
6538
|
DBClusterParameterGroupName?: string;
|
|
6261
6539
|
/**
|
|
6262
6540
|
* <p>A value that indicates whether the DB cluster has deletion protection enabled.
|
|
6263
6541
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6264
|
-
* deletion protection
|
|
6265
|
-
* </p>
|
|
6542
|
+
* deletion protection isn't enabled.</p>
|
|
6543
|
+
* <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
|
|
6266
6544
|
*/
|
|
6267
6545
|
DeletionProtection?: boolean;
|
|
6268
6546
|
/**
|
|
6269
6547
|
* <p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p>
|
|
6548
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6270
6549
|
*/
|
|
6271
6550
|
CopyTagsToSnapshot?: boolean;
|
|
6272
6551
|
/**
|
|
@@ -6278,14 +6557,17 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6278
6557
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html">Kerberos Authentication</a>
|
|
6279
6558
|
* in the <i>Amazon Aurora User Guide</i>.
|
|
6280
6559
|
* </p>
|
|
6560
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6281
6561
|
*/
|
|
6282
6562
|
Domain?: string;
|
|
6283
6563
|
/**
|
|
6284
6564
|
* <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
|
|
6565
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6285
6566
|
*/
|
|
6286
6567
|
DomainIAMRoleName?: string;
|
|
6287
6568
|
/**
|
|
6288
6569
|
* <p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>
|
|
6570
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6289
6571
|
*/
|
|
6290
6572
|
ScalingConfiguration?: ScalingConfiguration;
|
|
6291
6573
|
/**
|
|
@@ -6294,8 +6576,72 @@ export interface RestoreDBClusterToPointInTimeMessage {
|
|
|
6294
6576
|
* from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone
|
|
6295
6577
|
* that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or
|
|
6296
6578
|
* an encrypted provisioned cluster.</p>
|
|
6579
|
+
* <p>Valid for: Aurora DB clusters only</p>
|
|
6297
6580
|
*/
|
|
6298
6581
|
EngineMode?: string;
|
|
6582
|
+
/**
|
|
6583
|
+
* <p>The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,
|
|
6584
|
+
* for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services
|
|
6585
|
+
* Regions, or for all database engines.</p>
|
|
6586
|
+
* <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>
|
|
6587
|
+
* </p>
|
|
6588
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6589
|
+
*/
|
|
6590
|
+
DBClusterInstanceClass?: string;
|
|
6591
|
+
/**
|
|
6592
|
+
* <p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p>
|
|
6593
|
+
* <p>
|
|
6594
|
+
* Valid values: <code>io1</code>
|
|
6595
|
+
* </p>
|
|
6596
|
+
* <p>
|
|
6597
|
+
* When specified, a value for the <code>Iops</code> parameter is required.
|
|
6598
|
+
* </p>
|
|
6599
|
+
* <p>
|
|
6600
|
+
* Default: <code>io1</code>
|
|
6601
|
+
* </p>
|
|
6602
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6603
|
+
*/
|
|
6604
|
+
StorageType?: string;
|
|
6605
|
+
/**
|
|
6606
|
+
* <p>A value that indicates whether the DB cluster is publicly accessible.</p>
|
|
6607
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
6608
|
+
* from within the DB cluster's virtual private cloud (VPC). It resolves
|
|
6609
|
+
* to the public IP address from outside of the DB cluster's VPC.
|
|
6610
|
+
* Access to the DB cluster is ultimately controlled by the security group it uses.
|
|
6611
|
+
* That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.</p>
|
|
6612
|
+
* <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>
|
|
6613
|
+
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
|
|
6614
|
+
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6615
|
+
* <ul>
|
|
6616
|
+
* <li>
|
|
6617
|
+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6618
|
+
* </li>
|
|
6619
|
+
* <li>
|
|
6620
|
+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6621
|
+
* </li>
|
|
6622
|
+
* </ul>
|
|
6623
|
+
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
|
|
6624
|
+
* <ul>
|
|
6625
|
+
* <li>
|
|
6626
|
+
* <p>If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
|
|
6627
|
+
* </li>
|
|
6628
|
+
* <li>
|
|
6629
|
+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.</p>
|
|
6630
|
+
* </li>
|
|
6631
|
+
* </ul>
|
|
6632
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6633
|
+
*/
|
|
6634
|
+
PubliclyAccessible?: boolean;
|
|
6635
|
+
/**
|
|
6636
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for
|
|
6637
|
+
* each DB instance in the Multi-AZ DB cluster.</p>
|
|
6638
|
+
* <p>For information about valid <code>Iops</code> values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS">Amazon RDS Provisioned IOPS storage to improve performance</a> in the <i>Amazon RDS User Guide</i>.
|
|
6639
|
+
* </p>
|
|
6640
|
+
* <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
|
|
6641
|
+
* </p>
|
|
6642
|
+
* <p>Valid for: Multi-AZ DB clusters only</p>
|
|
6643
|
+
*/
|
|
6644
|
+
Iops?: number;
|
|
6299
6645
|
}
|
|
6300
6646
|
export declare namespace RestoreDBClusterToPointInTimeMessage {
|
|
6301
6647
|
/**
|
|
@@ -6305,11 +6651,28 @@ export declare namespace RestoreDBClusterToPointInTimeMessage {
|
|
|
6305
6651
|
}
|
|
6306
6652
|
export interface RestoreDBClusterToPointInTimeResult {
|
|
6307
6653
|
/**
|
|
6308
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
6309
|
-
* </p>
|
|
6310
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
6311
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
6654
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
6312
6655
|
* </p>
|
|
6656
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
6657
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6658
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
6659
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
6660
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
6661
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
6662
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
6663
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
6664
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
6665
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
6666
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
6667
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
6668
|
+
* </p>
|
|
6669
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
6670
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
6671
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
6672
|
+
* </p>
|
|
6673
|
+
* <note>
|
|
6674
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
6675
|
+
* </note>
|
|
6313
6676
|
*/
|
|
6314
6677
|
DBCluster?: DBCluster;
|
|
6315
6678
|
}
|
|
@@ -6356,7 +6719,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6356
6719
|
*/
|
|
6357
6720
|
DBSnapshotIdentifier: string | undefined;
|
|
6358
6721
|
/**
|
|
6359
|
-
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
6722
|
+
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.
|
|
6360
6723
|
* Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
|
|
6361
6724
|
* For the full list of DB instance classes,
|
|
6362
6725
|
* and availability for your engine, see
|
|
@@ -6395,9 +6758,10 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6395
6758
|
MultiAZ?: boolean;
|
|
6396
6759
|
/**
|
|
6397
6760
|
* <p>A value that indicates whether the DB instance is publicly accessible.</p>
|
|
6398
|
-
* <p>When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address
|
|
6399
|
-
*
|
|
6400
|
-
*
|
|
6761
|
+
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
6762
|
+
* from within the DB instance's virtual private cloud (VPC).
|
|
6763
|
+
* It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled
|
|
6764
|
+
* by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
|
|
6401
6765
|
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
|
|
6402
6766
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
6403
6767
|
*/
|
|
@@ -6624,7 +6988,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6624
6988
|
/**
|
|
6625
6989
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
6626
6990
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
6627
|
-
* deletion protection
|
|
6991
|
+
* deletion protection isn't enabled. For more information, see
|
|
6628
6992
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
6629
6993
|
* Deleting a DB Instance</a>.
|
|
6630
6994
|
* </p>
|
|
@@ -6664,6 +7028,13 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6664
7028
|
* <p>This setting is required for RDS Custom.</p>
|
|
6665
7029
|
*/
|
|
6666
7030
|
CustomIamInstanceProfile?: string;
|
|
7031
|
+
/**
|
|
7032
|
+
* <p>Specifies where automated backups and manual snapshots are stored for the restored DB instance.</p>
|
|
7033
|
+
* <p>Possible values are <code>outposts</code> (Amazon Web Services Outposts) and <code>region</code> (Amazon Web Services Region). The default is <code>region</code>.</p>
|
|
7034
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working
|
|
7035
|
+
* with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
7036
|
+
*/
|
|
7037
|
+
BackupTarget?: string;
|
|
6667
7038
|
}
|
|
6668
7039
|
export declare namespace RestoreDBInstanceFromDBSnapshotMessage {
|
|
6669
7040
|
/**
|
|
@@ -6675,7 +7046,11 @@ export interface RestoreDBInstanceFromDBSnapshotResult {
|
|
|
6675
7046
|
/**
|
|
6676
7047
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
6677
7048
|
* </p>
|
|
6678
|
-
* <p>This data type is used as a response element in the <code>
|
|
7049
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
7050
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
7051
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
7052
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
7053
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
6679
7054
|
* </p>
|
|
6680
7055
|
*/
|
|
6681
7056
|
DBInstance?: DBInstance;
|
|
@@ -6730,7 +7105,7 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6730
7105
|
AllocatedStorage?: number;
|
|
6731
7106
|
/**
|
|
6732
7107
|
* <p>The compute and memory capacity of the DB instance,
|
|
6733
|
-
* for example
|
|
7108
|
+
* for example db.m4.large.
|
|
6734
7109
|
* Not all DB instance classes are available in all Amazon Web Services Regions,
|
|
6735
7110
|
* or for all database engines.
|
|
6736
7111
|
* For the full list of DB instance classes,
|
|
@@ -6919,9 +7294,11 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6919
7294
|
OptionGroupName?: string;
|
|
6920
7295
|
/**
|
|
6921
7296
|
* <p>A value that indicates whether the DB instance is publicly accessible.</p>
|
|
6922
|
-
* <p>When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address
|
|
6923
|
-
*
|
|
6924
|
-
*
|
|
7297
|
+
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address
|
|
7298
|
+
* from within the DB instance's virtual private cloud (VPC).
|
|
7299
|
+
* It resolves to the public IP address from outside of the DB instance's VPC.
|
|
7300
|
+
* Access to the DB instance is ultimately controlled by the security group it uses.
|
|
7301
|
+
* That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
|
|
6925
7302
|
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
|
|
6926
7303
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
6927
7304
|
*/
|
|
@@ -6998,8 +7375,8 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6998
7375
|
*/
|
|
6999
7376
|
MonitoringRoleArn?: string;
|
|
7000
7377
|
/**
|
|
7001
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
7002
|
-
*
|
|
7378
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
7379
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
7003
7380
|
*
|
|
7004
7381
|
* <p>For more information about IAM database authentication, see
|
|
7005
7382
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html">
|
|
@@ -7078,7 +7455,7 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
7078
7455
|
/**
|
|
7079
7456
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
7080
7457
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
7081
|
-
* deletion protection
|
|
7458
|
+
* deletion protection isn't enabled. For more information, see
|
|
7082
7459
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
7083
7460
|
* Deleting a DB Instance</a>.
|
|
7084
7461
|
* </p>
|
|
@@ -7103,7 +7480,11 @@ export interface RestoreDBInstanceFromS3Result {
|
|
|
7103
7480
|
/**
|
|
7104
7481
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7105
7482
|
* </p>
|
|
7106
|
-
* <p>This data type is used as a response element in the <code>
|
|
7483
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
7484
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
7485
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
7486
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
7487
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7107
7488
|
* </p>
|
|
7108
7489
|
*/
|
|
7109
7490
|
DBInstance?: DBInstance;
|
|
@@ -7126,12 +7507,6 @@ export interface PointInTimeRestoreNotEnabledFault extends __SmithyException, $M
|
|
|
7126
7507
|
$fault: "client";
|
|
7127
7508
|
message?: string;
|
|
7128
7509
|
}
|
|
7129
|
-
export declare namespace PointInTimeRestoreNotEnabledFault {
|
|
7130
|
-
/**
|
|
7131
|
-
* @internal
|
|
7132
|
-
*/
|
|
7133
|
-
const filterSensitiveLog: (obj: PointInTimeRestoreNotEnabledFault) => any;
|
|
7134
|
-
}
|
|
7135
7510
|
/**
|
|
7136
7511
|
* <p></p>
|
|
7137
7512
|
*/
|
|
@@ -7187,12 +7562,12 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7187
7562
|
*/
|
|
7188
7563
|
UseLatestRestorableTime?: boolean;
|
|
7189
7564
|
/**
|
|
7190
|
-
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
7191
|
-
*
|
|
7192
|
-
*
|
|
7193
|
-
*
|
|
7194
|
-
*
|
|
7195
|
-
*
|
|
7565
|
+
* <p>The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
7566
|
+
* db.m4.large. Not all DB instance classes are available in all Amazon Web Services
|
|
7567
|
+
* Regions, or for all database engines. For the full list of DB instance classes, and
|
|
7568
|
+
* availability for your engine, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html">DB Instance
|
|
7569
|
+
* Class</a> in the <i>Amazon RDS User Guide.</i>
|
|
7570
|
+
* </p>
|
|
7196
7571
|
* <p>Default: The same DBInstanceClass as the original DB instance.</p>
|
|
7197
7572
|
*/
|
|
7198
7573
|
DBInstanceClass?: string;
|
|
@@ -7227,9 +7602,12 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7227
7602
|
MultiAZ?: boolean;
|
|
7228
7603
|
/**
|
|
7229
7604
|
* <p>A value that indicates whether the DB instance is publicly accessible.</p>
|
|
7230
|
-
* <p>When the DB
|
|
7231
|
-
*
|
|
7232
|
-
*
|
|
7605
|
+
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
|
|
7606
|
+
* resolves to the private IP address from within the DB cluster's virtual private cloud
|
|
7607
|
+
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
|
|
7608
|
+
* to the DB cluster is ultimately controlled by the security group it uses. That public
|
|
7609
|
+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
|
|
7610
|
+
* it.</p>
|
|
7233
7611
|
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
|
|
7234
7612
|
* <p>For more information, see <a>CreateDBInstance</a>.</p>
|
|
7235
7613
|
*/
|
|
@@ -7399,8 +7777,8 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7399
7777
|
*/
|
|
7400
7778
|
DomainIAMRoleName?: string;
|
|
7401
7779
|
/**
|
|
7402
|
-
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access
|
|
7403
|
-
*
|
|
7780
|
+
* <p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
|
|
7781
|
+
* (IAM) accounts to database accounts. By default, mapping isn't enabled.</p>
|
|
7404
7782
|
*
|
|
7405
7783
|
* <p>This setting doesn't apply to RDS Custom.</p>
|
|
7406
7784
|
*
|
|
@@ -7452,7 +7830,7 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7452
7830
|
/**
|
|
7453
7831
|
* <p>A value that indicates whether the DB instance has deletion protection enabled.
|
|
7454
7832
|
* The database can't be deleted when deletion protection is enabled. By default,
|
|
7455
|
-
* deletion protection
|
|
7833
|
+
* deletion protection isn't enabled. For more information, see
|
|
7456
7834
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html">
|
|
7457
7835
|
* Deleting a DB Instance</a>.
|
|
7458
7836
|
* </p>
|
|
@@ -7511,6 +7889,13 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7511
7889
|
* <p>This setting is required for RDS Custom.</p>
|
|
7512
7890
|
*/
|
|
7513
7891
|
CustomIamInstanceProfile?: string;
|
|
7892
|
+
/**
|
|
7893
|
+
* <p>Specifies where automated backups and manual snapshots are stored for the restored DB instance.</p>
|
|
7894
|
+
* <p>Possible values are <code>outposts</code> (Amazon Web Services Outposts) and <code>region</code> (Amazon Web Services Region). The default is <code>region</code>.</p>
|
|
7895
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working
|
|
7896
|
+
* with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
7897
|
+
*/
|
|
7898
|
+
BackupTarget?: string;
|
|
7514
7899
|
}
|
|
7515
7900
|
export declare namespace RestoreDBInstanceToPointInTimeMessage {
|
|
7516
7901
|
/**
|
|
@@ -7522,7 +7907,11 @@ export interface RestoreDBInstanceToPointInTimeResult {
|
|
|
7522
7907
|
/**
|
|
7523
7908
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7524
7909
|
* </p>
|
|
7525
|
-
* <p>This data type is used as a response element in the <code>
|
|
7910
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
7911
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
7912
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
7913
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
7914
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7526
7915
|
* </p>
|
|
7527
7916
|
*/
|
|
7528
7917
|
DBInstance?: DBInstance;
|
|
@@ -7682,11 +8071,28 @@ export declare namespace StartDBClusterMessage {
|
|
|
7682
8071
|
}
|
|
7683
8072
|
export interface StartDBClusterResult {
|
|
7684
8073
|
/**
|
|
7685
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
7686
|
-
* </p>
|
|
7687
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
7688
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
8074
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
7689
8075
|
* </p>
|
|
8076
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
8077
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8078
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
8079
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
8080
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
8081
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
8082
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8083
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
8084
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
8085
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
8086
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
8087
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
8088
|
+
* </p>
|
|
8089
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
8090
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
8091
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
8092
|
+
* </p>
|
|
8093
|
+
* <note>
|
|
8094
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
8095
|
+
* </note>
|
|
7690
8096
|
*/
|
|
7691
8097
|
DBCluster?: DBCluster;
|
|
7692
8098
|
}
|
|
@@ -7714,7 +8120,11 @@ export interface StartDBInstanceResult {
|
|
|
7714
8120
|
/**
|
|
7715
8121
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
7716
8122
|
* </p>
|
|
7717
|
-
* <p>This data type is used as a response element in the <code>
|
|
8123
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
8124
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
8125
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
8126
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
8127
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
7718
8128
|
* </p>
|
|
7719
8129
|
*/
|
|
7720
8130
|
DBInstance?: DBInstance;
|
|
@@ -7776,12 +8186,6 @@ export interface ExportTaskAlreadyExistsFault extends __SmithyException, $Metada
|
|
|
7776
8186
|
$fault: "client";
|
|
7777
8187
|
message?: string;
|
|
7778
8188
|
}
|
|
7779
|
-
export declare namespace ExportTaskAlreadyExistsFault {
|
|
7780
|
-
/**
|
|
7781
|
-
* @internal
|
|
7782
|
-
*/
|
|
7783
|
-
const filterSensitiveLog: (obj: ExportTaskAlreadyExistsFault) => any;
|
|
7784
|
-
}
|
|
7785
8189
|
/**
|
|
7786
8190
|
* <p>The IAM role requires additional permissions to export to an Amazon S3 bucket.</p>
|
|
7787
8191
|
*/
|
|
@@ -7790,12 +8194,6 @@ export interface IamRoleMissingPermissionsFault extends __SmithyException, $Meta
|
|
|
7790
8194
|
$fault: "client";
|
|
7791
8195
|
message?: string;
|
|
7792
8196
|
}
|
|
7793
|
-
export declare namespace IamRoleMissingPermissionsFault {
|
|
7794
|
-
/**
|
|
7795
|
-
* @internal
|
|
7796
|
-
*/
|
|
7797
|
-
const filterSensitiveLog: (obj: IamRoleMissingPermissionsFault) => any;
|
|
7798
|
-
}
|
|
7799
8197
|
/**
|
|
7800
8198
|
* <p>The IAM role is missing for exporting to an Amazon S3 bucket.</p>
|
|
7801
8199
|
*/
|
|
@@ -7804,12 +8202,6 @@ export interface IamRoleNotFoundFault extends __SmithyException, $MetadataBearer
|
|
|
7804
8202
|
$fault: "client";
|
|
7805
8203
|
message?: string;
|
|
7806
8204
|
}
|
|
7807
|
-
export declare namespace IamRoleNotFoundFault {
|
|
7808
|
-
/**
|
|
7809
|
-
* @internal
|
|
7810
|
-
*/
|
|
7811
|
-
const filterSensitiveLog: (obj: IamRoleNotFoundFault) => any;
|
|
7812
|
-
}
|
|
7813
8205
|
/**
|
|
7814
8206
|
* <p>The export is invalid for exporting to an Amazon S3 bucket.</p>
|
|
7815
8207
|
*/
|
|
@@ -7818,12 +8210,6 @@ export interface InvalidExportOnlyFault extends __SmithyException, $MetadataBear
|
|
|
7818
8210
|
$fault: "client";
|
|
7819
8211
|
message?: string;
|
|
7820
8212
|
}
|
|
7821
|
-
export declare namespace InvalidExportOnlyFault {
|
|
7822
|
-
/**
|
|
7823
|
-
* @internal
|
|
7824
|
-
*/
|
|
7825
|
-
const filterSensitiveLog: (obj: InvalidExportOnlyFault) => any;
|
|
7826
|
-
}
|
|
7827
8213
|
/**
|
|
7828
8214
|
* <p>The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.</p>
|
|
7829
8215
|
*/
|
|
@@ -7832,12 +8218,6 @@ export interface InvalidExportSourceStateFault extends __SmithyException, $Metad
|
|
|
7832
8218
|
$fault: "client";
|
|
7833
8219
|
message?: string;
|
|
7834
8220
|
}
|
|
7835
|
-
export declare namespace InvalidExportSourceStateFault {
|
|
7836
|
-
/**
|
|
7837
|
-
* @internal
|
|
7838
|
-
*/
|
|
7839
|
-
const filterSensitiveLog: (obj: InvalidExportSourceStateFault) => any;
|
|
7840
|
-
}
|
|
7841
8221
|
export interface StartExportTaskMessage {
|
|
7842
8222
|
/**
|
|
7843
8223
|
* <p>A unique identifier for the snapshot export task. This ID isn't an identifier for
|
|
@@ -7989,11 +8369,28 @@ export declare namespace StopDBClusterMessage {
|
|
|
7989
8369
|
}
|
|
7990
8370
|
export interface StopDBClusterResult {
|
|
7991
8371
|
/**
|
|
7992
|
-
* <p>Contains the details of an Amazon Aurora DB cluster.
|
|
7993
|
-
* </p>
|
|
7994
|
-
* <p>This data type is used as a response element in the <code>DescribeDBClusters</code>,
|
|
7995
|
-
* <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions.
|
|
8372
|
+
* <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
|
7996
8373
|
* </p>
|
|
8374
|
+
* <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
|
|
8375
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8376
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>,
|
|
8377
|
+
* <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>,
|
|
8378
|
+
* <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p>
|
|
8379
|
+
* <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations
|
|
8380
|
+
* <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>,
|
|
8381
|
+
* <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>,
|
|
8382
|
+
* <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
8383
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
8384
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
8385
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
8386
|
+
* </p>
|
|
8387
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
8388
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
8389
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
8390
|
+
* </p>
|
|
8391
|
+
* <note>
|
|
8392
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
8393
|
+
* </note>
|
|
7997
8394
|
*/
|
|
7998
8395
|
DBCluster?: DBCluster;
|
|
7999
8396
|
}
|
|
@@ -8027,7 +8424,11 @@ export interface StopDBInstanceResult {
|
|
|
8027
8424
|
/**
|
|
8028
8425
|
* <p>Contains the details of an Amazon RDS DB instance.
|
|
8029
8426
|
* </p>
|
|
8030
|
-
* <p>This data type is used as a response element in the <code>
|
|
8427
|
+
* <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
|
|
8428
|
+
* <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
|
|
8429
|
+
* <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
|
|
8430
|
+
* <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
|
|
8431
|
+
* <code>StartDBInstance</code>, and <code>StopDBInstance</code>.
|
|
8031
8432
|
* </p>
|
|
8032
8433
|
*/
|
|
8033
8434
|
DBInstance?: DBInstance;
|