@aws-sdk/client-rds 3.42.0 → 3.43.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 +11 -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/models/models_1.js +14 -2
- package/dist-cjs/protocols/Aws_query.js +248 -4
- 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/models/models_1.js +8 -0
- package/dist-es/protocols/Aws_query.js +250 -0
- package/dist-types/RDS.d.ts +199 -118
- package/dist-types/RDSClient.d.ts +3 -2
- 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 +477 -170
- package/dist-types/models/models_1.d.ts +670 -122
- package/dist-types/protocols/Aws_query.d.ts +3 -0
- package/dist-types/ts3.4/RDS.d.ts +5 -0
- package/dist-types/ts3.4/RDSClient.d.ts +3 -2
- 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 -0
- package/dist-types/ts3.4/models/models_1.d.ts +58 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +3 -0
- package/package.json +2 -2
package/dist-types/RDS.d.ts
CHANGED
|
@@ -114,6 +114,7 @@ import { ModifyOptionGroupCommandInput, ModifyOptionGroupCommandOutput } from ".
|
|
|
114
114
|
import { PromoteReadReplicaCommandInput, PromoteReadReplicaCommandOutput } from "./commands/PromoteReadReplicaCommand";
|
|
115
115
|
import { PromoteReadReplicaDBClusterCommandInput, PromoteReadReplicaDBClusterCommandOutput } from "./commands/PromoteReadReplicaDBClusterCommand";
|
|
116
116
|
import { PurchaseReservedDBInstancesOfferingCommandInput, PurchaseReservedDBInstancesOfferingCommandOutput } from "./commands/PurchaseReservedDBInstancesOfferingCommand";
|
|
117
|
+
import { RebootDBClusterCommandInput, RebootDBClusterCommandOutput } from "./commands/RebootDBClusterCommand";
|
|
117
118
|
import { RebootDBInstanceCommandInput, RebootDBInstanceCommandOutput } from "./commands/RebootDBInstanceCommand";
|
|
118
119
|
import { RegisterDBProxyTargetsCommandInput, RegisterDBProxyTargetsCommandOutput } from "./commands/RegisterDBProxyTargetsCommand";
|
|
119
120
|
import { RemoveFromGlobalClusterCommandInput, RemoveFromGlobalClusterCommandOutput } from "./commands/RemoveFromGlobalClusterCommand";
|
|
@@ -201,12 +202,7 @@ import { RDSClient } from "./RDSClient";
|
|
|
201
202
|
*/
|
|
202
203
|
export declare class RDS extends RDSClient {
|
|
203
204
|
/**
|
|
204
|
-
* <p>Associates an Identity and Access Management (IAM) role
|
|
205
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.html">Authorizing Amazon Aurora MySQL
|
|
206
|
-
* to Access Other Amazon Web Services Services on Your Behalf</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
207
|
-
* <note>
|
|
208
|
-
* <p>This action only applies to Aurora DB clusters.</p>
|
|
209
|
-
* </note>
|
|
205
|
+
* <p>Associates an Identity and Access Management (IAM) role with a DB cluster.</p>
|
|
210
206
|
*/
|
|
211
207
|
addRoleToDBCluster(args: AddRoleToDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<AddRoleToDBClusterCommandOutput>;
|
|
212
208
|
addRoleToDBCluster(args: AddRoleToDBClusterCommandInput, cb: (err: any, data?: AddRoleToDBClusterCommandOutput) => void): void;
|
|
@@ -244,7 +240,7 @@ export declare class RDS extends RDSClient {
|
|
|
244
240
|
/**
|
|
245
241
|
* <p>Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security
|
|
246
242
|
* groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC
|
|
247
|
-
* instances. Second, IP ranges are available if the application accessing your database is running on the
|
|
243
|
+
* instances. Second, IP ranges are available if the application accessing your database is running on the internet.
|
|
248
244
|
* Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId
|
|
249
245
|
* and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).</p>
|
|
250
246
|
* <note>
|
|
@@ -282,9 +278,6 @@ export declare class RDS extends RDSClient {
|
|
|
282
278
|
cancelExportTask(args: CancelExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelExportTaskCommandOutput) => void): void;
|
|
283
279
|
/**
|
|
284
280
|
* <p>Copies the specified DB cluster parameter group.</p>
|
|
285
|
-
* <note>
|
|
286
|
-
* <p>This action only applies to Aurora DB clusters.</p>
|
|
287
|
-
* </note>
|
|
288
281
|
*/
|
|
289
282
|
copyDBClusterParameterGroup(args: CopyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<CopyDBClusterParameterGroupCommandOutput>;
|
|
290
283
|
copyDBClusterParameterGroup(args: CopyDBClusterParameterGroupCommandInput, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void): void;
|
|
@@ -353,17 +346,21 @@ export declare class RDS extends RDSClient {
|
|
|
353
346
|
* </ul>
|
|
354
347
|
* <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified
|
|
355
348
|
* by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in "copying" status.</p>
|
|
356
|
-
* <p>For more information on copying encrypted DB cluster snapshots from one Amazon Web Services Region to another, see
|
|
349
|
+
* <p>For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see
|
|
357
350
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html">
|
|
358
351
|
* Copying a Snapshot</a> in the <i>Amazon Aurora User Guide.</i>
|
|
359
352
|
* </p>
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
*
|
|
353
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
354
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
355
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
363
356
|
* </p>
|
|
364
|
-
*
|
|
365
|
-
* <
|
|
366
|
-
*
|
|
357
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
358
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
359
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
360
|
+
* </p>
|
|
361
|
+
* <note>
|
|
362
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
363
|
+
* </note>
|
|
367
364
|
*/
|
|
368
365
|
copyDBClusterSnapshot(args: CopyDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CopyDBClusterSnapshotCommandOutput>;
|
|
369
366
|
copyDBClusterSnapshot(args: CopyDBClusterSnapshotCommandInput, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void): void;
|
|
@@ -408,22 +405,18 @@ export declare class RDS extends RDSClient {
|
|
|
408
405
|
createCustomAvailabilityZone(args: CreateCustomAvailabilityZoneCommandInput, cb: (err: any, data?: CreateCustomAvailabilityZoneCommandOutput) => void): void;
|
|
409
406
|
createCustomAvailabilityZone(args: CreateCustomAvailabilityZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomAvailabilityZoneCommandOutput) => void): void;
|
|
410
407
|
/**
|
|
411
|
-
* <p>Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest">
|
|
415
|
-
* Amazon RDS Custom requirements and limitations</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
408
|
+
* <p>Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific
|
|
409
|
+
* AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later
|
|
410
|
+
* RU/RUR.</p>
|
|
416
411
|
* <p>Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.
|
|
417
412
|
* The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create
|
|
418
|
-
* your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3
|
|
419
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.html#custom-cev.preparing">
|
|
420
|
-
* Preparing to create a CEV</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
413
|
+
* your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3.</p>
|
|
421
414
|
* <p>When you create a custom engine version, you specify the files in a JSON document called a CEV manifest.
|
|
422
415
|
* This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from
|
|
423
416
|
* the installation files that you provided. This service model is called Bring Your Own Media (BYOM).</p>
|
|
424
417
|
* <p>Creation takes approximately two hours. If creation fails, RDS Custom issues <code>RDS-EVENT-0196</code> with
|
|
425
418
|
* the message <code>Creation failed for custom engine version</code>, and includes details about the failure.
|
|
426
|
-
* For example, the event prints missing files
|
|
419
|
+
* For example, the event prints missing files.</p>
|
|
427
420
|
* <p>After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple
|
|
428
421
|
* RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or
|
|
429
422
|
* inactive.</p>
|
|
@@ -441,19 +434,22 @@ export declare class RDS extends RDSClient {
|
|
|
441
434
|
createCustomDBEngineVersion(args: CreateCustomDBEngineVersionCommandInput, cb: (err: any, data?: CreateCustomDBEngineVersionCommandOutput) => void): void;
|
|
442
435
|
createCustomDBEngineVersion(args: CreateCustomDBEngineVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomDBEngineVersionCommandOutput) => void): void;
|
|
443
436
|
/**
|
|
444
|
-
* <p>Creates a new Amazon Aurora DB cluster.</p>
|
|
445
|
-
* <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create
|
|
446
|
-
* cluster as a read replica of another DB cluster or Amazon RDS MySQL or
|
|
447
|
-
* cross-
|
|
448
|
-
* <code>ReplicationSourceIdentifier</code> is encrypted,
|
|
437
|
+
* <p>Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.</p>
|
|
438
|
+
* <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon
|
|
439
|
+
* Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
|
|
440
|
+
* PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by
|
|
441
|
+
* <code>ReplicationSourceIdentifier</code> is encrypted, also specify the
|
|
449
442
|
* <code>PreSignedUrl</code> parameter.</p>
|
|
450
|
-
*
|
|
451
443
|
* <p>For more information on Amazon Aurora, see
|
|
452
444
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
453
|
-
* What
|
|
445
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
446
|
+
* </p>
|
|
447
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
448
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
449
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
454
450
|
* </p>
|
|
455
451
|
* <note>
|
|
456
|
-
* <p>
|
|
452
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
457
453
|
* </note>
|
|
458
454
|
*/
|
|
459
455
|
createDBCluster(args: CreateDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterCommandOutput>;
|
|
@@ -461,9 +457,9 @@ export declare class RDS extends RDSClient {
|
|
|
461
457
|
createDBCluster(args: CreateDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void;
|
|
462
458
|
/**
|
|
463
459
|
* <p>Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.</p>
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
*
|
|
460
|
+
* <note>
|
|
461
|
+
* <p>This action only applies to Aurora DB clusters.</p>
|
|
462
|
+
* </note>
|
|
467
463
|
*/
|
|
468
464
|
createDBClusterEndpoint(args: CreateDBClusterEndpointCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterEndpointCommandOutput>;
|
|
469
465
|
createDBClusterEndpoint(args: CreateDBClusterEndpointCommandInput, cb: (err: any, data?: CreateDBClusterEndpointCommandOutput) => void): void;
|
|
@@ -476,11 +472,14 @@ export declare class RDS extends RDSClient {
|
|
|
476
472
|
* database engine used by instances in the DB cluster. To provide custom values for any of the
|
|
477
473
|
* parameters, you must modify the group after creating it using
|
|
478
474
|
* <code>ModifyDBClusterParameterGroup</code>. Once you've created a DB cluster parameter group, you need to
|
|
479
|
-
* associate it with your DB cluster using <code>ModifyDBCluster</code
|
|
480
|
-
*
|
|
475
|
+
* associate it with your DB cluster using <code>ModifyDBCluster</code>.</p>
|
|
476
|
+
* <p>When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB
|
|
481
477
|
* instances in the DB cluster without failover for the new DB cluster parameter group and
|
|
482
478
|
* associated settings to take effect.
|
|
483
479
|
* </p>
|
|
480
|
+
* <p>When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB
|
|
481
|
+
* cluster without failover for the new DB cluster parameter group and associated settings to take effect.
|
|
482
|
+
* </p>
|
|
484
483
|
* <important>
|
|
485
484
|
* <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
|
|
486
485
|
* before creating your first DB cluster
|
|
@@ -493,25 +492,32 @@ export declare class RDS extends RDSClient {
|
|
|
493
492
|
* <code>DescribeDBClusterParameters</code> action to verify
|
|
494
493
|
* that your DB cluster parameter group has been created or modified.</p>
|
|
495
494
|
* </important>
|
|
496
|
-
*
|
|
497
495
|
* <p>For more information on Amazon Aurora, see
|
|
498
496
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
499
|
-
* What
|
|
497
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
498
|
+
* </p>
|
|
499
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
500
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
501
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
500
502
|
* </p>
|
|
501
503
|
* <note>
|
|
502
|
-
* <p>
|
|
504
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
503
505
|
* </note>
|
|
504
506
|
*/
|
|
505
507
|
createDBClusterParameterGroup(args: CreateDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterParameterGroupCommandOutput>;
|
|
506
508
|
createDBClusterParameterGroup(args: CreateDBClusterParameterGroupCommandInput, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void): void;
|
|
507
509
|
createDBClusterParameterGroup(args: CreateDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void): void;
|
|
508
510
|
/**
|
|
509
|
-
* <p>Creates a snapshot of a DB cluster
|
|
510
|
-
*
|
|
511
|
-
*
|
|
511
|
+
* <p>Creates a snapshot of a DB cluster.</p>
|
|
512
|
+
* <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon
|
|
513
|
+
* Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
514
|
+
* </p>
|
|
515
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
516
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
517
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
512
518
|
* </p>
|
|
513
519
|
* <note>
|
|
514
|
-
* <p>
|
|
520
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
515
521
|
* </note>
|
|
516
522
|
*/
|
|
517
523
|
createDBClusterSnapshot(args: CreateDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterSnapshotCommandOutput>;
|
|
@@ -707,13 +713,16 @@ export declare class RDS extends RDSClient {
|
|
|
707
713
|
* <p>The DeleteDBCluster action deletes a previously provisioned DB cluster.
|
|
708
714
|
* When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered.
|
|
709
715
|
* Manual DB cluster snapshots of the specified DB cluster are not deleted.</p>
|
|
710
|
-
* <p></p>
|
|
711
716
|
* <p>For more information on Amazon Aurora, see
|
|
712
717
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
713
|
-
* What
|
|
718
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
719
|
+
* </p>
|
|
720
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
721
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
722
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
714
723
|
* </p>
|
|
715
724
|
* <note>
|
|
716
|
-
* <p>
|
|
725
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
717
726
|
* </note>
|
|
718
727
|
*/
|
|
719
728
|
deleteDBCluster(args: DeleteDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBClusterCommandOutput>;
|
|
@@ -732,10 +741,14 @@ export declare class RDS extends RDSClient {
|
|
|
732
741
|
* <p>Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.</p>
|
|
733
742
|
* <p>For more information on Amazon Aurora, see
|
|
734
743
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
735
|
-
* What
|
|
744
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
745
|
+
* </p>
|
|
746
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
747
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
748
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
736
749
|
* </p>
|
|
737
750
|
* <note>
|
|
738
|
-
* <p>
|
|
751
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
739
752
|
* </note>
|
|
740
753
|
*/
|
|
741
754
|
deleteDBClusterParameterGroup(args: DeleteDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBClusterParameterGroupCommandOutput>;
|
|
@@ -749,10 +762,14 @@ export declare class RDS extends RDSClient {
|
|
|
749
762
|
* </note>
|
|
750
763
|
* <p>For more information on Amazon Aurora, see
|
|
751
764
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
752
|
-
* What
|
|
765
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
766
|
+
* </p>
|
|
767
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
768
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
769
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
753
770
|
* </p>
|
|
754
771
|
* <note>
|
|
755
|
-
* <p>
|
|
772
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
756
773
|
* </note>
|
|
757
774
|
*/
|
|
758
775
|
deleteDBClusterSnapshot(args: DeleteDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBClusterSnapshotCommandOutput>;
|
|
@@ -908,7 +925,7 @@ export declare class RDS extends RDSClient {
|
|
|
908
925
|
* <p>Returns information about backtracks for a DB cluster.</p>
|
|
909
926
|
* <p>For more information on Amazon Aurora, see
|
|
910
927
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
911
|
-
* What
|
|
928
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
912
929
|
* </p>
|
|
913
930
|
* <note>
|
|
914
931
|
* <p>This action only applies to Aurora MySQL DB clusters.</p>
|
|
@@ -934,10 +951,14 @@ export declare class RDS extends RDSClient {
|
|
|
934
951
|
* </p>
|
|
935
952
|
* <p>For more information on Amazon Aurora, see
|
|
936
953
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
937
|
-
* What
|
|
954
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
955
|
+
* </p>
|
|
956
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
957
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
958
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
938
959
|
* </p>
|
|
939
960
|
* <note>
|
|
940
|
-
* <p>
|
|
961
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
941
962
|
* </note>
|
|
942
963
|
*/
|
|
943
964
|
describeDBClusterParameterGroups(args: DescribeDBClusterParameterGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterParameterGroupsCommandOutput>;
|
|
@@ -947,24 +968,33 @@ export declare class RDS extends RDSClient {
|
|
|
947
968
|
* <p>Returns the detailed parameter list for a particular DB cluster parameter group.</p>
|
|
948
969
|
* <p>For more information on Amazon Aurora, see
|
|
949
970
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
950
|
-
* What
|
|
971
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
972
|
+
* </p>
|
|
973
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
974
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
975
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
951
976
|
* </p>
|
|
952
977
|
* <note>
|
|
953
|
-
* <p>
|
|
978
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
954
979
|
* </note>
|
|
955
980
|
*/
|
|
956
981
|
describeDBClusterParameters(args: DescribeDBClusterParametersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterParametersCommandOutput>;
|
|
957
982
|
describeDBClusterParameters(args: DescribeDBClusterParametersCommandInput, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void): void;
|
|
958
983
|
describeDBClusterParameters(args: DescribeDBClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void): void;
|
|
959
984
|
/**
|
|
960
|
-
* <p>Returns information about
|
|
961
|
-
* <p>For more information on Amazon Aurora, see
|
|
985
|
+
* <p>Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.</p>
|
|
986
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
962
987
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
963
|
-
* What
|
|
988
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
989
|
+
* </p>
|
|
990
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
991
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
992
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
964
993
|
* </p>
|
|
965
994
|
* <note>
|
|
966
|
-
* <p>
|
|
995
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
967
996
|
* </note>
|
|
997
|
+
* <p>This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.</p>
|
|
968
998
|
*/
|
|
969
999
|
describeDBClusters(args: DescribeDBClustersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClustersCommandOutput>;
|
|
970
1000
|
describeDBClusters(args: DescribeDBClustersCommandInput, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void): void;
|
|
@@ -978,21 +1008,22 @@ export declare class RDS extends RDSClient {
|
|
|
978
1008
|
* can be copied or restored by all Amazon Web Services accounts.</p>
|
|
979
1009
|
* <p>To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the
|
|
980
1010
|
* manual DB cluster snapshot public or private, use the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p>
|
|
981
|
-
* <note>
|
|
982
|
-
* <p>This action only applies to Aurora DB clusters.</p>
|
|
983
|
-
* </note>
|
|
984
1011
|
*/
|
|
985
1012
|
describeDBClusterSnapshotAttributes(args: DescribeDBClusterSnapshotAttributesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterSnapshotAttributesCommandOutput>;
|
|
986
1013
|
describeDBClusterSnapshotAttributes(args: DescribeDBClusterSnapshotAttributesCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void): void;
|
|
987
1014
|
describeDBClusterSnapshotAttributes(args: DescribeDBClusterSnapshotAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void): void;
|
|
988
1015
|
/**
|
|
989
1016
|
* <p>Returns information about DB cluster snapshots. This API action supports pagination.</p>
|
|
990
|
-
* <p>For more information on Amazon Aurora, see
|
|
1017
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
991
1018
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
992
|
-
* What
|
|
1019
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1020
|
+
* </p>
|
|
1021
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1022
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1023
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
993
1024
|
* </p>
|
|
994
1025
|
* <note>
|
|
995
|
-
* <p>
|
|
1026
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
996
1027
|
* </note>
|
|
997
1028
|
*/
|
|
998
1029
|
describeDBClusterSnapshots(args: DescribeDBClusterSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterSnapshotsCommandOutput>;
|
|
@@ -1112,7 +1143,7 @@ export declare class RDS extends RDSClient {
|
|
|
1112
1143
|
* <p>Returns the default engine and system parameter information for the cluster database engine.</p>
|
|
1113
1144
|
* <p>For more information on Amazon Aurora, see
|
|
1114
1145
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1115
|
-
* What
|
|
1146
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1116
1147
|
* </p>
|
|
1117
1148
|
*/
|
|
1118
1149
|
describeEngineDefaultClusterParameters(args: DescribeEngineDefaultClusterParametersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEngineDefaultClusterParametersCommandOutput>;
|
|
@@ -1165,7 +1196,7 @@ export declare class RDS extends RDSClient {
|
|
|
1165
1196
|
* Returns information about Aurora global database clusters. This API supports pagination.
|
|
1166
1197
|
* </p>
|
|
1167
1198
|
* <p>
|
|
1168
|
-
* For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What
|
|
1199
|
+
* For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the
|
|
1169
1200
|
* <i>Amazon Aurora User Guide.</i>
|
|
1170
1201
|
* </p>
|
|
1171
1202
|
* <note>
|
|
@@ -1195,7 +1226,7 @@ export declare class RDS extends RDSClient {
|
|
|
1195
1226
|
describeOptionGroups(args: DescribeOptionGroupsCommandInput, cb: (err: any, data?: DescribeOptionGroupsCommandOutput) => void): void;
|
|
1196
1227
|
describeOptionGroups(args: DescribeOptionGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOptionGroupsCommandOutput) => void): void;
|
|
1197
1228
|
/**
|
|
1198
|
-
* <p>Returns a list of orderable DB instance options for the specified engine.</p>
|
|
1229
|
+
* <p>Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.</p>
|
|
1199
1230
|
*/
|
|
1200
1231
|
describeOrderableDBInstanceOptions(args: DescribeOrderableDBInstanceOptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrderableDBInstanceOptionsCommandOutput>;
|
|
1201
1232
|
describeOrderableDBInstanceOptions(args: DescribeOrderableDBInstanceOptionsCommandInput, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void): void;
|
|
@@ -1243,18 +1274,26 @@ export declare class RDS extends RDSClient {
|
|
|
1243
1274
|
downloadDBLogFilePortion(args: DownloadDBLogFilePortionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DownloadDBLogFilePortionCommandOutput) => void): void;
|
|
1244
1275
|
/**
|
|
1245
1276
|
* <p>Forces a failover for a DB cluster.</p>
|
|
1246
|
-
* <p>
|
|
1247
|
-
* in the DB cluster to be the primary instance (the cluster writer).</p>
|
|
1248
|
-
* <p>
|
|
1249
|
-
*
|
|
1250
|
-
*
|
|
1277
|
+
* <p>For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)
|
|
1278
|
+
* in the DB cluster to be the primary DB instance (the cluster writer).</p>
|
|
1279
|
+
* <p>For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)
|
|
1280
|
+
* in the DB cluster to be the primary DB instance (the cluster writer).</p>
|
|
1281
|
+
* <p>An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,
|
|
1282
|
+
* when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby
|
|
1283
|
+
* DB instance when the primary DB instance fails.</p>
|
|
1284
|
+
* <p>To simulate a failure of a primary instance for testing, you can force a failover.
|
|
1285
|
+
* Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing
|
|
1251
1286
|
* connections that use those endpoint addresses when the failover is complete.</p>
|
|
1252
|
-
* <p>For more information on Amazon Aurora, see
|
|
1287
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
1253
1288
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1254
|
-
* What
|
|
1289
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1290
|
+
* </p>
|
|
1291
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1292
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1293
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
1255
1294
|
* </p>
|
|
1256
1295
|
* <note>
|
|
1257
|
-
* <p>
|
|
1296
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1258
1297
|
* </note>
|
|
1259
1298
|
*/
|
|
1260
1299
|
failoverDBCluster(args: FailoverDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<FailoverDBClusterCommandOutput>;
|
|
@@ -1359,22 +1398,26 @@ export declare class RDS extends RDSClient {
|
|
|
1359
1398
|
* API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for
|
|
1360
1399
|
* the <code>ModifyCustomDbEngineVersion</code> event.</p>
|
|
1361
1400
|
* </note>
|
|
1362
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.
|
|
1401
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.modify">Modifying CEV status</a>
|
|
1363
1402
|
* in the <i>Amazon RDS User Guide</i>.</p>
|
|
1364
1403
|
*/
|
|
1365
1404
|
modifyCustomDBEngineVersion(args: ModifyCustomDBEngineVersionCommandInput, options?: __HttpHandlerOptions): Promise<ModifyCustomDBEngineVersionCommandOutput>;
|
|
1366
1405
|
modifyCustomDBEngineVersion(args: ModifyCustomDBEngineVersionCommandInput, cb: (err: any, data?: ModifyCustomDBEngineVersionCommandOutput) => void): void;
|
|
1367
1406
|
modifyCustomDBEngineVersion(args: ModifyCustomDBEngineVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCustomDBEngineVersionCommandOutput) => void): void;
|
|
1368
1407
|
/**
|
|
1369
|
-
* <p>Modify
|
|
1370
|
-
* You can change one
|
|
1371
|
-
*
|
|
1372
|
-
*
|
|
1373
|
-
*
|
|
1374
|
-
* What
|
|
1408
|
+
* <p>Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster.
|
|
1409
|
+
* You can change one or more settings by specifying these parameters and the new values in the
|
|
1410
|
+
* request.</p>
|
|
1411
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
1412
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1413
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1414
|
+
* </p>
|
|
1415
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1416
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1417
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
1375
1418
|
* </p>
|
|
1376
1419
|
* <note>
|
|
1377
|
-
* <p>
|
|
1420
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1378
1421
|
* </note>
|
|
1379
1422
|
*/
|
|
1380
1423
|
modifyDBCluster(args: ModifyDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBClusterCommandOutput>;
|
|
@@ -1396,10 +1439,6 @@ export declare class RDS extends RDSClient {
|
|
|
1396
1439
|
* and <code>ApplyMethod</code>. A maximum of 20
|
|
1397
1440
|
* parameters can be modified in a single request.
|
|
1398
1441
|
* </p>
|
|
1399
|
-
* <p>For more information on Amazon Aurora, see
|
|
1400
|
-
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1401
|
-
* What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1402
|
-
* </p>
|
|
1403
1442
|
* <important>
|
|
1404
1443
|
* <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
|
|
1405
1444
|
* before creating your first DB cluster that uses that DB cluster parameter group as the default parameter
|
|
@@ -1415,8 +1454,16 @@ export declare class RDS extends RDSClient {
|
|
|
1415
1454
|
* your application must reopen any connections and retry any transactions that were active
|
|
1416
1455
|
* when the parameter changes took effect.</p>
|
|
1417
1456
|
* </important>
|
|
1457
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
1458
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1459
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1460
|
+
* </p>
|
|
1461
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1462
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1463
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
1464
|
+
* </p>
|
|
1418
1465
|
* <note>
|
|
1419
|
-
* <p>
|
|
1466
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1420
1467
|
* </note>
|
|
1421
1468
|
*/
|
|
1422
1469
|
modifyDBClusterParameterGroup(args: ModifyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBClusterParameterGroupCommandOutput>;
|
|
@@ -1442,9 +1489,6 @@ export declare class RDS extends RDSClient {
|
|
|
1442
1489
|
* <p>To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster
|
|
1443
1490
|
* snapshot, or whether a manual DB cluster snapshot is public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API action. The accounts are
|
|
1444
1491
|
* returned as values for the <code>restore</code> attribute.</p>
|
|
1445
|
-
* <note>
|
|
1446
|
-
* <p>This action only applies to Aurora DB clusters.</p>
|
|
1447
|
-
* </note>
|
|
1448
1492
|
*/
|
|
1449
1493
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBClusterSnapshotAttributeCommandOutput>;
|
|
1450
1494
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void): void;
|
|
@@ -1554,7 +1598,7 @@ export declare class RDS extends RDSClient {
|
|
|
1554
1598
|
* <p>
|
|
1555
1599
|
* Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration
|
|
1556
1600
|
* parameters by specifying these parameters and the new values in the request. For more information on
|
|
1557
|
-
* Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What
|
|
1601
|
+
* Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the
|
|
1558
1602
|
* <i>Amazon Aurora User Guide.</i>
|
|
1559
1603
|
* </p>
|
|
1560
1604
|
* <note>
|
|
@@ -1596,9 +1640,6 @@ export declare class RDS extends RDSClient {
|
|
|
1596
1640
|
promoteReadReplica(args: PromoteReadReplicaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PromoteReadReplicaCommandOutput) => void): void;
|
|
1597
1641
|
/**
|
|
1598
1642
|
* <p>Promotes a read replica DB cluster to a standalone DB cluster.</p>
|
|
1599
|
-
* <note>
|
|
1600
|
-
* <p>This action only applies to Aurora DB clusters.</p>
|
|
1601
|
-
* </note>
|
|
1602
1643
|
*/
|
|
1603
1644
|
promoteReadReplicaDBCluster(args: PromoteReadReplicaDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<PromoteReadReplicaDBClusterCommandOutput>;
|
|
1604
1645
|
promoteReadReplicaDBCluster(args: PromoteReadReplicaDBClusterCommandInput, cb: (err: any, data?: PromoteReadReplicaDBClusterCommandOutput) => void): void;
|
|
@@ -1609,6 +1650,29 @@ export declare class RDS extends RDSClient {
|
|
|
1609
1650
|
purchaseReservedDBInstancesOffering(args: PurchaseReservedDBInstancesOfferingCommandInput, options?: __HttpHandlerOptions): Promise<PurchaseReservedDBInstancesOfferingCommandOutput>;
|
|
1610
1651
|
purchaseReservedDBInstancesOffering(args: PurchaseReservedDBInstancesOfferingCommandInput, cb: (err: any, data?: PurchaseReservedDBInstancesOfferingCommandOutput) => void): void;
|
|
1611
1652
|
purchaseReservedDBInstancesOffering(args: PurchaseReservedDBInstancesOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseReservedDBInstancesOfferingCommandOutput) => void): void;
|
|
1653
|
+
/**
|
|
1654
|
+
* <p>You might need to reboot your DB cluster, usually for maintenance reasons.
|
|
1655
|
+
* For example, if you make certain modifications,
|
|
1656
|
+
* or if you change the DB cluster parameter group associated with the DB cluster,
|
|
1657
|
+
* reboot the DB cluster for the changes to take effect.
|
|
1658
|
+
* </p>
|
|
1659
|
+
*
|
|
1660
|
+
* <p>Rebooting a DB cluster restarts the database engine service. Rebooting a DB
|
|
1661
|
+
* cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
|
|
1662
|
+
* </p>
|
|
1663
|
+
*
|
|
1664
|
+
* <p>Use this operation only for a non-Aurora Multi-AZ DB cluster.
|
|
1665
|
+
* The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1666
|
+
*
|
|
1667
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1668
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1669
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the
|
|
1670
|
+
* <i>Amazon RDS User Guide.</i>
|
|
1671
|
+
* </p>
|
|
1672
|
+
*/
|
|
1673
|
+
rebootDBCluster(args: RebootDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<RebootDBClusterCommandOutput>;
|
|
1674
|
+
rebootDBCluster(args: RebootDBClusterCommandInput, cb: (err: any, data?: RebootDBClusterCommandOutput) => void): void;
|
|
1675
|
+
rebootDBCluster(args: RebootDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootDBClusterCommandOutput) => void): void;
|
|
1612
1676
|
/**
|
|
1613
1677
|
* <p>You might need to reboot your DB instance, usually for maintenance reasons.
|
|
1614
1678
|
* For example, if you make certain modifications,
|
|
@@ -1638,7 +1702,7 @@ export declare class RDS extends RDSClient {
|
|
|
1638
1702
|
* <p>
|
|
1639
1703
|
* Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a
|
|
1640
1704
|
* standalone cluster with read-write capability instead of being read-only and receiving data from a
|
|
1641
|
-
* primary cluster in a different
|
|
1705
|
+
* primary cluster in a different Region.
|
|
1642
1706
|
* </p>
|
|
1643
1707
|
* <note>
|
|
1644
1708
|
* <p>This action only applies to Aurora DB clusters.</p>
|
|
@@ -1648,11 +1712,18 @@ export declare class RDS extends RDSClient {
|
|
|
1648
1712
|
removeFromGlobalCluster(args: RemoveFromGlobalClusterCommandInput, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void): void;
|
|
1649
1713
|
removeFromGlobalCluster(args: RemoveFromGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void): void;
|
|
1650
1714
|
/**
|
|
1651
|
-
* <p>
|
|
1652
|
-
*
|
|
1653
|
-
*
|
|
1715
|
+
* <p>Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a
|
|
1716
|
+
* DB cluster.</p>
|
|
1717
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
1718
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1719
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1720
|
+
* </p>
|
|
1721
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1722
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1723
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
1724
|
+
* </p>
|
|
1654
1725
|
* <note>
|
|
1655
|
-
* <p>
|
|
1726
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1656
1727
|
* </note>
|
|
1657
1728
|
*/
|
|
1658
1729
|
removeRoleFromDBCluster(args: RemoveRoleFromDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<RemoveRoleFromDBClusterCommandOutput>;
|
|
@@ -1693,13 +1764,16 @@ export declare class RDS extends RDSClient {
|
|
|
1693
1764
|
* are set to <code>pending-reboot</code> to take effect on the next DB instance restart
|
|
1694
1765
|
* or <code>RebootDBInstance</code> request. You must call <code>RebootDBInstance</code> for every
|
|
1695
1766
|
* DB instance in your DB cluster that you want the updated static parameter to apply to.</p>
|
|
1696
|
-
*
|
|
1697
|
-
* <p>For more information on Amazon Aurora, see
|
|
1767
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
1698
1768
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1699
|
-
* What
|
|
1769
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1770
|
+
* </p>
|
|
1771
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1772
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1773
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
1700
1774
|
* </p>
|
|
1701
1775
|
* <note>
|
|
1702
|
-
* <p>
|
|
1776
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1703
1777
|
* </note>
|
|
1704
1778
|
*/
|
|
1705
1779
|
resetDBClusterParameterGroup(args: ResetDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<ResetDBClusterParameterGroupCommandOutput>;
|
|
@@ -1733,7 +1807,7 @@ export declare class RDS extends RDSClient {
|
|
|
1733
1807
|
* </note>
|
|
1734
1808
|
* <p>For more information on Amazon Aurora, see
|
|
1735
1809
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1736
|
-
* What
|
|
1810
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1737
1811
|
* </p>
|
|
1738
1812
|
* <note>
|
|
1739
1813
|
* <p>This action only applies to Aurora DB clusters. The source DB engine must be
|
|
@@ -1744,8 +1818,7 @@ export declare class RDS extends RDSClient {
|
|
|
1744
1818
|
restoreDBClusterFromS3(args: RestoreDBClusterFromS3CommandInput, cb: (err: any, data?: RestoreDBClusterFromS3CommandOutput) => void): void;
|
|
1745
1819
|
restoreDBClusterFromS3(args: RestoreDBClusterFromS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterFromS3CommandOutput) => void): void;
|
|
1746
1820
|
/**
|
|
1747
|
-
* <p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot
|
|
1748
|
-
* only applies to Aurora DB clusters.</p>
|
|
1821
|
+
* <p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot.</p>
|
|
1749
1822
|
* <p>The target DB cluster is created from the source snapshot with a default
|
|
1750
1823
|
* configuration. If you don't specify a security group, the new DB cluster is
|
|
1751
1824
|
* associated with the default security group.</p>
|
|
@@ -1757,12 +1830,16 @@ export declare class RDS extends RDSClient {
|
|
|
1757
1830
|
* the <code>RestoreDBClusterFromSnapshot</code> action has completed and the DB
|
|
1758
1831
|
* cluster is available.</p>
|
|
1759
1832
|
* </note>
|
|
1760
|
-
* <p>For more information on Amazon Aurora, see
|
|
1833
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
1761
1834
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1762
|
-
* What
|
|
1835
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1836
|
+
* </p>
|
|
1837
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1838
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1839
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
1763
1840
|
* </p>
|
|
1764
1841
|
* <note>
|
|
1765
|
-
* <p>
|
|
1842
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1766
1843
|
* </note>
|
|
1767
1844
|
*/
|
|
1768
1845
|
restoreDBClusterFromSnapshot(args: RestoreDBClusterFromSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<RestoreDBClusterFromSnapshotCommandOutput>;
|
|
@@ -1775,19 +1852,23 @@ export declare class RDS extends RDSClient {
|
|
|
1775
1852
|
* source DB cluster with the same configuration as the original DB cluster, except that
|
|
1776
1853
|
* the new DB cluster is created with the default DB security group. </p>
|
|
1777
1854
|
* <note>
|
|
1778
|
-
* <p>
|
|
1855
|
+
* <p>For Aurora, this action only restores the DB cluster, not the DB instances for that DB
|
|
1779
1856
|
* cluster. You must invoke the <code>CreateDBInstance</code> action to create DB
|
|
1780
1857
|
* instances for the restored DB cluster, specifying the identifier of the restored DB
|
|
1781
1858
|
* cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after
|
|
1782
1859
|
* the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB
|
|
1783
1860
|
* cluster is available.</p>
|
|
1784
1861
|
* </note>
|
|
1785
|
-
* <p>For more information on Amazon Aurora, see
|
|
1862
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
1786
1863
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
1787
|
-
* What
|
|
1864
|
+
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
|
|
1865
|
+
* </p>
|
|
1866
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
1867
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
1868
|
+
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
1788
1869
|
* </p>
|
|
1789
1870
|
* <note>
|
|
1790
|
-
* <p>
|
|
1871
|
+
* <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
|
|
1791
1872
|
* </note>
|
|
1792
1873
|
*/
|
|
1793
1874
|
restoreDBClusterToPointInTime(args: RestoreDBClusterToPointInTimeCommandInput, options?: __HttpHandlerOptions): Promise<RestoreDBClusterToPointInTimeCommandOutput>;
|