@aws-sdk/client-rds 3.395.0 → 3.397.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/README.md +8 -0
- package/dist-cjs/RDS.js +2 -0
- package/dist-cjs/commands/SwitchoverGlobalClusterCommand.js +46 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +5 -1
- package/dist-cjs/protocols/Aws_query.js +92 -4
- package/dist-es/RDS.js +2 -0
- package/dist-es/commands/SwitchoverGlobalClusterCommand.js +42 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_query.js +86 -0
- package/dist-types/RDS.d.ts +7 -0
- package/dist-types/RDSClient.d.ts +3 -2
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +2 -0
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +2 -0
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +2 -0
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +2 -0
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +38 -11
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +3 -1
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +2 -0
- package/dist-types/commands/SwitchoverGlobalClusterCommand.d.ts +124 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +56 -245
- package/dist-types/models/models_1.d.ts +286 -8
- package/dist-types/protocols/Aws_query.d.ts +9 -0
- package/dist-types/ts3.4/RDS.d.ts +17 -0
- package/dist-types/ts3.4/RDSClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/DescribeDBEngineVersionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SwitchoverGlobalClusterCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +10 -12
- package/dist-types/ts3.4/models/models_1.d.ts +21 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +12 -0
- package/package.json +1 -1
|
@@ -3043,6 +3043,16 @@ export interface CreateCustomDBEngineVersionMessage {
|
|
|
3043
3043
|
* </p>
|
|
3044
3044
|
*/
|
|
3045
3045
|
Tags?: Tag[];
|
|
3046
|
+
/**
|
|
3047
|
+
* @public
|
|
3048
|
+
* <p>Reserved for future use.</p>
|
|
3049
|
+
*/
|
|
3050
|
+
SourceCustomDbEngineVersionIdentifier?: string;
|
|
3051
|
+
/**
|
|
3052
|
+
* @public
|
|
3053
|
+
* <p>Reserved for future use.</p>
|
|
3054
|
+
*/
|
|
3055
|
+
UseAwsProvidedLatestImage?: boolean;
|
|
3046
3056
|
}
|
|
3047
3057
|
/**
|
|
3048
3058
|
* @public
|
|
@@ -4016,6 +4026,10 @@ export interface CreateDBClusterMessage {
|
|
|
4016
4026
|
* </p>
|
|
4017
4027
|
* </li>
|
|
4018
4028
|
* </ul>
|
|
4029
|
+
* <note>
|
|
4030
|
+
* <p>When you create an Aurora DB cluster with the storage type set to <code>aurora-iopt1</code>, the storage type is returned
|
|
4031
|
+
* in the response. The storage type isn't returned when you set it to <code>aurora</code>.</p>
|
|
4032
|
+
* </note>
|
|
4019
4033
|
*/
|
|
4020
4034
|
StorageType?: string;
|
|
4021
4035
|
/**
|
|
@@ -9730,26 +9744,26 @@ export declare const FailoverStatus: {
|
|
|
9730
9744
|
export type FailoverStatus = (typeof FailoverStatus)[keyof typeof FailoverStatus];
|
|
9731
9745
|
/**
|
|
9732
9746
|
* @public
|
|
9733
|
-
* <p>Contains the state of scheduled or in-process
|
|
9734
|
-
*
|
|
9735
|
-
*
|
|
9747
|
+
* <p>Contains the state of scheduled or in-process operations on a
|
|
9748
|
+
* global cluster (Aurora global database). This data type is empty unless a switchover
|
|
9749
|
+
* or failover operation is scheduled or is in progress on the Aurora global database.</p>
|
|
9736
9750
|
*/
|
|
9737
9751
|
export interface FailoverState {
|
|
9738
9752
|
/**
|
|
9739
9753
|
* @public
|
|
9740
|
-
* <p>The current status of the
|
|
9754
|
+
* <p>The current status of the global cluster. Possible values are as follows:</p>
|
|
9741
9755
|
* <ul>
|
|
9742
9756
|
* <li>
|
|
9743
|
-
* <p>pending
|
|
9744
|
-
*
|
|
9745
|
-
*
|
|
9757
|
+
* <p>pending The service received a request to switch over or fail over the global cluster. The
|
|
9758
|
+
* global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation
|
|
9759
|
+
* starts.</p>
|
|
9746
9760
|
* </li>
|
|
9747
9761
|
* <li>
|
|
9748
|
-
* <p>failing-over This status covers the range of Aurora internal operations that take place during the failover process, such
|
|
9749
|
-
* as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.</p>
|
|
9762
|
+
* <p>failing-over This status covers the range of Aurora internal operations that take place during the switchover or failover process, such
|
|
9763
|
+
* as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.</p>
|
|
9750
9764
|
* </li>
|
|
9751
9765
|
* <li>
|
|
9752
|
-
* <p>cancelling The request to fail over the
|
|
9766
|
+
* <p>cancelling The request to switch over or fail over the global cluster was cancelled and the primary
|
|
9753
9767
|
* Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.</p>
|
|
9754
9768
|
* </li>
|
|
9755
9769
|
* </ul>
|
|
@@ -9767,37 +9781,60 @@ export interface FailoverState {
|
|
|
9767
9781
|
* with this state.</p>
|
|
9768
9782
|
*/
|
|
9769
9783
|
ToDbClusterArn?: string;
|
|
9784
|
+
/**
|
|
9785
|
+
* @public
|
|
9786
|
+
* <p>Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover.
|
|
9787
|
+
* Otherwise, it's a switchover.</p>
|
|
9788
|
+
*/
|
|
9789
|
+
IsDataLossAllowed?: boolean;
|
|
9770
9790
|
}
|
|
9791
|
+
/**
|
|
9792
|
+
* @public
|
|
9793
|
+
* @enum
|
|
9794
|
+
*/
|
|
9795
|
+
export declare const GlobalClusterMemberSynchronizationStatus: {
|
|
9796
|
+
readonly CONNECTED: "connected";
|
|
9797
|
+
readonly PENDING_RESYNC: "pending-resync";
|
|
9798
|
+
};
|
|
9799
|
+
/**
|
|
9800
|
+
* @public
|
|
9801
|
+
*/
|
|
9802
|
+
export type GlobalClusterMemberSynchronizationStatus = (typeof GlobalClusterMemberSynchronizationStatus)[keyof typeof GlobalClusterMemberSynchronizationStatus];
|
|
9771
9803
|
/**
|
|
9772
9804
|
* @public
|
|
9773
9805
|
* <p>A data structure with information about any primary and
|
|
9774
|
-
* secondary clusters associated with
|
|
9806
|
+
* secondary clusters associated with a global cluster (Aurora global database).</p>
|
|
9775
9807
|
*/
|
|
9776
9808
|
export interface GlobalClusterMember {
|
|
9777
9809
|
/**
|
|
9778
9810
|
* @public
|
|
9779
|
-
* <p>The Amazon Resource Name (ARN) for each Aurora cluster.</p>
|
|
9811
|
+
* <p>The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.</p>
|
|
9780
9812
|
*/
|
|
9781
9813
|
DBClusterArn?: string;
|
|
9782
9814
|
/**
|
|
9783
9815
|
* @public
|
|
9784
9816
|
* <p>The Amazon Resource Name (ARN) for each read-only secondary cluster
|
|
9785
|
-
* associated with the
|
|
9817
|
+
* associated with the global cluster.</p>
|
|
9786
9818
|
*/
|
|
9787
9819
|
Readers?: string[];
|
|
9788
9820
|
/**
|
|
9789
9821
|
* @public
|
|
9790
|
-
* <p>Specifies whether the Aurora cluster is the primary cluster
|
|
9791
|
-
* (that is, has read-write capability) for the
|
|
9792
|
-
*
|
|
9822
|
+
* <p>Specifies whether the Aurora DB cluster is the primary cluster
|
|
9823
|
+
* (that is, has read-write capability) for the global
|
|
9824
|
+
* cluster with which it is associated.</p>
|
|
9793
9825
|
*/
|
|
9794
9826
|
IsWriter?: boolean;
|
|
9795
9827
|
/**
|
|
9796
9828
|
* @public
|
|
9797
|
-
* <p>Specifies whether a secondary cluster in
|
|
9829
|
+
* <p>Specifies whether a secondary cluster in the global cluster has
|
|
9798
9830
|
* write forwarding enabled, not enabled, or is in the process of enabling it.</p>
|
|
9799
9831
|
*/
|
|
9800
9832
|
GlobalWriteForwardingStatus?: WriteForwardingStatus | string;
|
|
9833
|
+
/**
|
|
9834
|
+
* @public
|
|
9835
|
+
* <p>The status of synchronization of each Aurora DB cluster in the global cluster.</p>
|
|
9836
|
+
*/
|
|
9837
|
+
SynchronizationStatus?: GlobalClusterMemberSynchronizationStatus | string;
|
|
9801
9838
|
}
|
|
9802
9839
|
/**
|
|
9803
9840
|
* @public
|
|
@@ -9858,8 +9895,8 @@ export interface GlobalCluster {
|
|
|
9858
9895
|
GlobalClusterMembers?: GlobalClusterMember[];
|
|
9859
9896
|
/**
|
|
9860
9897
|
* @public
|
|
9861
|
-
* <p>A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database.
|
|
9862
|
-
* This object is empty unless the <
|
|
9898
|
+
* <p>A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database).
|
|
9899
|
+
* This object is empty unless the <code>SwitchoverGlobalCluster</code> or <code>FailoverGlobalCluster</code> operation was called on this global cluster.</p>
|
|
9863
9900
|
*/
|
|
9864
9901
|
FailoverState?: FailoverState;
|
|
9865
9902
|
}
|
|
@@ -12182,229 +12219,3 @@ export interface DBEngineVersionMessage {
|
|
|
12182
12219
|
*/
|
|
12183
12220
|
DBEngineVersions?: DBEngineVersion[];
|
|
12184
12221
|
}
|
|
12185
|
-
/**
|
|
12186
|
-
* @public
|
|
12187
|
-
*/
|
|
12188
|
-
export interface DescribeDBEngineVersionsMessage {
|
|
12189
|
-
/**
|
|
12190
|
-
* @public
|
|
12191
|
-
* <p>The database engine to return.</p>
|
|
12192
|
-
* <p>Valid Values:</p>
|
|
12193
|
-
* <ul>
|
|
12194
|
-
* <li>
|
|
12195
|
-
* <p>
|
|
12196
|
-
* <code>aurora-mysql</code>
|
|
12197
|
-
* </p>
|
|
12198
|
-
* </li>
|
|
12199
|
-
* <li>
|
|
12200
|
-
* <p>
|
|
12201
|
-
* <code>aurora-postgresql</code>
|
|
12202
|
-
* </p>
|
|
12203
|
-
* </li>
|
|
12204
|
-
* <li>
|
|
12205
|
-
* <p>
|
|
12206
|
-
* <code>custom-oracle-ee</code>
|
|
12207
|
-
* </p>
|
|
12208
|
-
* </li>
|
|
12209
|
-
* <li>
|
|
12210
|
-
* <p>
|
|
12211
|
-
* <code>mariadb</code>
|
|
12212
|
-
* </p>
|
|
12213
|
-
* </li>
|
|
12214
|
-
* <li>
|
|
12215
|
-
* <p>
|
|
12216
|
-
* <code>mysql</code>
|
|
12217
|
-
* </p>
|
|
12218
|
-
* </li>
|
|
12219
|
-
* <li>
|
|
12220
|
-
* <p>
|
|
12221
|
-
* <code>oracle-ee</code>
|
|
12222
|
-
* </p>
|
|
12223
|
-
* </li>
|
|
12224
|
-
* <li>
|
|
12225
|
-
* <p>
|
|
12226
|
-
* <code>oracle-ee-cdb</code>
|
|
12227
|
-
* </p>
|
|
12228
|
-
* </li>
|
|
12229
|
-
* <li>
|
|
12230
|
-
* <p>
|
|
12231
|
-
* <code>oracle-se2</code>
|
|
12232
|
-
* </p>
|
|
12233
|
-
* </li>
|
|
12234
|
-
* <li>
|
|
12235
|
-
* <p>
|
|
12236
|
-
* <code>oracle-se2-cdb</code>
|
|
12237
|
-
* </p>
|
|
12238
|
-
* </li>
|
|
12239
|
-
* <li>
|
|
12240
|
-
* <p>
|
|
12241
|
-
* <code>postgres</code>
|
|
12242
|
-
* </p>
|
|
12243
|
-
* </li>
|
|
12244
|
-
* <li>
|
|
12245
|
-
* <p>
|
|
12246
|
-
* <code>sqlserver-ee</code>
|
|
12247
|
-
* </p>
|
|
12248
|
-
* </li>
|
|
12249
|
-
* <li>
|
|
12250
|
-
* <p>
|
|
12251
|
-
* <code>sqlserver-se</code>
|
|
12252
|
-
* </p>
|
|
12253
|
-
* </li>
|
|
12254
|
-
* <li>
|
|
12255
|
-
* <p>
|
|
12256
|
-
* <code>sqlserver-ex</code>
|
|
12257
|
-
* </p>
|
|
12258
|
-
* </li>
|
|
12259
|
-
* <li>
|
|
12260
|
-
* <p>
|
|
12261
|
-
* <code>sqlserver-web</code>
|
|
12262
|
-
* </p>
|
|
12263
|
-
* </li>
|
|
12264
|
-
* </ul>
|
|
12265
|
-
*/
|
|
12266
|
-
Engine?: string;
|
|
12267
|
-
/**
|
|
12268
|
-
* @public
|
|
12269
|
-
* <p>The database engine version to return.</p>
|
|
12270
|
-
* <p>Example: <code>5.1.49</code>
|
|
12271
|
-
* </p>
|
|
12272
|
-
*/
|
|
12273
|
-
EngineVersion?: string;
|
|
12274
|
-
/**
|
|
12275
|
-
* @public
|
|
12276
|
-
* <p>The name of a specific DB parameter group family to return details for.</p>
|
|
12277
|
-
* <p>Constraints:</p>
|
|
12278
|
-
* <ul>
|
|
12279
|
-
* <li>
|
|
12280
|
-
* <p>If supplied, must match an existing DBParameterGroupFamily.</p>
|
|
12281
|
-
* </li>
|
|
12282
|
-
* </ul>
|
|
12283
|
-
*/
|
|
12284
|
-
DBParameterGroupFamily?: string;
|
|
12285
|
-
/**
|
|
12286
|
-
* @public
|
|
12287
|
-
* <p>A filter that specifies one or more DB engine versions to describe.</p>
|
|
12288
|
-
* <p>Supported filters:</p>
|
|
12289
|
-
* <ul>
|
|
12290
|
-
* <li>
|
|
12291
|
-
* <p>
|
|
12292
|
-
* <code>db-parameter-group-family</code> - Accepts parameter groups family names.
|
|
12293
|
-
* The results list only includes information about
|
|
12294
|
-
* the DB engine versions for these parameter group families.</p>
|
|
12295
|
-
* </li>
|
|
12296
|
-
* <li>
|
|
12297
|
-
* <p>
|
|
12298
|
-
* <code>engine</code> - Accepts engine names.
|
|
12299
|
-
* The results list only includes information about
|
|
12300
|
-
* the DB engine versions for these engines.</p>
|
|
12301
|
-
* </li>
|
|
12302
|
-
* <li>
|
|
12303
|
-
* <p>
|
|
12304
|
-
* <code>engine-mode</code> - Accepts DB engine modes.
|
|
12305
|
-
* The results list only includes information about
|
|
12306
|
-
* the DB engine versions for these engine modes. Valid
|
|
12307
|
-
* DB engine modes are the following:</p>
|
|
12308
|
-
* <ul>
|
|
12309
|
-
* <li>
|
|
12310
|
-
* <p>
|
|
12311
|
-
* <code>global</code>
|
|
12312
|
-
* </p>
|
|
12313
|
-
* </li>
|
|
12314
|
-
* <li>
|
|
12315
|
-
* <p>
|
|
12316
|
-
* <code>multimaster</code>
|
|
12317
|
-
* </p>
|
|
12318
|
-
* </li>
|
|
12319
|
-
* <li>
|
|
12320
|
-
* <p>
|
|
12321
|
-
* <code>parallelquery</code>
|
|
12322
|
-
* </p>
|
|
12323
|
-
* </li>
|
|
12324
|
-
* <li>
|
|
12325
|
-
* <p>
|
|
12326
|
-
* <code>provisioned</code>
|
|
12327
|
-
* </p>
|
|
12328
|
-
* </li>
|
|
12329
|
-
* <li>
|
|
12330
|
-
* <p>
|
|
12331
|
-
* <code>serverless</code>
|
|
12332
|
-
* </p>
|
|
12333
|
-
* </li>
|
|
12334
|
-
* </ul>
|
|
12335
|
-
* </li>
|
|
12336
|
-
* <li>
|
|
12337
|
-
* <p>
|
|
12338
|
-
* <code>engine-version</code> - Accepts engine versions.
|
|
12339
|
-
* The results list only includes information about
|
|
12340
|
-
* the DB engine versions for these engine versions.</p>
|
|
12341
|
-
* </li>
|
|
12342
|
-
* <li>
|
|
12343
|
-
* <p>
|
|
12344
|
-
* <code>status</code> - Accepts engine version statuses.
|
|
12345
|
-
* The results list only includes information about
|
|
12346
|
-
* the DB engine versions for these statuses. Valid statuses
|
|
12347
|
-
* are the following:</p>
|
|
12348
|
-
* <ul>
|
|
12349
|
-
* <li>
|
|
12350
|
-
* <p>
|
|
12351
|
-
* <code>available</code>
|
|
12352
|
-
* </p>
|
|
12353
|
-
* </li>
|
|
12354
|
-
* <li>
|
|
12355
|
-
* <p>
|
|
12356
|
-
* <code>deprecated</code>
|
|
12357
|
-
* </p>
|
|
12358
|
-
* </li>
|
|
12359
|
-
* </ul>
|
|
12360
|
-
* </li>
|
|
12361
|
-
* </ul>
|
|
12362
|
-
*/
|
|
12363
|
-
Filters?: Filter[];
|
|
12364
|
-
/**
|
|
12365
|
-
* @public
|
|
12366
|
-
* <p>The maximum number of records to include in the response.
|
|
12367
|
-
* If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is
|
|
12368
|
-
* included in the response so you can retrieve the remaining results.</p>
|
|
12369
|
-
* <p>Default: 100</p>
|
|
12370
|
-
* <p>Constraints: Minimum 20, maximum 100.</p>
|
|
12371
|
-
*/
|
|
12372
|
-
MaxRecords?: number;
|
|
12373
|
-
/**
|
|
12374
|
-
* @public
|
|
12375
|
-
* <p>An optional pagination token provided by a previous request.
|
|
12376
|
-
* If this parameter is specified, the response includes
|
|
12377
|
-
* only records beyond the marker,
|
|
12378
|
-
* up to the value specified by <code>MaxRecords</code>.</p>
|
|
12379
|
-
*/
|
|
12380
|
-
Marker?: string;
|
|
12381
|
-
/**
|
|
12382
|
-
* @public
|
|
12383
|
-
* <p>A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.</p>
|
|
12384
|
-
*/
|
|
12385
|
-
DefaultOnly?: boolean;
|
|
12386
|
-
/**
|
|
12387
|
-
* @public
|
|
12388
|
-
* <p>A value that indicates whether to list the supported character sets for each engine version.</p>
|
|
12389
|
-
* <p>If this parameter is enabled and the requested engine supports the <code>CharacterSetName</code> parameter for
|
|
12390
|
-
* <code>CreateDBInstance</code>, the response includes a list of supported character sets for each engine
|
|
12391
|
-
* version.</p>
|
|
12392
|
-
* <p>For RDS Custom, the default is not to list supported character sets. If you set <code>ListSupportedCharacterSets</code>
|
|
12393
|
-
* to <code>true</code>, RDS Custom returns no results.</p>
|
|
12394
|
-
*/
|
|
12395
|
-
ListSupportedCharacterSets?: boolean;
|
|
12396
|
-
/**
|
|
12397
|
-
* @public
|
|
12398
|
-
* <p>A value that indicates whether to list the supported time zones for each engine version.</p>
|
|
12399
|
-
* <p>If this parameter is enabled and the requested engine supports the <code>TimeZone</code> parameter for <code>CreateDBInstance</code>,
|
|
12400
|
-
* the response includes a list of supported time zones for each engine version.</p>
|
|
12401
|
-
* <p>For RDS Custom, the default is not to list supported time zones. If you set <code>ListSupportedTimezones</code>
|
|
12402
|
-
* to <code>true</code>, RDS Custom returns no results.</p>
|
|
12403
|
-
*/
|
|
12404
|
-
ListSupportedTimezones?: boolean;
|
|
12405
|
-
/**
|
|
12406
|
-
* @public
|
|
12407
|
-
* <p>A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.</p>
|
|
12408
|
-
*/
|
|
12409
|
-
IncludeAll?: boolean;
|
|
12410
|
-
}
|