Skip to content

Commit

Permalink
docs(client-rds): Database Activity Stream support for RDS for SQL Se…
Browse files Browse the repository at this point in the history
…rver.
  • Loading branch information
awstools committed Feb 15, 2023
1 parent bedba23 commit 6c94c63
Show file tree
Hide file tree
Showing 31 changed files with 861 additions and 1,903 deletions.
149 changes: 78 additions & 71 deletions clients/client-rds/src/RDS.ts

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion clients/client-rds/src/commands/CancelExportTaskCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface CancelExportTaskCommandInput extends CancelExportTaskMessage {}
export interface CancelExportTaskCommandOutput extends ExportTask, __MetadataBearer {}

/**
* <p>Cancels an export task in progress that is exporting a snapshot to Amazon S3.
* <p>Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.
* Any data that has already been written to the S3 bucket isn't removed.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
* <p>For more information on Amazon Aurora DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
13 changes: 6 additions & 7 deletions clients/client-rds/src/commands/CreateDBClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,12 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
* <p>Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.</p>
* <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon
* Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
* PostgreSQL DB instance.</p>
* <p>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 <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* PostgreSQL DB instance. For more information about Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">What is Amazon Aurora?</a> in the <i>Amazon Aurora User
* Guide</i>.</p>
* <p>You can also use the <code>ReplicationSourceIdentifier</code> parameter to create a
* Multi-AZ DB cluster read replica with an RDS for PostgreSQL DB instance as the source.
* For more information about Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">Multi-AZ DB cluster deployments</a> in the <i>Amazon
* RDS User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ export interface CreateDBClusterParameterGroupCommandOutput
* <p>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 <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna
* <p>Creates a snapshot of a DB cluster.</p>
* <p>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 <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ export interface DeleteBlueGreenDeploymentCommandOutput extends DeleteBlueGreenD
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html">Using Amazon RDS Blue/Green Deployments
* for database updates</a> in the <i>Amazon RDS User Guide</i> and
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html">
* Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon Aurora
* User Guide</i>.</p>
* Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon Aurora
* User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ export interface DeleteCustomDBEngineVersionCommandOutput extends DBEngineVersio
* API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for
* the <code>DeleteCustomDbEngineVersion</code> event.</p>
* </note>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.delete">
* Deleting a CEV</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.delete">Deleting a
* CEV</a> in the <i>Amazon RDS User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
6 changes: 3 additions & 3 deletions clients/client-rds/src/commands/DeleteDBClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
* <p>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 <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe
* <p>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 <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
* <p>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 <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ export interface DescribeDBClusterParameterGroupsCommandOutput
* <p>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 <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam
* <p>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 <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
* <p>For more information on Amazon Aurora DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
6 changes: 3 additions & 3 deletions clients/client-rds/src/commands/DescribeDBClustersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
* <p>For more information on Amazon Aurora DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* <p>This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface DescribeExportTasksCommandInput extends DescribeExportTasksMess
export interface DescribeExportTasksCommandOutput extends ExportTasksMessage, __MetadataBearer {}

/**
* <p>Returns information about a snapshot export to Amazon S3. This API operation supports
* <p>Returns information about a snapshot or cluster export to Amazon S3. This API operation supports
* pagination.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
6 changes: 3 additions & 3 deletions clients/client-rds/src/commands/FailoverDBClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
* <p>For more information on Amazon Aurora DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface ModifyActivityStreamCommandOutput extends ModifyActivityStreamR
* whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,
* and then lock your activity stream. Restarting the activity stream isn't required. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Modifying.html"> Modifying a database activity stream</a> in the
* <i>Amazon RDS User Guide</i>. </p>
* <p>This operation is supported for RDS for Oracle only.</p>
* <p>This operation is supported for RDS for Oracle and Microsoft SQL Server.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
6 changes: 3 additions & 3 deletions clients/client-rds/src/commands/ModifyDBClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
* <p>For more information on Amazon Aurora DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ export interface ModifyDBClusterParameterGroupCommandOutput
* <p>For more information on Amazon Aurora DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide.</i>
* </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
7 changes: 3 additions & 4 deletions clients/client-rds/src/commands/RebootDBClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,9 @@ export interface RebootDBClusterCommandOutput extends RebootDBClusterResult, __M
* <p>Rebooting a DB cluster restarts the database engine service. Rebooting a DB
* cluster results in a momentary outage, during which the DB cluster status is set to rebooting.</p>
* <p>Use this operation only for a non-Aurora Multi-AZ DB cluster.</p>
* <p>For more information on Multi-AZ DB clusters, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
* Multi-AZ deployments with two readable standby DB instances</a> in the
* <i>Amazon RDS User Guide.</i>
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
* cluster deployments</a> in the <i>Amazon RDS User
* Guide.</i>
* </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Loading

0 comments on commit 6c94c63

Please sign in to comment.