Skip to content

Commit 8ca8d96

Browse files
author
awstools
committed
docs(client-rds): Adds support for additional retention periods to Performance Insights.
1 parent 294fef4 commit 8ca8d96

20 files changed

+606
-334
lines changed

clients/client-rds/src/RDS.ts

Lines changed: 43 additions & 68 deletions
Large diffs are not rendered by default.

clients/client-rds/src/commands/BacktrackDBClusterCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface BacktrackDBClusterCommandOutput extends DBClusterBacktrack, __M
2929
* Backtracking an Aurora DB Cluster</a> in the
3030
* <i>Amazon Aurora User Guide</i>.</p>
3131
* <note>
32-
* <p>This action only applies to Aurora MySQL DB clusters.</p>
32+
* <p>This action applies only to Aurora MySQL DB clusters.</p>
3333
* </note>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.

clients/client-rds/src/commands/CopyDBClusterSnapshotCommand.ts

Lines changed: 9 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,11 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
2727
* <p>Copies a snapshot of a DB cluster.</p>
2828
* <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code>
2929
* must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p>
30-
* <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
31-
* 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,
32-
* you must provide the following values:</p>
30+
* <p>You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,
31+
* the Amazon Web Services Region where you call the <code>CopyDBClusterSnapshot</code> operation is the
32+
* destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy
33+
* an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the
34+
* following values:</p>
3335
* <ul>
3436
* <li>
3537
* <p>
@@ -38,49 +40,14 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
3840
* </li>
3941
* <li>
4042
* <p>
41-
* <code>PreSignedUrl</code> - A URL that contains a Signature Version 4 signed request for the
42-
* <code>CopyDBClusterSnapshot</code> action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from.
43-
* The pre-signed URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the
44-
* source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.</p>
45-
* <p>The pre-signed URL request must contain the following parameter values:</p>
46-
* <ul>
47-
* <li>
48-
* <p>
49-
* <code>KmsKeyId</code> - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB
50-
* cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code>
51-
* action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.</p>
52-
* </li>
53-
* <li>
54-
* <p>
55-
* <code>DestinationRegion</code> - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.</p>
56-
* </li>
57-
* <li>
58-
* <p>
59-
* <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster
60-
* snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example,
61-
* if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your <code>SourceDBClusterSnapshotIdentifier</code>
62-
* looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>.</p>
63-
* </li>
64-
* </ul>
65-
* <p>To learn how to generate a Signature Version 4 signed request, see
66-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html">
67-
* Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and
68-
* <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">
69-
* Signature Version 4 Signing Process</a>.</p>
70-
* <note>
71-
* <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)
72-
* instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid
73-
* request for the operation that can be executed in the source Amazon Web Services Region.</p>
74-
* </note>
75-
* </li>
76-
* <li>
77-
* <p>
7843
* <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.</p>
7944
* </li>
8045
* <li>
8146
* <p>
82-
* <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied.
83-
* 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>
47+
* <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot
48+
* identifier for the encrypted DB cluster snapshot to be copied. This identifier
49+
* must be in the ARN format for the source Amazon Web Services Region and is the same value as
50+
* the <code>SourceDBClusterSnapshotIdentifier</code> in the presigned URL.</p>
8451
* </li>
8552
* </ul>
8653
* <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified

clients/client-rds/src/commands/CopyDBSnapshotCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ export interface CopyDBSnapshotCommandOutput extends CopyDBSnapshotResult, __Met
2525

2626
/**
2727
* <p>Copies the specified DB snapshot. The source DB snapshot must be in the <code>available</code> state.</p>
28-
* <p>You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region
29-
* where you call the <code>CopyDBSnapshot</code> action is the destination Amazon Web Services Region for the
30-
* DB snapshot copy.</p>
28+
* <p>You can copy a snapshot from one Amazon Web Services Region to another. In that case, the
29+
* Amazon Web Services Region where you call the <code>CopyDBSnapshot</code> operation is the destination
30+
* Amazon Web Services Region for the DB snapshot copy.</p>
3131
* <p>This command doesn't apply to RDS Custom.</p>
3232
* <p>For more information about copying snapshots, see
3333
* <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>

clients/client-rds/src/commands/CreateDBClusterCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
2727
* <p>Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.</p>
2828
* <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon
2929
* Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
30-
* PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by
31-
* <code>ReplicationSourceIdentifier</code> is encrypted, also specify the
32-
* <code>PreSignedUrl</code> parameter.</p>
30+
* PostgreSQL DB instance.</p>
3331
* <p>For more information on Amazon Aurora, see
3432
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
3533
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>

clients/client-rds/src/commands/CreateDBClusterEndpointCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export interface CreateDBClusterEndpointCommandOutput extends DBClusterEndpoint,
2525
/**
2626
* <p>Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.</p>
2727
* <note>
28-
* <p>This action only applies to Aurora DB clusters.</p>
28+
* <p>This action applies only to Aurora DB clusters.</p>
2929
* </note>
3030
* @example
3131
* Use a bare-bones client and the command you need to make an API call.

clients/client-rds/src/commands/CreateDBClusterParameterGroupCommand.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@ export interface CreateDBClusterParameterGroupCommandOutput
3939
* cluster without failover for the new DB cluster parameter group and associated settings to take effect.</p>
4040
* <important>
4141
* <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
42-
* before creating your first DB cluster
43-
* that uses that DB cluster parameter group as the default parameter
44-
* group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter
45-
* group is used as the default for a new DB cluster. This is especially important for parameters
46-
* that are critical when creating the default database for a DB cluster, such as the character set
47-
* for the default database defined by the <code>character_set_database</code> parameter. You can use the
48-
* <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
49-
* <code>DescribeDBClusterParameters</code> action to verify
50-
* that your DB cluster parameter group has been created or modified.</p>
42+
* before creating your first DB cluster that uses that DB cluster parameter group as
43+
* the default parameter group. This allows Amazon RDS to fully complete the create
44+
* action before the DB cluster parameter group is used as the default for a new DB
45+
* cluster. This is especially important for parameters that are critical when creating
46+
* the default database for a DB cluster, such as the character set for the default
47+
* database defined by the <code>character_set_database</code> parameter. You can use
48+
* the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
49+
* <code>DescribeDBClusterParameters</code> operation to verify that your DB
50+
* cluster parameter group has been created or modified.</p>
5151
* </important>
5252
* <p>For more information on Amazon Aurora, see
5353
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">

clients/client-rds/src/commands/CreateDBInstanceCommand.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
2424

2525
/**
2626
* <p>Creates a new DB instance.</p>
27+
* <p>The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
28+
* For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance
29+
* to the cluster.</p>
30+
* <p>For more information about creating an RDS DB instance, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html">
31+
* Creating an Amazon RDS DB instance</a> in the <i>Amazon RDS User Guide</i>.</p>
32+
* <p>For more information about creating a DB instance in an Aurora DB cluster, see
33+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html">
34+
* Creating an Amazon Aurora DB cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
2735
* @example
2836
* Use a bare-bones client and the command you need to make an API call.
2937
* ```javascript

clients/client-rds/src/commands/CreateDBInstanceReadReplicaCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
2828
* instance. You can create a read replica for a DB instance running MySQL, MariaDB,
2929
* 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
3030
* Replicas</a> in the <i>Amazon RDS User Guide</i>.</p>
31-
* <p>Amazon Aurora doesn't support this action. Call the <code>CreateDBInstance</code>
32-
* action to create a DB instance for an Aurora DB cluster.</p>
31+
* <p>Amazon Aurora doesn't support this operation. Call the <code>CreateDBInstance</code>
32+
* operation to create a DB instance for an Aurora DB cluster.</p>
3333
* <p>All read replica DB instances are created with backups disabled. All other DB
3434
* instance attributes (including DB security groups and DB parameter groups) are inherited
3535
* from the source DB instance, except as specified.</p>

clients/client-rds/src/commands/CreateEventSubscriptionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface CreateEventSubscriptionCommandInput extends CreateEventSubscrip
2323
export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscriptionResult, __MetadataBearer {}
2424

2525
/**
26-
* <p>Creates an RDS event notification subscription. This action requires a topic Amazon
26+
* <p>Creates an RDS event notification subscription. This operation requires a topic Amazon
2727
* Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.
2828
* To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the
2929
* topic. The ARN is displayed in the SNS console.</p>

0 commit comments

Comments
 (0)