From 6c94c63bd0226f48d1faafaa00bf4ac3c13ea237 Mon Sep 17 00:00:00 2001
From: awstools Cancels an export task in progress that is exporting a snapshot to Amazon S3.
+ * 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. For more information on Amazon Aurora DB clusters, see
*
* What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see
- *
- * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB
+ * cluster deployments in the Amazon RDS User
+ * Guide. Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. You can use the For more information on Amazon Aurora, see
- *
- * What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see
- *
- * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.ReplicationSourceIdentifier
parameter to create an Amazon
* Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
- * PostgreSQL DB instance.
You can also use the ReplicationSourceIdentifier
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 Multi-AZ DB cluster deployments in the Amazon
+ * RDS User Guide.
For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, @@ -1470,9 +1469,9 @@ export class RDS extends RDSClient { *Creates a snapshot of a DB cluster.
*For more information on Amazon Aurora, see What is Amazon * Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, @@ -1945,8 +1944,8 @@ export class RDS extends RDSClient { *For more information, see Using Amazon RDS Blue/Green Deployments * for database updates in the Amazon RDS User Guide and * - * Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora - * User Guide.
+ * Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora + * User Guide. */ public deleteBlueGreenDeployment( args: DeleteBlueGreenDeploymentCommandInput, @@ -1997,8 +1996,8 @@ export class RDS extends RDSClient { * API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for * theDeleteCustomDbEngineVersion
event.
*
- * For more information, see - * Deleting a CEV in the Amazon RDS User Guide.
+ *For more information, see Deleting a + * CEV in the Amazon RDS User Guide.
*/ public deleteCustomDBEngineVersion( args: DeleteCustomDBEngineVersionCommandInput, @@ -2036,9 +2035,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public deleteDBCluster( args: DeleteDBClusterCommandInput, @@ -2109,9 +2108,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, @@ -2151,9 +2150,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, @@ -2798,9 +2797,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, @@ -2836,9 +2835,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, @@ -2874,9 +2873,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
*/ public describeDBClusters( @@ -2952,9 +2951,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, @@ -3642,7 +3641,7 @@ export class RDS extends RDSClient { } /** - *Returns information about a snapshot export to Amazon S3. This API operation supports + *
Returns information about a snapshot or cluster export to Amazon S3. This API operation supports * pagination.
*/ public describeExportTasks( @@ -4024,9 +4023,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public failoverDBCluster( args: FailoverDBClusterCommandInput, @@ -4141,7 +4140,7 @@ export class RDS extends RDSClient { * 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 Modifying a database activity stream in the * Amazon RDS User Guide. - *This operation is supported for RDS for Oracle only.
+ *This operation is supported for RDS for Oracle and Microsoft SQL Server.
*/ public modifyActivityStream( args: ModifyActivityStreamCommandInput, @@ -4326,9 +4325,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*/ public modifyDBCluster( args: ModifyDBClusterCommandInput, @@ -4417,9 +4416,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
*/ public modifyDBClusterParameterGroup( @@ -5022,10 +5021,9 @@ export class RDS extends RDSClient { *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.
*Use this operation only for a non-Aurora Multi-AZ DB cluster.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the - * Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
*/ public rebootDBCluster( @@ -5173,9 +5171,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
*/ public removeRoleFromDBCluster( @@ -5322,9 +5320,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
*/ public resetDBClusterParameterGroup( @@ -5461,9 +5459,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
*/ public restoreDBClusterFromSnapshot( @@ -5512,9 +5510,9 @@ export class RDS extends RDSClient { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
*/ public restoreDBClusterToPointInTime( @@ -5871,9 +5869,18 @@ export class RDS extends RDSClient { } /** - *Starts an export of a snapshot to Amazon S3. + *
Starts an export of DB snapshot or DB cluster data to Amazon S3. * The provided IAM role must have access to the S3 bucket.
- *This command doesn't apply to RDS Custom.
+ *You can't export snapshot data from RDS Custom DB instances.
+ *You can't export cluster data from Multi-AZ DB clusters.
+ *For more information on exporting DB snapshot data, see + * Exporting DB snapshot + * data to Amazon S3 in the Amazon RDS User Guide + * or Exporting DB + * cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
+ *For more information on exporting DB cluster data, see + * Exporting DB + * cluster data to Amazon S3 in the Amazon Aurora User Guide.
*/ public startExportTask( args: StartExportTaskCommandInput, diff --git a/clients/client-rds/src/commands/CancelExportTaskCommand.ts b/clients/client-rds/src/commands/CancelExportTaskCommand.ts index 894fed01a2b6..b25fcfd5932c 100644 --- a/clients/client-rds/src/commands/CancelExportTaskCommand.ts +++ b/clients/client-rds/src/commands/CancelExportTaskCommand.ts @@ -29,7 +29,7 @@ export interface CancelExportTaskCommandInput extends CancelExportTaskMessage {} export interface CancelExportTaskCommandOutput extends ExportTask, __MetadataBearer {} /** - *Cancels an export task in progress that is exporting a snapshot to Amazon S3. + *
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.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-rds/src/commands/CopyDBClusterSnapshotCommand.ts b/clients/client-rds/src/commands/CopyDBClusterSnapshotCommand.ts index 45711e3d6b7f..ad7d039b0a2d 100644 --- a/clients/client-rds/src/commands/CopyDBClusterSnapshotCommand.ts +++ b/clients/client-rds/src/commands/CopyDBClusterSnapshotCommand.ts @@ -64,9 +64,9 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/CreateDBClusterCommand.ts b/clients/client-rds/src/commands/CreateDBClusterCommand.ts index 1de58e3dba0e..f4c9e6f65aef 100644 --- a/clients/client-rds/src/commands/CreateDBClusterCommand.ts +++ b/clients/client-rds/src/commands/CreateDBClusterCommand.ts @@ -33,13 +33,12 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M *Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
*You can use the ReplicationSourceIdentifier
parameter to create an Amazon
* Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
- * PostgreSQL DB instance.
For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ * PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User + * Guide. + *You can also use the ReplicationSourceIdentifier
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 Multi-AZ DB cluster deployments in the Amazon
+ * RDS User Guide.
For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/CreateDBClusterSnapshotCommand.ts b/clients/client-rds/src/commands/CreateDBClusterSnapshotCommand.ts index c11bbf219b33..cb427be497b4 100644 --- a/clients/client-rds/src/commands/CreateDBClusterSnapshotCommand.ts +++ b/clients/client-rds/src/commands/CreateDBClusterSnapshotCommand.ts @@ -32,9 +32,9 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna *Creates a snapshot of a DB cluster.
*For more information on Amazon Aurora, see What is Amazon * Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DeleteBlueGreenDeploymentCommand.ts b/clients/client-rds/src/commands/DeleteBlueGreenDeploymentCommand.ts index 05e0ba624f07..afacd5baa591 100644 --- a/clients/client-rds/src/commands/DeleteBlueGreenDeploymentCommand.ts +++ b/clients/client-rds/src/commands/DeleteBlueGreenDeploymentCommand.ts @@ -33,8 +33,8 @@ export interface DeleteBlueGreenDeploymentCommandOutput extends DeleteBlueGreenD *For more information, see Using Amazon RDS Blue/Green Deployments * for database updates in the Amazon RDS User Guide and * - * Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora - * User Guide.
+ * Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora + * User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DeleteCustomDBEngineVersionCommand.ts b/clients/client-rds/src/commands/DeleteCustomDBEngineVersionCommand.ts index 9271c92cae3f..2cf407603ea4 100644 --- a/clients/client-rds/src/commands/DeleteCustomDBEngineVersionCommand.ts +++ b/clients/client-rds/src/commands/DeleteCustomDBEngineVersionCommand.ts @@ -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 * theDeleteCustomDbEngineVersion
event.
*
- * For more information, see - * Deleting a CEV in the Amazon RDS User Guide.
+ *For more information, see Deleting a + * CEV in the Amazon RDS User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DeleteDBClusterCommand.ts b/clients/client-rds/src/commands/DeleteDBClusterCommand.ts index 1bd842494c77..640f8b3f1fc9 100644 --- a/clients/client-rds/src/commands/DeleteDBClusterCommand.ts +++ b/clients/client-rds/src/commands/DeleteDBClusterCommand.ts @@ -35,9 +35,9 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DeleteDBClusterParameterGroupCommand.ts b/clients/client-rds/src/commands/DeleteDBClusterParameterGroupCommand.ts index d83aec72a9a8..2a3497838cf3 100644 --- a/clients/client-rds/src/commands/DeleteDBClusterParameterGroupCommand.ts +++ b/clients/client-rds/src/commands/DeleteDBClusterParameterGroupCommand.ts @@ -31,9 +31,9 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DeleteDBClusterSnapshotCommand.ts b/clients/client-rds/src/commands/DeleteDBClusterSnapshotCommand.ts index 21b531abd1d6..690e22076283 100644 --- a/clients/client-rds/src/commands/DeleteDBClusterSnapshotCommand.ts +++ b/clients/client-rds/src/commands/DeleteDBClusterSnapshotCommand.ts @@ -37,9 +37,9 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DescribeDBClusterParameterGroupsCommand.ts b/clients/client-rds/src/commands/DescribeDBClusterParameterGroupsCommand.ts index 73af0ec310eb..a0bc449d18b9 100644 --- a/clients/client-rds/src/commands/DescribeDBClusterParameterGroupsCommand.ts +++ b/clients/client-rds/src/commands/DescribeDBClusterParameterGroupsCommand.ts @@ -37,9 +37,9 @@ export interface DescribeDBClusterParameterGroupsCommandOutput *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DescribeDBClusterParametersCommand.ts b/clients/client-rds/src/commands/DescribeDBClusterParametersCommand.ts index 2ac7ac3a4423..0dc4d55e553a 100644 --- a/clients/client-rds/src/commands/DescribeDBClusterParametersCommand.ts +++ b/clients/client-rds/src/commands/DescribeDBClusterParametersCommand.ts @@ -33,9 +33,9 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam *For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DescribeDBClusterSnapshotsCommand.ts b/clients/client-rds/src/commands/DescribeDBClusterSnapshotsCommand.ts index 13c3411d7f36..ea589c735b20 100644 --- a/clients/client-rds/src/commands/DescribeDBClusterSnapshotsCommand.ts +++ b/clients/client-rds/src/commands/DescribeDBClusterSnapshotsCommand.ts @@ -33,9 +33,9 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DescribeDBClustersCommand.ts b/clients/client-rds/src/commands/DescribeDBClustersCommand.ts index 66f16f998781..597eaca4404d 100644 --- a/clients/client-rds/src/commands/DescribeDBClustersCommand.ts +++ b/clients/client-rds/src/commands/DescribeDBClustersCommand.ts @@ -33,9 +33,9 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-rds/src/commands/DescribeExportTasksCommand.ts b/clients/client-rds/src/commands/DescribeExportTasksCommand.ts index 22ac72f8d132..405f0d425057 100644 --- a/clients/client-rds/src/commands/DescribeExportTasksCommand.ts +++ b/clients/client-rds/src/commands/DescribeExportTasksCommand.ts @@ -29,7 +29,7 @@ export interface DescribeExportTasksCommandInput extends DescribeExportTasksMess export interface DescribeExportTasksCommandOutput extends ExportTasksMessage, __MetadataBearer {} /** - *Returns information about a snapshot export to Amazon S3. This API operation supports + *
Returns information about a snapshot or cluster export to Amazon S3. This API operation supports * pagination.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-rds/src/commands/FailoverDBClusterCommand.ts b/clients/client-rds/src/commands/FailoverDBClusterCommand.ts index c30aca37092f..373cf0ce0100 100644 --- a/clients/client-rds/src/commands/FailoverDBClusterCommand.ts +++ b/clients/client-rds/src/commands/FailoverDBClusterCommand.ts @@ -43,9 +43,9 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult, *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/ModifyActivityStreamCommand.ts b/clients/client-rds/src/commands/ModifyActivityStreamCommand.ts index a34d2c0d9d40..019c746f610f 100644 --- a/clients/client-rds/src/commands/ModifyActivityStreamCommand.ts +++ b/clients/client-rds/src/commands/ModifyActivityStreamCommand.ts @@ -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 Modifying a database activity stream in the * Amazon RDS User Guide. - *This operation is supported for RDS for Oracle only.
+ *This operation is supported for RDS for Oracle and Microsoft SQL Server.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/ModifyDBClusterCommand.ts b/clients/client-rds/src/commands/ModifyDBClusterCommand.ts index dcedc6f7b2f9..aa58aaf31086 100644 --- a/clients/client-rds/src/commands/ModifyDBClusterCommand.ts +++ b/clients/client-rds/src/commands/ModifyDBClusterCommand.ts @@ -35,9 +35,9 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/ModifyDBClusterParameterGroupCommand.ts b/clients/client-rds/src/commands/ModifyDBClusterParameterGroupCommand.ts index 45a0329cd218..ababe1dd2627 100644 --- a/clients/client-rds/src/commands/ModifyDBClusterParameterGroupCommand.ts +++ b/clients/client-rds/src/commands/ModifyDBClusterParameterGroupCommand.ts @@ -53,9 +53,9 @@ export interface ModifyDBClusterParameterGroupCommandOutput *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-rds/src/commands/RebootDBClusterCommand.ts b/clients/client-rds/src/commands/RebootDBClusterCommand.ts index 4796a22e5e06..784c24d603c3 100644 --- a/clients/client-rds/src/commands/RebootDBClusterCommand.ts +++ b/clients/client-rds/src/commands/RebootDBClusterCommand.ts @@ -36,10 +36,9 @@ export interface RebootDBClusterCommandOutput extends RebootDBClusterResult, __M *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.
*Use this operation only for a non-Aurora Multi-AZ DB cluster.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the - * Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-rds/src/commands/RemoveRoleFromDBClusterCommand.ts b/clients/client-rds/src/commands/RemoveRoleFromDBClusterCommand.ts index fa568fec0ee2..6813684cf046 100644 --- a/clients/client-rds/src/commands/RemoveRoleFromDBClusterCommand.ts +++ b/clients/client-rds/src/commands/RemoveRoleFromDBClusterCommand.ts @@ -29,9 +29,9 @@ export interface RemoveRoleFromDBClusterCommandOutput extends __MetadataBearer { *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-rds/src/commands/ResetDBClusterParameterGroupCommand.ts b/clients/client-rds/src/commands/ResetDBClusterParameterGroupCommand.ts index b694369f5ffb..71aef684daf4 100644 --- a/clients/client-rds/src/commands/ResetDBClusterParameterGroupCommand.ts +++ b/clients/client-rds/src/commands/ResetDBClusterParameterGroupCommand.ts @@ -43,9 +43,9 @@ export interface ResetDBClusterParameterGroupCommandOutput *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-rds/src/commands/RestoreDBClusterFromSnapshotCommand.ts b/clients/client-rds/src/commands/RestoreDBClusterFromSnapshotCommand.ts index 142ad04e6c58..e377a091281c 100644 --- a/clients/client-rds/src/commands/RestoreDBClusterFromSnapshotCommand.ts +++ b/clients/client-rds/src/commands/RestoreDBClusterFromSnapshotCommand.ts @@ -46,9 +46,9 @@ export interface RestoreDBClusterFromSnapshotCommandOutput *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts b/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts index 29c32a1766d8..198ca943d08a 100644 --- a/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts +++ b/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts @@ -47,9 +47,9 @@ export interface RestoreDBClusterToPointInTimeCommandOutput *For more information on Amazon Aurora DB clusters, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. + *
For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-rds/src/commands/StartExportTaskCommand.ts b/clients/client-rds/src/commands/StartExportTaskCommand.ts index 52a89f150d6f..e97c668acafc 100644 --- a/clients/client-rds/src/commands/StartExportTaskCommand.ts +++ b/clients/client-rds/src/commands/StartExportTaskCommand.ts @@ -25,9 +25,18 @@ export interface StartExportTaskCommandInput extends StartExportTaskMessage {} export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBearer {} /** - *Starts an export of a snapshot to Amazon S3. + *
Starts an export of DB snapshot or DB cluster data to Amazon S3. * The provided IAM role must have access to the S3 bucket.
- *This command doesn't apply to RDS Custom.
+ *You can't export snapshot data from RDS Custom DB instances.
+ *You can't export cluster data from Multi-AZ DB clusters.
+ *For more information on exporting DB snapshot data, see + * Exporting DB snapshot + * data to Amazon S3 in the Amazon RDS User Guide + * or Exporting DB + * cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
+ *For more information on exporting DB cluster data, see + * Exporting DB + * cluster data to Amazon S3 in the Amazon Aurora User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/endpoint/EndpointParameters.ts b/clients/client-rds/src/endpoint/EndpointParameters.ts index 4966cbbb106d..32af50e72ad9 100644 --- a/clients/client-rds/src/endpoint/EndpointParameters.ts +++ b/clients/client-rds/src/endpoint/EndpointParameters.ts @@ -24,7 +24,7 @@ export const resolveClientEndpointParameters =The identifier of the snapshot export task to cancel.
+ *The identifier of the snapshot or cluster export task to cancel.
*/ ExportTaskIdentifier: string | undefined; } @@ -1098,23 +1098,23 @@ export enum ExportSourceType { } /** - *Contains the details of a snapshot export to Amazon S3.
+ *Contains the details of a snapshot or cluster export to Amazon S3.
*This data type is used as a response element in the DescribeExportTasks
action.
A unique identifier for the snapshot export task. This ID isn't an identifier for - * the Amazon S3 bucket where the snapshot is exported to.
+ *A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for + * the Amazon S3 bucket where the data is exported.
*/ ExportTaskIdentifier?: string; /** - *The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
+ *The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
*/ SourceArn?: string; /** - *The data exported from the snapshot. Valid values are the following:
+ *The data exported from the snapshot or cluster. Valid values are the following:
*@@ -1124,12 +1124,12 @@ export interface ExportTask { *
* database.table
* table-name -
- * Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
* database.schema
- * schema-name - Export a database schema of the snapshot.
+ * schema-name - Export a database schema of the snapshot or cluster.
* This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The time that the snapshot export task started.
+ *The time that the snapshot or cluster export task started.
*/ TaskStartTime?: Date; /** - *The time that the snapshot export task completed.
+ *The time that the snapshot or cluster export task ended.
*/ TaskEndTime?: Date; /** - *The Amazon S3 bucket that the snapshot is exported to.
+ *The Amazon S3 bucket that the snapshot or cluster is exported to.
*/ S3Bucket?: string; /** - *The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
+ *The Amazon S3 bucket prefix that is the file name and path of the exported data.
*/ S3Prefix?: string; /** - *The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
+ *The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
*/ IamRoleArn?: string; /** - *The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to - * Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export + *
The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. + * The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export * must have encryption and decryption permissions to use this KMS key.
*/ KmsKeyId?: string; /** - *The progress status of the export task.
+ *The progress status of the export task. The status can be one of the following:
+ *
+ * CANCELED
+ *
+ * CANCELING
+ *
+ * COMPLETE
+ *
+ * FAILED
+ *
+ * IN_PROGRESS
+ *
+ * STARTING
+ *
The progress of the snapshot export task as a percentage.
+ *The progress of the snapshot or cluster export task as a percentage.
*/ PercentProgress?: number; @@ -1200,7 +1232,7 @@ export interface ExportTask { FailureCause?: string; /** - *A warning about the snapshot export task.
+ *A warning about the snapshot or cluster export task.
*/ WarningMessage?: string; @@ -3849,7 +3881,7 @@ export interface CreateDBClusterMessage { /** *The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB * cluster is created as a read replica.
- *Valid for: Aurora DB clusters only
+ *Valid for: Aurora DB clusters and RDS for PostgreSQL Multi-AZ DB clusters
*/ ReplicationSourceIdentifier?: string; @@ -8573,8 +8605,8 @@ export interface CreateDBInstanceReadReplicaMessage { *The amount of storage (in gibibytes) to allocate initially for the read replica.
* Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough memory for your read replica so that the create operation can succeed. - * You can also allocate additional memory for future growth.
+ *Be sure to allocate enough storage for your read replica so that the create operation can succeed. + * You can also allocate additional storage for future growth.
*A value that indicates whether to delete the resources in the green environment.
+ *A value that indicates whether to delete the resources in the green environment. You
+ * can't specify this option if the blue/green deployment status
+ * is SWITCHOVER_COMPLETED
.
The identifier of the snapshot export task to be described.
+ *The identifier of the snapshot or cluster export task to be described.
*/ ExportTaskIdentifier?: string; /** - *The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
+ *The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
*/ SourceArn?: string; /** - *Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to + *
Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to * include in the output. Filter names and values are case-sensitive.
*Supported filters include the following:
*
- * export-task-identifier
- An identifier for the snapshot export task.
export-task-identifier
- An identifier for the snapshot or cluster export task.
*
- * s3-bucket
- The Amazon S3 bucket the snapshot is exported to.
s3-bucket
- The Amazon S3 bucket the data is exported to.
*
- * source-arn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
source-arn
- The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
* @@ -1499,7 +1499,7 @@ export interface ExportTasksMessage { Marker?: string; /** - *
Information about an export of a snapshot to Amazon S3.
+ *Information about an export of a snapshot or cluster to Amazon S3.
*/ ExportTasks?: ExportTask[]; } @@ -3195,8 +3195,8 @@ export enum AuditPolicyState { export interface ModifyActivityStreamRequest { /** - *The Amazon Resource Name (ARN) of the RDS for Oracle DB instance,
- * for example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db
.
The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.
+ * For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db
.
The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
- *For more information on Multi-AZ DB clusters, see - * - * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
+ *For more information on Multi-AZ DB clusters, see Multi-AZ DB + * cluster deployments in the Amazon RDS User + * Guide.
*Constraints:
*The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in * CreateDBInstance.
*Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also - * allocate additional memory for future growth.
+ *Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also + * allocate additional storage for future growth.
*The amount of storage (in gibibytes) to allocate initially for the DB instance.
* Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. - * You can also allocate additional memory for future growth.
+ *Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. + * You can also allocate additional storage for future growth.
*The amount of storage (in gibibytes) to allocate initially for the DB instance.
* Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. - * You can also allocate additional memory for future growth.
+ *Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. + * You can also allocate additional storage for future growth.
*Specifies whether the database activity stream includes engine-native audit fields. This option only applies - * to an Oracle DB instance. By default, no engine-native audit fields are included.
+ *Specifies whether the database activity stream includes engine-native audit fields. This option applies + * to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
*/ EngineNativeAuditFieldsIncluded?: boolean; } @@ -9140,29 +9140,29 @@ export class InvalidExportSourceStateFault extends __BaseException { export interface StartExportTaskMessage { /** - *A unique identifier for the snapshot export task. This ID isn't an identifier for - * the Amazon S3 bucket where the snapshot is to be exported to.
+ *A unique identifier for the export task. This ID isn't an identifier for + * the Amazon S3 bucket where the data is to be exported.
*/ ExportTaskIdentifier: string | undefined; /** - *The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
+ *The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
*/ SourceArn: string | undefined; /** - *The name of the Amazon S3 bucket to export the snapshot to.
+ *The name of the Amazon S3 bucket to export the snapshot or cluster data to.
*/ S3BucketName: string | undefined; /** *The name of the IAM role to use for writing to the Amazon S3 bucket - * when exporting a snapshot.
+ * when exporting a snapshot or cluster. */ IamRoleArn: string | undefined; /** - *The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS + *
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS * key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * The caller of this operation must be authorized to run the following operations. * These can be set in the Amazon Web Services KMS key policy:
@@ -9199,13 +9199,13 @@ export interface StartExportTaskMessage { KmsKeyId: string | undefined; /** - *The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
+ *The Amazon S3 bucket prefix to use as the file name and path of the exported data.
*/ S3Prefix?: string; /** - *The data to be exported from the snapshot. - * If this parameter is not provided, all the snapshot data is exported. + *
The data to be exported from the snapshot or cluster. + * If this parameter is not provided, all of the data is exported. * Valid values are the following:
*
* database.table
* table-name -
- * Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
* database.schema
- * schema-name - Export a database schema of the snapshot.
+ * schema-name - Export a database schema of the snapshot or cluster.
* This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Cancels an export task in progress that is exporting a snapshot to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.
" + "smithy.api#documentation": "Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.
" } }, "com.amazonaws.rds#CancelExportTaskMessage": { @@ -3665,7 +2456,7 @@ "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the snapshot export task to cancel.
", + "smithy.api#documentation": "The identifier of the snapshot or cluster export task to cancel.
", "smithy.api#required": {} } } @@ -4083,7 +2874,7 @@ } ], "traits": { - "smithy.api#documentation": "Copies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier
\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot
operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:
\n KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier
in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Copies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier
\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot
operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:
\n KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier
in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" } }, "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { @@ -4452,6 +3243,9 @@ "smithy.api#documentation": "Tags to assign to the blue/green deployment.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateBlueGreenDeploymentResponse": { @@ -4460,6 +3254,9 @@ "BlueGreenDeployment": { "target": "com.amazonaws.rds#BlueGreenDeployment" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#CreateCustomDBEngineVersion": { @@ -4611,7 +3408,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
\nYou can use the ReplicationSourceIdentifier
parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or\n PostgreSQL DB instance.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
\nYou can use the ReplicationSourceIdentifier
parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or\n PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User\n Guide.
You can also use the ReplicationSourceIdentifier
parameter to create a\n Multi-AZ DB cluster read replica with an RDS for PostgreSQL DB instance as the source.\n For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon\n RDS User Guide.
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.
\nValid for: Aurora DB clusters and RDS for PostgreSQL Multi-AZ DB clusters
" } }, "Tags": { @@ -5008,7 +3805,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB cluster parameter group.
\nParameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
\nA DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup
. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster
.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.
\nWhen you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.
\nAfter you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database
parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters
operation to verify that your DB\n cluster parameter group has been created or modified.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Creates a new DB cluster parameter group.
\nParameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
\nA DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup
. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster
.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.
\nWhen you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.
\nAfter you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database
parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters
operation to verify that your DB\n cluster parameter group has been created or modified.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" } }, "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { @@ -5088,7 +3885,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a snapshot of a DB cluster.
\nFor more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Creates a snapshot of a DB cluster.
\nFor more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" } }, "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { @@ -5840,7 +4637,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of storage (in gibibytes) to allocate initially for the read replica.\n Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough memory for your read replica so that the create operation can succeed.\n You can also allocate additional memory for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the read replica.\n Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough storage for your read replica so that the create operation can succeed.\n You can also allocate additional storage for future growth.
\nThe DBProxyEndpoint
object that is created by the API operation.\n The DB proxy endpoint that you create might provide capabilities such as read/write\n or read-only operations, or using a different VPC than the proxy's default VPC.
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBProxyResponse": { @@ -6109,6 +4915,9 @@ "smithy.api#documentation": "The DBProxy
structure corresponding to the new proxy.
Deletes a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "Deletes a blue/green deployment.
\nFor more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.
" } }, "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest": { @@ -10708,9 +9517,12 @@ "DeleteTarget": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to delete the resources in the green environment.
" + "smithy.api#documentation": "A value that indicates whether to delete the resources in the green environment. You\n can't specify this option if the blue/green deployment status\n is SWITCHOVER_COMPLETED
.
Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
\nThe CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.
\nThe CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.
\nTypically, deletion takes a few minutes.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion
event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion
event.
For more information, see \n Deleting a CEV in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
\nThe CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.
\nThe CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.
\nTypically, deletion takes a few minutes.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion
event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion
event.
For more information, see Deleting a\n CEV in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage": { @@ -10786,7 +9601,7 @@ } ], "traits": { - "smithy.api#documentation": "The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" } }, "com.amazonaws.rds#DeleteDBClusterEndpoint": { @@ -10869,7 +9684,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" } }, "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { @@ -10912,7 +9727,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
\nThe DB cluster snapshot must be in the available
state to be\n deleted.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
\nThe DB cluster snapshot must be in the available
state to be\n deleted.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" } }, "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { @@ -11145,6 +9960,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBProxyEndpointResponse": { @@ -11156,6 +9974,9 @@ "smithy.api#documentation": "The data structure representing the details of the DB proxy endpoint that you delete.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#DeleteDBProxyRequest": { @@ -11168,6 +9989,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBProxyResponse": { @@ -11179,6 +10003,9 @@ "smithy.api#documentation": "The data structure representing the details of the DB proxy that you delete.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#DeleteDBSecurityGroup": { @@ -11469,11 +10296,17 @@ "smithy.api#documentation": "One or more DB cluster identifiers.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DeregisterDBProxyTargetsResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rds#DescribeAccountAttributes": { "type": "operation", @@ -11544,6 +10377,9 @@ "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords
value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse": { @@ -11561,6 +10397,9 @@ "smithy.api#documentation": "A pagination token that can be used in a later DescribeBlueGreenDeployments request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#DescribeCertificates": { @@ -11755,7 +10594,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of DBClusterParameterGroup
descriptions. If a \n DBClusterParameterGroupName
parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", + "smithy.api#documentation": "Returns a list of DBClusterParameterGroup
descriptions. If a \n DBClusterParameterGroupName
parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11810,7 +10649,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the detailed parameter list for a particular DB cluster parameter group.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", + "smithy.api#documentation": "Returns the detailed parameter list for a particular DB cluster parameter group.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11912,7 +10751,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about DB cluster snapshots. This API action supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", + "smithy.api#documentation": "Returns information about DB cluster snapshots. This API action supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12121,7 +10960,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
", + "smithy.api#documentation": "Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12762,7 +11601,8 @@ } }, "traits": { - "smithy.api#documentation": "The response from a call to DescribeDBLogFiles
.
The response from a call to DescribeDBLogFiles
.
The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords
value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBProxiesResponse": { @@ -12946,6 +11789,9 @@ "smithy.api#documentation": "An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords
.
The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords
value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBProxyEndpointsResponse": { @@ -13024,6 +11873,9 @@ "smithy.api#documentation": "An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords
.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords
value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse": { @@ -13106,6 +11961,9 @@ "smithy.api#documentation": "An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords
.
The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords
value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBProxyTargetsResponse": { @@ -13191,6 +12052,9 @@ "smithy.api#documentation": "An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords
.
Returns information about a snapshot export to Amazon S3. This API operation supports\n pagination.
", + "smithy.api#documentation": "Returns information about a snapshot or cluster export to Amazon S3. This API operation supports\n pagination.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13867,19 +12731,19 @@ "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the snapshot export task to be described.
" + "smithy.api#documentation": "The identifier of the snapshot or cluster export task to be described.
" } }, "SourceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.
\nSupported filters include the following:
\n\n export-task-identifier
- An identifier for the snapshot export task.
\n s3-bucket
- The Amazon S3 bucket the snapshot is exported to.
\n source-arn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
\n status
- The status of the export task. Must be lowercase. Valid statuses are the following:
\n canceled
\n
\n canceling
\n
\n complete
\n
\n failed
\n
\n in_progress
\n
\n starting
\n
Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.
\nSupported filters include the following:
\n\n export-task-identifier
- An identifier for the snapshot or cluster export task.
\n s3-bucket
- The Amazon S3 bucket the data is exported to.
\n source-arn
- The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
\n status
- The status of the export task. Must be lowercase. Valid statuses are the following:
\n canceled
\n
\n canceling
\n
\n complete
\n
\n failed
\n
\n in_progress
\n
\n starting
\n
A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is exported to.
" + "smithy.api#documentation": "A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for\n the Amazon S3 bucket where the data is exported.
" } }, "SourceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
" } }, "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "The data exported from the snapshot. Valid values are the following:
\n\n database
- Export all the data from a specified database.
\n database.table
\n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema
\n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table
\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The data exported from the snapshot or cluster. Valid values are the following:
\n\n database
- Export all the data from a specified database.
\n database.table
\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema
\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table
\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The time that the snapshot export task started.
" + "smithy.api#documentation": "The time that the snapshot or cluster export task started.
" } }, "TaskEndTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "The time that the snapshot export task completed.
" + "smithy.api#documentation": "The time that the snapshot or cluster export task ended.
" } }, "S3Bucket": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket that the snapshot is exported to.
" + "smithy.api#documentation": "The Amazon S3 bucket that the snapshot or cluster is exported to.
" } }, "S3Prefix": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
" + "smithy.api#documentation": "The Amazon S3 bucket prefix that is the file name and path of the exported data.
" } }, "IamRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
" + "smithy.api#documentation": "The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to\n Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this KMS key.
" + "smithy.api#documentation": "The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. \n The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export\n must have encryption and decryption permissions to use this KMS key.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The progress status of the export task.
" + "smithy.api#documentation": "The progress status of the export task. The status can be one of the following:
\n\n CANCELED
\n
\n CANCELING
\n
\n COMPLETE
\n
\n FAILED
\n
\n IN_PROGRESS
\n
\n STARTING
\n
The progress of the snapshot export task as a percentage.
" + "smithy.api#documentation": "The progress of the snapshot or cluster export task as a percentage.
" } }, "TotalExtractedDataInGB": { @@ -15176,7 +14040,7 @@ "WarningMessage": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A warning about the snapshot export task.
" + "smithy.api#documentation": "A warning about the snapshot or cluster export task.
" } }, "SourceType": { @@ -15187,7 +14051,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the details of a snapshot export to Amazon S3.
\nThis data type is used as a response element in the DescribeExportTasks
action.
Contains the details of a snapshot or cluster export to Amazon S3.
\nThis data type is used as a response element in the DescribeExportTasks
action.
Information about an export of a snapshot to Amazon S3.
" + "smithy.api#documentation": "Information about an export of a snapshot or cluster to Amazon S3.
" } } } @@ -15270,7 +14134,7 @@ } ], "traits": { - "smithy.api#documentation": "Forces a failover for a DB cluster.
\nFor an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nFor a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nAn Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.
\nTo simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Forces a failover for a DB cluster.
\nFor an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nFor a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nAn Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.
\nTo simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" } }, "com.amazonaws.rds#FailoverDBClusterMessage": { @@ -16460,7 +15324,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.
\nThis operation is supported for RDS for Oracle only.
" + "smithy.api#documentation": "Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.
\nThis operation is supported for RDS for Oracle and Microsoft SQL Server.
" } }, "com.amazonaws.rds#ModifyActivityStreamRequest": { @@ -16469,7 +15333,7 @@ "ResourceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the RDS for Oracle DB instance,\n for example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db
.
The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.\n For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db
.
The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is\n read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyActivityStreamResponse": { @@ -16519,6 +15386,9 @@ "smithy.api#documentation": "The status of the modification to the policy state of the database activity stream.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#ModifyCertificates": { @@ -16714,7 +15584,7 @@ } ], "traits": { - "smithy.api#documentation": "Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" } }, "com.amazonaws.rds#ModifyDBClusterEndpoint": { @@ -17035,7 +15905,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName
, ParameterValue
, \n and ApplyMethod
. A maximum of 20\n parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database
parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters
operation to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName
, ParameterValue
, \n and ApplyMethod
. A maximum of 20\n parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database
parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters
operation to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" } }, "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { @@ -17651,6 +16521,9 @@ "smithy.api#documentation": "The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint\n uses a different VPC than the original proxy, you also specify a different\n set of security group IDs than for the original proxy.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBProxyEndpointResponse": { @@ -17662,6 +16535,9 @@ "smithy.api#documentation": "The DBProxyEndpoint
object representing the new settings for the DB proxy endpoint.
The new list of security groups for the DBProxy
.
The DBProxy
object representing the new settings for the proxy.
The new name for the modified DBProxyTarget
. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
The settings of the modified DBProxyTarget
.
You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.
\nRebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
\nUse this operation only for a non-Aurora Multi-AZ DB cluster.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.
\nRebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
\nUse this operation only for a non-Aurora Multi-AZ DB cluster.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" } }, "com.amazonaws.rds#RebootDBClusterMessage": { @@ -19919,6 +18807,9 @@ "smithy.api#documentation": "One or more DB cluster identifiers.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RegisterDBProxyTargetsResponse": { @@ -19930,6 +18821,9 @@ "smithy.api#documentation": "One or more DBProxyTarget
objects that are created when you register targets with a target group.
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" } }, "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { @@ -20522,7 +19416,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName
\n and ApplyMethod
. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName
\n and ResetAllParameters
parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot
to take effect on the next DB instance restart \n or RebootDBInstance
request. You must call RebootDBInstance
for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName
\n and ApplyMethod
. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName
\n and ResetAllParameters
parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot
to take effect on the next DB instance restart \n or RebootDBInstance
request. You must call RebootDBInstance
for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" } }, "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { @@ -20983,7 +19877,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
\nThe target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance
action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier
. You can create DB instances only after\n the RestoreDBClusterFromSnapshot
action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
\nThe target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance
action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier
. You can create DB instances only after\n the RestoreDBClusterFromSnapshot
action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { @@ -21235,7 +20129,7 @@ } ], "traits": { - "smithy.api#documentation": "Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime
for up to\n BackupRetentionPeriod
days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.
For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance
action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier
. You can create DB instances only after\n the RestoreDBClusterToPointInTime
action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime
for up to\n BackupRetentionPeriod
days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.
For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance
action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier
. You can create DB instances only after\n the RestoreDBClusterToPointInTime
action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
" } }, "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { @@ -21695,13 +20589,13 @@ "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
\nConstraints:
\nMust match the identifier of an existing Multi-AZ DB cluster snapshot.
\nCan't be specified when DBSnapshotIdentifier
is specified.
Must be specified when DBSnapshotIdentifier
isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier
\n must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
\nCan't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
\nThe identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
\nConstraints:
\nMust match the identifier of an existing Multi-AZ DB cluster snapshot.
\nCan't be specified when DBSnapshotIdentifier
is specified.
Must be specified when DBSnapshotIdentifier
isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier
\n must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
\nCan't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.
\nBe sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also\n allocate additional memory for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.
\nBe sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also\n allocate additional storage for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed.\n You can also allocate additional memory for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed.\n You can also allocate additional memory for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.
\nSpecifies whether the database activity stream includes engine-native audit fields. This option only applies\n to an Oracle DB instance. By default, no engine-native audit fields are included.
" + "smithy.api#documentation": "Specifies whether the database activity stream includes engine-native audit fields. This option applies\n to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StartActivityStreamResponse": { @@ -23019,6 +21916,9 @@ "smithy.api#documentation": "Indicates whether engine-native audit fields are included in the database activity stream.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#StartDBCluster": { @@ -23239,7 +22139,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an export of a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nThis command doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nYou can't export snapshot data from RDS Custom DB instances.
\nYou can't export cluster data from Multi-AZ DB clusters.
\nFor more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
\nFor more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#StartExportTaskMessage": { @@ -23248,48 +22148,48 @@ "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is to be exported to.
", + "smithy.api#documentation": "A unique identifier for the export task. This ID isn't an identifier for\n the Amazon S3 bucket where the data is to be exported.
", "smithy.api#required": {} } }, "SourceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
", "smithy.api#required": {} } }, "S3BucketName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket to export the snapshot to.
", + "smithy.api#documentation": "The name of the Amazon S3 bucket to export the snapshot or cluster data to.
", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot.
", + "smithy.api#documentation": "The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot or cluster.
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to run the following operations. \n These can be set in the Amazon Web Services KMS key policy:
\nkms:Encrypt
\nkms:Decrypt
\nkms:GenerateDataKey
\nkms:GenerateDataKeyWithoutPlaintext
\nkms:ReEncryptFrom
\nkms:ReEncryptTo
\nkms:CreateGrant
\nkms:DescribeKey
\nkms:RetireGrant
\nThe ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to run the following operations. \n These can be set in the Amazon Web Services KMS key policy:
\nkms:Encrypt
\nkms:Decrypt
\nkms:GenerateDataKey
\nkms:GenerateDataKeyWithoutPlaintext
\nkms:ReEncryptFrom
\nkms:ReEncryptTo
\nkms:CreateGrant
\nkms:DescribeKey
\nkms:RetireGrant
\nThe Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
" + "smithy.api#documentation": "The Amazon S3 bucket prefix to use as the file name and path of the exported data.
" } }, "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "The data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot data is exported.\n Valid values are the following:
\n\n database
- Export all the data from a specified database.
\n database.table
\n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema
\n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table
\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The data to be exported from the snapshot or cluster. \n If this parameter is not provided, all of the data is exported.\n Valid values are the following:
\n\n database
- Export all the data from a specified database.
\n database.table
\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema
\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table
\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Specifies whether or not the database activity stream is to stop as soon as possible, \n regardless of the maintenance window for the database.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StopActivityStreamResponse": { @@ -23362,6 +22265,9 @@ "smithy.api#documentation": "The status of the database activity stream.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#StopDBCluster": { @@ -23724,6 +22630,9 @@ "smithy.api#documentation": "The amount of time, in seconds, for the switchover to complete. The default is 300.
\nIf the switchover takes longer than the specified duration, then any changes are rolled back, \n and no changes are made to the environments.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse": { @@ -23732,6 +22641,9 @@ "BlueGreenDeployment": { "target": "com.amazonaws.rds#BlueGreenDeployment" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#SwitchoverDetail": {