@aws-sdk/client-rds 3.122.0 → 3.128.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 +27 -0
- package/dist-cjs/waiters/index.js +2 -0
- package/dist-cjs/waiters/waitForDBClusterAvailable.js +119 -0
- package/dist-cjs/waiters/waitForDBClusterDeleted.js +99 -0
- package/dist-es/waiters/index.js +2 -0
- package/dist-es/waiters/waitForDBClusterAvailable.js +195 -0
- package/dist-es/waiters/waitForDBClusterDeleted.js +155 -0
- package/dist-types/RDS.d.ts +68 -43
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +42 -9
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +3 -3
- package/dist-types/commands/CreateDBClusterCommand.d.ts +3 -1
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +1 -1
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +9 -9
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +0 -8
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +2 -2
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventsCommand.d.ts +0 -2
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +1 -1
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +98 -326
- package/dist-types/models/models_1.d.ts +35 -129
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForDBClusterAvailable.d.ts +7 -0
- package/dist-types/ts3.4/waiters/waitForDBClusterDeleted.d.ts +7 -0
- package/dist-types/waiters/index.d.ts +2 -0
- package/dist-types/waiters/waitForDBClusterAvailable.d.ts +14 -0
- package/dist-types/waiters/waitForDBClusterDeleted.d.ts +14 -0
- package/package.json +28 -28
package/dist-types/RDS.d.ts
CHANGED
|
@@ -251,7 +251,7 @@ export declare class RDS extends RDSClient {
|
|
|
251
251
|
* Backtracking an Aurora DB Cluster</a> in the
|
|
252
252
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
253
253
|
* <note>
|
|
254
|
-
* <p>This action applies
|
|
254
|
+
* <p>This action only applies to Aurora MySQL DB clusters.</p>
|
|
255
255
|
* </note>
|
|
256
256
|
*/
|
|
257
257
|
backtrackDBCluster(args: BacktrackDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<BacktrackDBClusterCommandOutput>;
|
|
@@ -274,11 +274,9 @@ export declare class RDS extends RDSClient {
|
|
|
274
274
|
* <p>Copies a snapshot of a DB cluster.</p>
|
|
275
275
|
* <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code>
|
|
276
276
|
* must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p>
|
|
277
|
-
* <p>You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
* an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the
|
|
281
|
-
* following values:</p>
|
|
277
|
+
* <p>You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the <code>CopyDBClusterSnapshot</code> action
|
|
278
|
+
* is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region,
|
|
279
|
+
* you must provide the following values:</p>
|
|
282
280
|
* <ul>
|
|
283
281
|
* <li>
|
|
284
282
|
* <p>
|
|
@@ -287,14 +285,49 @@ export declare class RDS extends RDSClient {
|
|
|
287
285
|
* </li>
|
|
288
286
|
* <li>
|
|
289
287
|
* <p>
|
|
288
|
+
* <code>PreSignedUrl</code> - A URL that contains a Signature Version 4 signed request for the
|
|
289
|
+
* <code>CopyDBClusterSnapshot</code> action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from.
|
|
290
|
+
* The pre-signed URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the
|
|
291
|
+
* source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.</p>
|
|
292
|
+
* <p>The pre-signed URL request must contain the following parameter values:</p>
|
|
293
|
+
* <ul>
|
|
294
|
+
* <li>
|
|
295
|
+
* <p>
|
|
296
|
+
* <code>KmsKeyId</code> - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB
|
|
297
|
+
* cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code>
|
|
298
|
+
* action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.</p>
|
|
299
|
+
* </li>
|
|
300
|
+
* <li>
|
|
301
|
+
* <p>
|
|
302
|
+
* <code>DestinationRegion</code> - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.</p>
|
|
303
|
+
* </li>
|
|
304
|
+
* <li>
|
|
305
|
+
* <p>
|
|
306
|
+
* <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster
|
|
307
|
+
* snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example,
|
|
308
|
+
* if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your <code>SourceDBClusterSnapshotIdentifier</code>
|
|
309
|
+
* looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>.</p>
|
|
310
|
+
* </li>
|
|
311
|
+
* </ul>
|
|
312
|
+
* <p>To learn how to generate a Signature Version 4 signed request, see
|
|
313
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html">
|
|
314
|
+
* Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and
|
|
315
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">
|
|
316
|
+
* Signature Version 4 Signing Process</a>.</p>
|
|
317
|
+
* <note>
|
|
318
|
+
* <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the CLI)
|
|
319
|
+
* instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid
|
|
320
|
+
* request for the operation that can be executed in the source Amazon Web Services Region.</p>
|
|
321
|
+
* </note>
|
|
322
|
+
* </li>
|
|
323
|
+
* <li>
|
|
324
|
+
* <p>
|
|
290
325
|
* <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.</p>
|
|
291
326
|
* </li>
|
|
292
327
|
* <li>
|
|
293
328
|
* <p>
|
|
294
|
-
* <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot
|
|
295
|
-
*
|
|
296
|
-
* must be in the ARN format for the source Amazon Web Services Region and is the same value as
|
|
297
|
-
* the <code>SourceDBClusterSnapshotIdentifier</code> in the presigned URL.</p>
|
|
329
|
+
* <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied.
|
|
330
|
+
* This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the <code>SourceDBClusterSnapshotIdentifier</code> in the pre-signed URL.</p>
|
|
298
331
|
* </li>
|
|
299
332
|
* </ul>
|
|
300
333
|
* <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified
|
|
@@ -320,9 +353,9 @@ export declare class RDS extends RDSClient {
|
|
|
320
353
|
copyDBParameterGroup(args: CopyDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBParameterGroupCommandOutput) => void): void;
|
|
321
354
|
/**
|
|
322
355
|
* <p>Copies the specified DB snapshot. The source DB snapshot must be in the <code>available</code> state.</p>
|
|
323
|
-
* <p>You can copy a snapshot from one Amazon Web Services Region to another. In that case, the
|
|
324
|
-
*
|
|
325
|
-
*
|
|
356
|
+
* <p>You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region
|
|
357
|
+
* where you call the <code>CopyDBSnapshot</code> action is the destination Amazon Web Services Region for the
|
|
358
|
+
* DB snapshot copy.</p>
|
|
326
359
|
* <p>This command doesn't apply to RDS Custom.</p>
|
|
327
360
|
* <p>For more information about copying snapshots, see
|
|
328
361
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot">Copying a DB Snapshot</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
@@ -376,7 +409,9 @@ export declare class RDS extends RDSClient {
|
|
|
376
409
|
* <p>Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.</p>
|
|
377
410
|
* <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon
|
|
378
411
|
* Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
|
|
379
|
-
* PostgreSQL DB instance
|
|
412
|
+
* PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by
|
|
413
|
+
* <code>ReplicationSourceIdentifier</code> is encrypted, also specify the
|
|
414
|
+
* <code>PreSignedUrl</code> parameter.</p>
|
|
380
415
|
* <p>For more information on Amazon Aurora, see
|
|
381
416
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
382
417
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
@@ -390,7 +425,7 @@ export declare class RDS extends RDSClient {
|
|
|
390
425
|
/**
|
|
391
426
|
* <p>Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.</p>
|
|
392
427
|
* <note>
|
|
393
|
-
* <p>This action applies
|
|
428
|
+
* <p>This action only applies to Aurora DB clusters.</p>
|
|
394
429
|
* </note>
|
|
395
430
|
*/
|
|
396
431
|
createDBClusterEndpoint(args: CreateDBClusterEndpointCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterEndpointCommandOutput>;
|
|
@@ -411,15 +446,15 @@ export declare class RDS extends RDSClient {
|
|
|
411
446
|
* cluster without failover for the new DB cluster parameter group and associated settings to take effect.</p>
|
|
412
447
|
* <important>
|
|
413
448
|
* <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
|
|
414
|
-
* before creating your first DB cluster
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
* cluster. This is especially important for parameters
|
|
418
|
-
* the default database for a DB cluster, such as the character set
|
|
419
|
-
* database defined by the <code>character_set_database</code> parameter. You can use
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
* cluster parameter group has been created or modified.</p>
|
|
449
|
+
* before creating your first DB cluster
|
|
450
|
+
* that uses that DB cluster parameter group as the default parameter
|
|
451
|
+
* group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter
|
|
452
|
+
* group is used as the default for a new DB cluster. This is especially important for parameters
|
|
453
|
+
* that are critical when creating the default database for a DB cluster, such as the character set
|
|
454
|
+
* for the default database defined by the <code>character_set_database</code> parameter. You can use the
|
|
455
|
+
* <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
|
|
456
|
+
* <code>DescribeDBClusterParameters</code> action to verify
|
|
457
|
+
* that your DB cluster parameter group has been created or modified.</p>
|
|
423
458
|
* </important>
|
|
424
459
|
* <p>For more information on Amazon Aurora, see
|
|
425
460
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
@@ -444,14 +479,6 @@ export declare class RDS extends RDSClient {
|
|
|
444
479
|
createDBClusterSnapshot(args: CreateDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void): void;
|
|
445
480
|
/**
|
|
446
481
|
* <p>Creates a new DB instance.</p>
|
|
447
|
-
* <p>The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
|
|
448
|
-
* For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance
|
|
449
|
-
* to the cluster.</p>
|
|
450
|
-
* <p>For more information about creating an RDS DB instance, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html">
|
|
451
|
-
* Creating an Amazon RDS DB instance</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
452
|
-
* <p>For more information about creating a DB instance in an Aurora DB cluster, see
|
|
453
|
-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html">
|
|
454
|
-
* Creating an Amazon Aurora DB cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
455
482
|
*/
|
|
456
483
|
createDBInstance(args: CreateDBInstanceCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBInstanceCommandOutput>;
|
|
457
484
|
createDBInstance(args: CreateDBInstanceCommandInput, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void): void;
|
|
@@ -461,8 +488,8 @@ export declare class RDS extends RDSClient {
|
|
|
461
488
|
* instance. You can create a read replica for a DB instance running MySQL, MariaDB,
|
|
462
489
|
* Oracle, PostgreSQL, or SQL Server. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working with Read
|
|
463
490
|
* Replicas</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
464
|
-
* <p>Amazon Aurora doesn't support this
|
|
465
|
-
*
|
|
491
|
+
* <p>Amazon Aurora doesn't support this action. Call the <code>CreateDBInstance</code>
|
|
492
|
+
* action to create a DB instance for an Aurora DB cluster.</p>
|
|
466
493
|
* <p>All read replica DB instances are created with backups disabled. All other DB
|
|
467
494
|
* instance attributes (including DB security groups and DB parameter groups) are inherited
|
|
468
495
|
* from the source DB instance, except as specified.</p>
|
|
@@ -535,7 +562,7 @@ export declare class RDS extends RDSClient {
|
|
|
535
562
|
createDBSubnetGroup(args: CreateDBSubnetGroupCommandInput, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void): void;
|
|
536
563
|
createDBSubnetGroup(args: CreateDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void): void;
|
|
537
564
|
/**
|
|
538
|
-
* <p>Creates an RDS event notification subscription. This
|
|
565
|
+
* <p>Creates an RDS event notification subscription. This action requires a topic Amazon
|
|
539
566
|
* Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.
|
|
540
567
|
* To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the
|
|
541
568
|
* topic. The ARN is displayed in the SNS console.</p>
|
|
@@ -573,7 +600,7 @@ export declare class RDS extends RDSClient {
|
|
|
573
600
|
* Or you can specify an existing Aurora cluster during the create operation,
|
|
574
601
|
* and this cluster becomes the primary cluster of the global database.</p>
|
|
575
602
|
* <note>
|
|
576
|
-
* <p>This action applies
|
|
603
|
+
* <p>This action only applies to Aurora DB clusters.</p>
|
|
577
604
|
* </note>
|
|
578
605
|
*/
|
|
579
606
|
createGlobalCluster(args: CreateGlobalClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateGlobalClusterCommandOutput>;
|
|
@@ -1007,8 +1034,6 @@ export declare class RDS extends RDSClient {
|
|
|
1007
1034
|
* <p>Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days.
|
|
1008
1035
|
* Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be
|
|
1009
1036
|
* obtained by providing the name as a parameter.</p>
|
|
1010
|
-
* <p>For more information on working with events, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html">Monitoring Amazon RDS events</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html">Monitoring Amazon Aurora
|
|
1011
|
-
* events</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
1012
1037
|
* <note>
|
|
1013
1038
|
* <p>By default, RDS returns events that were generated in the past hour.</p>
|
|
1014
1039
|
* </note>
|
|
@@ -1107,7 +1132,7 @@ export declare class RDS extends RDSClient {
|
|
|
1107
1132
|
* <p>For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)
|
|
1108
1133
|
* in the DB cluster to be the primary DB instance (the cluster writer).</p>
|
|
1109
1134
|
* <p>An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,
|
|
1110
|
-
* when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a
|
|
1135
|
+
* when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby
|
|
1111
1136
|
* DB instance when the primary DB instance fails.</p>
|
|
1112
1137
|
* <p>To simulate a failure of a primary instance for testing, you can force a failover.
|
|
1113
1138
|
* Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing
|
|
@@ -1254,7 +1279,7 @@ export declare class RDS extends RDSClient {
|
|
|
1254
1279
|
* that are critical when creating the default database for a DB cluster, such as the character set
|
|
1255
1280
|
* for the default database defined by the <code>character_set_database</code> parameter. You can use the
|
|
1256
1281
|
* <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
|
|
1257
|
-
* <code>DescribeDBClusterParameters</code>
|
|
1282
|
+
* <code>DescribeDBClusterParameters</code> action to verify
|
|
1258
1283
|
* that your DB cluster parameter group has been created or modified.</p>
|
|
1259
1284
|
* <p>If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora
|
|
1260
1285
|
* applies the update immediately. The cluster restart might interrupt your workload. In that case,
|
|
@@ -1290,7 +1315,7 @@ export declare class RDS extends RDSClient {
|
|
|
1290
1315
|
* parameter. You can't use <code>all</code> as a value for that parameter in this
|
|
1291
1316
|
* case.</p>
|
|
1292
1317
|
* <p>To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster
|
|
1293
|
-
* snapshot, or whether a manual DB cluster snapshot is public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API
|
|
1318
|
+
* snapshot, or whether a manual DB cluster snapshot is public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API action. The accounts are
|
|
1294
1319
|
* returned as values for the <code>restore</code> attribute.</p>
|
|
1295
1320
|
*/
|
|
1296
1321
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBClusterSnapshotAttributeCommandOutput>;
|
|
@@ -1370,7 +1395,7 @@ export declare class RDS extends RDSClient {
|
|
|
1370
1395
|
* list of authorized Amazon Web Services account IDs for the <code>ValuesToAdd</code> parameter. You
|
|
1371
1396
|
* can't use <code>all</code> as a value for that parameter in this case.</p>
|
|
1372
1397
|
* <p>To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or
|
|
1373
|
-
* whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API
|
|
1398
|
+
* whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API action. The accounts are returned as
|
|
1374
1399
|
* values for the <code>restore</code> attribute.</p>
|
|
1375
1400
|
*/
|
|
1376
1401
|
modifyDBSnapshotAttribute(args: ModifyDBSnapshotAttributeCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBSnapshotAttributeCommandOutput>;
|
|
@@ -1787,7 +1812,7 @@ export declare class RDS extends RDSClient {
|
|
|
1787
1812
|
stopDBInstance(args: StopDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDBInstanceCommandOutput) => void): void;
|
|
1788
1813
|
/**
|
|
1789
1814
|
* <p>Stops automated backup replication for a DB instance.</p>
|
|
1790
|
-
* <p>This command doesn't apply to RDS Custom
|
|
1815
|
+
* <p>This command doesn't apply to RDS Custom.</p>
|
|
1791
1816
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html">
|
|
1792
1817
|
* Replicating Automated Backups to Another Amazon Web Services Region</a> in the <i>Amazon RDS User Guide.</i>
|
|
1793
1818
|
* </p>
|
|
@@ -13,7 +13,7 @@ export interface BacktrackDBClusterCommandOutput extends DBClusterBacktrack, __M
|
|
|
13
13
|
* Backtracking an Aurora DB Cluster</a> in the
|
|
14
14
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
15
15
|
* <note>
|
|
16
|
-
* <p>This action applies
|
|
16
|
+
* <p>This action only applies to Aurora MySQL DB clusters.</p>
|
|
17
17
|
* </note>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,11 +10,9 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
|
|
|
10
10
|
* <p>Copies a snapshot of a DB cluster.</p>
|
|
11
11
|
* <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code>
|
|
12
12
|
* must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p>
|
|
13
|
-
* <p>You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the
|
|
17
|
-
* following values:</p>
|
|
13
|
+
* <p>You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the <code>CopyDBClusterSnapshot</code> action
|
|
14
|
+
* is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region,
|
|
15
|
+
* you must provide the following values:</p>
|
|
18
16
|
* <ul>
|
|
19
17
|
* <li>
|
|
20
18
|
* <p>
|
|
@@ -23,14 +21,49 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
|
|
|
23
21
|
* </li>
|
|
24
22
|
* <li>
|
|
25
23
|
* <p>
|
|
24
|
+
* <code>PreSignedUrl</code> - A URL that contains a Signature Version 4 signed request for the
|
|
25
|
+
* <code>CopyDBClusterSnapshot</code> action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from.
|
|
26
|
+
* The pre-signed URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the
|
|
27
|
+
* source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.</p>
|
|
28
|
+
* <p>The pre-signed URL request must contain the following parameter values:</p>
|
|
29
|
+
* <ul>
|
|
30
|
+
* <li>
|
|
31
|
+
* <p>
|
|
32
|
+
* <code>KmsKeyId</code> - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB
|
|
33
|
+
* cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code>
|
|
34
|
+
* action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.</p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <code>DestinationRegion</code> - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.</p>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>
|
|
42
|
+
* <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster
|
|
43
|
+
* snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example,
|
|
44
|
+
* if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your <code>SourceDBClusterSnapshotIdentifier</code>
|
|
45
|
+
* looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>.</p>
|
|
46
|
+
* </li>
|
|
47
|
+
* </ul>
|
|
48
|
+
* <p>To learn how to generate a Signature Version 4 signed request, see
|
|
49
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html">
|
|
50
|
+
* Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and
|
|
51
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">
|
|
52
|
+
* Signature Version 4 Signing Process</a>.</p>
|
|
53
|
+
* <note>
|
|
54
|
+
* <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the CLI)
|
|
55
|
+
* instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid
|
|
56
|
+
* request for the operation that can be executed in the source Amazon Web Services Region.</p>
|
|
57
|
+
* </note>
|
|
58
|
+
* </li>
|
|
59
|
+
* <li>
|
|
60
|
+
* <p>
|
|
26
61
|
* <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.</p>
|
|
27
62
|
* </li>
|
|
28
63
|
* <li>
|
|
29
64
|
* <p>
|
|
30
|
-
* <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot
|
|
31
|
-
*
|
|
32
|
-
* must be in the ARN format for the source Amazon Web Services Region and is the same value as
|
|
33
|
-
* the <code>SourceDBClusterSnapshotIdentifier</code> in the presigned URL.</p>
|
|
65
|
+
* <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied.
|
|
66
|
+
* This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the <code>SourceDBClusterSnapshotIdentifier</code> in the pre-signed URL.</p>
|
|
34
67
|
* </li>
|
|
35
68
|
* </ul>
|
|
36
69
|
* <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified
|
|
@@ -8,9 +8,9 @@ export interface CopyDBSnapshotCommandOutput extends CopyDBSnapshotResult, __Met
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Copies the specified DB snapshot. The source DB snapshot must be in the <code>available</code> state.</p>
|
|
11
|
-
* <p>You can copy a snapshot from one Amazon Web Services Region to another. In that case, the
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* <p>You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region
|
|
12
|
+
* where you call the <code>CopyDBSnapshot</code> action is the destination Amazon Web Services Region for the
|
|
13
|
+
* DB snapshot copy.</p>
|
|
14
14
|
* <p>This command doesn't apply to RDS Custom.</p>
|
|
15
15
|
* <p>For more information about copying snapshots, see
|
|
16
16
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot">Copying a DB Snapshot</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
@@ -10,7 +10,9 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
|
|
|
10
10
|
* <p>Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.</p>
|
|
11
11
|
* <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon
|
|
12
12
|
* Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
|
|
13
|
-
* PostgreSQL DB instance
|
|
13
|
+
* PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by
|
|
14
|
+
* <code>ReplicationSourceIdentifier</code> is encrypted, also specify the
|
|
15
|
+
* <code>PreSignedUrl</code> parameter.</p>
|
|
14
16
|
* <p>For more information on Amazon Aurora, see
|
|
15
17
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
16
18
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
@@ -9,7 +9,7 @@ export interface CreateDBClusterEndpointCommandOutput extends DBClusterEndpoint,
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.</p>
|
|
11
11
|
* <note>
|
|
12
|
-
* <p>This action applies
|
|
12
|
+
* <p>This action only applies to Aurora DB clusters.</p>
|
|
13
13
|
* </note>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -21,15 +21,15 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
|
|
|
21
21
|
* cluster without failover for the new DB cluster parameter group and associated settings to take effect.</p>
|
|
22
22
|
* <important>
|
|
23
23
|
* <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
|
|
24
|
-
* before creating your first DB cluster
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* cluster. This is especially important for parameters
|
|
28
|
-
* the default database for a DB cluster, such as the character set
|
|
29
|
-
* database defined by the <code>character_set_database</code> parameter. You can use
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* cluster parameter group has been created or modified.</p>
|
|
24
|
+
* before creating your first DB cluster
|
|
25
|
+
* that uses that DB cluster parameter group as the default parameter
|
|
26
|
+
* group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter
|
|
27
|
+
* group is used as the default for a new DB cluster. This is especially important for parameters
|
|
28
|
+
* that are critical when creating the default database for a DB cluster, such as the character set
|
|
29
|
+
* for the default database defined by the <code>character_set_database</code> parameter. You can use the
|
|
30
|
+
* <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
|
|
31
|
+
* <code>DescribeDBClusterParameters</code> action to verify
|
|
32
|
+
* that your DB cluster parameter group has been created or modified.</p>
|
|
33
33
|
* </important>
|
|
34
34
|
* <p>For more information on Amazon Aurora, see
|
|
35
35
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
@@ -8,14 +8,6 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a new DB instance.</p>
|
|
11
|
-
* <p>The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
|
|
12
|
-
* For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance
|
|
13
|
-
* to the cluster.</p>
|
|
14
|
-
* <p>For more information about creating an RDS DB instance, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html">
|
|
15
|
-
* Creating an Amazon RDS DB instance</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
16
|
-
* <p>For more information about creating a DB instance in an Aurora DB cluster, see
|
|
17
|
-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html">
|
|
18
|
-
* Creating an Amazon Aurora DB cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
19
11
|
* @example
|
|
20
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
13
|
* ```javascript
|
|
@@ -11,8 +11,8 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
|
|
|
11
11
|
* instance. You can create a read replica for a DB instance running MySQL, MariaDB,
|
|
12
12
|
* Oracle, PostgreSQL, or SQL Server. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working with Read
|
|
13
13
|
* Replicas</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
14
|
-
* <p>Amazon Aurora doesn't support this
|
|
15
|
-
*
|
|
14
|
+
* <p>Amazon Aurora doesn't support this action. Call the <code>CreateDBInstance</code>
|
|
15
|
+
* action to create a DB instance for an Aurora DB cluster.</p>
|
|
16
16
|
* <p>All read replica DB instances are created with backups disabled. All other DB
|
|
17
17
|
* instance attributes (including DB security groups and DB parameter groups) are inherited
|
|
18
18
|
* from the source DB instance, except as specified.</p>
|
|
@@ -7,7 +7,7 @@ export interface CreateEventSubscriptionCommandInput extends CreateEventSubscrip
|
|
|
7
7
|
export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscriptionResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates an RDS event notification subscription. This
|
|
10
|
+
* <p>Creates an RDS event notification subscription. This action requires a topic Amazon
|
|
11
11
|
* Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.
|
|
12
12
|
* To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the
|
|
13
13
|
* topic. The ARN is displayed in the SNS console.</p>
|
|
@@ -18,7 +18,7 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
|
|
|
18
18
|
* Or you can specify an existing Aurora cluster during the create operation,
|
|
19
19
|
* and this cluster becomes the primary cluster of the global database.</p>
|
|
20
20
|
* <note>
|
|
21
|
-
* <p>This action applies
|
|
21
|
+
* <p>This action only applies to Aurora DB clusters.</p>
|
|
22
22
|
* </note>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,8 +10,6 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
|
|
|
10
10
|
* <p>Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days.
|
|
11
11
|
* Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be
|
|
12
12
|
* obtained by providing the name as a parameter.</p>
|
|
13
|
-
* <p>For more information on working with events, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html">Monitoring Amazon RDS events</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html">Monitoring Amazon Aurora
|
|
14
|
-
* events</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
15
13
|
* <note>
|
|
16
14
|
* <p>By default, RDS returns events that were generated in the past hour.</p>
|
|
17
15
|
* </note>
|
|
@@ -13,7 +13,7 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
|
|
|
13
13
|
* <p>For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)
|
|
14
14
|
* in the DB cluster to be the primary DB instance (the cluster writer).</p>
|
|
15
15
|
* <p>An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,
|
|
16
|
-
* when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a
|
|
16
|
+
* when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby
|
|
17
17
|
* DB instance when the primary DB instance fails.</p>
|
|
18
18
|
* <p>To simulate a failure of a primary instance for testing, you can force a failover.
|
|
19
19
|
* Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing
|
|
@@ -19,7 +19,7 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
|
|
|
19
19
|
* that are critical when creating the default database for a DB cluster, such as the character set
|
|
20
20
|
* for the default database defined by the <code>character_set_database</code> parameter. You can use the
|
|
21
21
|
* <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
|
|
22
|
-
* <code>DescribeDBClusterParameters</code>
|
|
22
|
+
* <code>DescribeDBClusterParameters</code> action to verify
|
|
23
23
|
* that your DB cluster parameter group has been created or modified.</p>
|
|
24
24
|
* <p>If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora
|
|
25
25
|
* applies the update immediately. The cluster restart might interrupt your workload. In that case,
|
|
@@ -24,7 +24,7 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
|
|
|
24
24
|
* parameter. You can't use <code>all</code> as a value for that parameter in this
|
|
25
25
|
* case.</p>
|
|
26
26
|
* <p>To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster
|
|
27
|
-
* snapshot, or whether a manual DB cluster snapshot is public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API
|
|
27
|
+
* snapshot, or whether a manual DB cluster snapshot is public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API action. The accounts are
|
|
28
28
|
* returned as values for the <code>restore</code> attribute.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,7 +22,7 @@ export interface ModifyDBSnapshotAttributeCommandOutput extends ModifyDBSnapshot
|
|
|
22
22
|
* list of authorized Amazon Web Services account IDs for the <code>ValuesToAdd</code> parameter. You
|
|
23
23
|
* can't use <code>all</code> as a value for that parameter in this case.</p>
|
|
24
24
|
* <p>To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or
|
|
25
|
-
* whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API
|
|
25
|
+
* whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API action. The accounts are returned as
|
|
26
26
|
* values for the <code>restore</code> attribute.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,7 +8,7 @@ export interface StopDBInstanceAutomatedBackupsReplicationCommandOutput extends
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Stops automated backup replication for a DB instance.</p>
|
|
11
|
-
* <p>This command doesn't apply to RDS Custom
|
|
11
|
+
* <p>This command doesn't apply to RDS Custom.</p>
|
|
12
12
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html">
|
|
13
13
|
* Replicating Automated Backups to Another Amazon Web Services Region</a> in the <i>Amazon RDS User Guide.</i>
|
|
14
14
|
* </p>
|