From 56779da847f7fc665e45aac3d52fb66510b5c07a Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Fri, 1 Jul 2022 18:06:46 +0000 Subject: [PATCH] Update API model --- .../database-migration-service.json | 40 +++++- codegen/sdk-codegen/aws-models/rds.json | 130 +++++++++--------- 2 files changed, 103 insertions(+), 67 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/database-migration-service.json b/codegen/sdk-codegen/aws-models/database-migration-service.json index d927806a0c5..b3b02e839e3 100644 --- a/codegen/sdk-codegen/aws-models/database-migration-service.json +++ b/codegen/sdk-codegen/aws-models/database-migration-service.json @@ -3238,7 +3238,7 @@ "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

If you specify any of the following filters, the output includes information for only\n those databases that meet the filter criteria:

\n \n \n \n

An example is: describe-fleet-advisor-databases --filter\n Name=\"database-id\",Values=\"d4610ac5-e323-4ad9-bc50-eaf7249dfe9d\"\n

" + "smithy.api#documentation": "

If you specify any of the following filters, the output includes information for only\n those databases that meet the filter criteria:

\n \n \n \n

An example is: describe-fleet-advisor-databases --filter\n Name=\"database-id\",Values=\"45\"\n

" } }, "MaxRecords": { @@ -4868,6 +4868,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of seconds for which DMS retries failed API requests to the\n OpenSearch cluster.

" } + }, + "UseNewMappingType": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Set this option to true for DMS to migrate documentation using the documentation type _doc. OpenSearch and \n an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is false.

" + } } }, "traits": { @@ -6311,6 +6317,12 @@ "traits": { "smithy.api#documentation": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.

" } + }, + "TrimSpaceInChar": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Use the TrimSpaceInChar source endpoint setting to trim data \n on CHAR and NCHAR data types during migration. The default value is true.

" + } } }, "traits": { @@ -7536,6 +7548,12 @@ "traits": { "smithy.api#documentation": "

Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret \n that contains the Oracle ASM connection details for the Oracle endpoint.

" } + }, + "TrimSpaceInChar": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Use the TrimSpaceInChar source endpoint setting to trim data \n on CHAR and NCHAR data types during migration. The default value is true.

" + } } }, "traits": { @@ -7819,6 +7837,12 @@ "traits": { "smithy.api#documentation": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.

" } + }, + "TrimSpaceInChar": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Use the TrimSpaceInChar source endpoint setting to trim data \n on CHAR and NCHAR data types during migration. The default value is true.

" + } } }, "traits": { @@ -8756,7 +8780,7 @@ "StopReason": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The reason the replication task was stopped. This response parameter can return one of\n the following values:

\n " + "smithy.api#documentation": "

The reason the replication task was stopped. This response parameter can return one of\n the following values:

\n " } }, "ReplicationTaskCreationDate": { @@ -9472,6 +9496,18 @@ "traits": { "smithy.api#documentation": "

When creating an S3 target endpoint, set DatePartitionTimezone to convert\n the current UTC time into a specified time zone. The conversion occurs when a date\n partition folder is created and a CDC filename is generated. The time zone format is Area/Location.\n Use this parameter when DatePartitionedEnabled is set to true, as shown in the\n following example.

\n

\n s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\",\n \"DatePartitionDelimiter\": \"SLASH\",\n \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\":\n \"dms-nattarat-test\"}'\n

" } + }, + "AddTrailingPaddingCharacter": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Use the S3 target endpoint setting AddTrailingPaddingCharacter to add \n padding on string data. The default value is false.

" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

To specify a bucket owner and prevent sniping, you can use the \n ExpectedBucketOwner endpoint setting.

\n

Example: --s3-settings='{\"ExpectedBucketOwner\": \"AWS_Account_ID\"}'\n

\n

When you make a request to test a connection or perform a migration, S3 checks the account \n ID of the bucket owner against the specified parameter.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 9beaaa1eda1..ab8964c8bf9 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -1083,7 +1083,7 @@ } ], "traits": { - "smithy.api#documentation": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

\n

For more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora MySQL DB clusters.

\n " + "smithy.api#documentation": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

\n

For more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.

\n \n

This action applies only to Aurora MySQL DB clusters.

\n " } }, "com.amazonaws.rds#BacktrackDBClusterMessage": { @@ -1532,7 +1532,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To 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.

\n

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action \n is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, \n you must provide the following values:

\n \n

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.

\n

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.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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.

\n

To 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.

\n

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 \n

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.

\n

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.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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.

" } }, "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { @@ -1561,7 +1561,7 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the \n source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. \n Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

\n

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be\n executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. \n The pre-signed URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n " + "smithy.api#documentation": "

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " } }, "CopyTags": { @@ -1678,7 +1678,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region\n where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the\n DB snapshot copy.

\n

This command doesn't apply to RDS Custom.

\n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.

\n

This command doesn't apply to RDS Custom.

\n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { @@ -1687,7 +1687,7 @@ "SourceDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If you are copying an encrypted snapshot\n this parameter must be in the ARN format for the source Amazon Web Services Region, \n and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

\n

Constraints:

\n \n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", + "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

\n

Constraints:

\n \n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", "smithy.api#required": {} } }, @@ -1716,7 +1716,7 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source Amazon Web Services Region that contains the\n source DB snapshot to copy.

\n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n " + "smithy.api#documentation": "

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " } }, "OptionGroupName": { @@ -1950,7 +1950,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

You 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 cross-Region replication where the DB cluster identified by\n ReplicationSourceIdentifier is encrypted, also specify the\n PreSignedUrl parameter.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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.

\n

You 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.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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.

" } }, "com.amazonaws.rds#CreateDBClusterEndpoint": { @@ -1982,7 +1982,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

\n \n

This action applies only to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#CreateDBClusterEndpointMessage": { @@ -2157,13 +2157,13 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. \n Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

\n

The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.

\n

The pre-signed URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n \n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n \n

Valid for: Aurora DB clusters only

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide..

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "BacktrackWindow": { @@ -2181,7 +2181,7 @@ "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.

\n

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.

\n

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.

\n

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

\n

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.

\n

Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.

\n

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.

\n

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.

\n

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

\n

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

\n

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.

\n

Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for: Aurora DB clusters only

" } }, "ScalingConfiguration": { @@ -2295,7 +2295,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" } }, "ServerlessV2ScalingConfiguration": { @@ -2323,7 +2323,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB cluster parameter group.

\n

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

\n

A 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.

\n

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.

\n

When 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.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster\n 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 DB cluster 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 action to verify \n that your DB cluster parameter group has been created or modified.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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.

\n

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

\n

A 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.

\n

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.

\n

When 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.

\n \n

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\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.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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.

" } }, "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { @@ -2513,7 +2513,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB instance.

" + "smithy.api#documentation": "

Creates a new DB instance.

\n

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

\n

For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

\n

For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#CreateDBInstanceMessage": { @@ -2541,7 +2541,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.

", + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

", "smithy.api#required": {} } }, @@ -2567,7 +2567,7 @@ "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

This setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.

" } }, "VpcSecurityGroupIds": { @@ -2603,7 +2603,7 @@ "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1

\n

Constraints:

\n " + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1

\n

Constraints:

\n " } }, "PreferredBackupWindow": { @@ -2621,13 +2621,13 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.

" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions action.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

" } }, "AutoMinorVersionUpgrade": { @@ -2639,19 +2639,19 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

License model information for this DB instance.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

License model information for this DB instance.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the DB instance should be associated with the specified option group.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates that the DB instance should be associated with the specified option group.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" } }, "CharacterSetName": { @@ -2687,13 +2687,13 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: standard | gp2 | io1\n

\n

If you specify io1, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: standard | gp2 | io1\n

\n

If you specify io1, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" } }, "TdeCredentialPassword": { @@ -2717,7 +2717,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" } }, "CopyTagsToSnapshot": { @@ -2741,7 +2741,7 @@ "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" } }, "PromotionTier": { @@ -2759,7 +2759,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts \n to database accounts is managed by the DB cluster.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

" } }, "EnablePerformanceInsights": { @@ -2777,7 +2777,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" } }, "EnableCloudwatchLogsExports": { @@ -2789,7 +2789,7 @@ "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" } }, "DeletionProtection": { @@ -2801,7 +2801,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" } }, "EnableCustomerOwnedIp": { @@ -2904,7 +2904,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this action. Call the CreateDBInstance\n action to create a DB instance for an Aurora DB cluster.

\n

All read replica DB instances are created with backups disabled. All other DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.

\n \n

Your source DB instance must have backup retention enabled.

\n " + "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.

\n

All read replica DB instances are created with backups disabled. All other DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.

\n \n

Your source DB instance must have backup retention enabled.

\n " } }, "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage": { @@ -2969,7 +2969,7 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for Oracle DB instances. It \n isn't supported for RDS Custom.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.

\n

Constraints:

\n " } }, "PubliclyAccessible": { @@ -3026,7 +3026,7 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source Amazon Web Services Region that contains the source DB instance.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-Region read replicas.

\n \n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.

\n \n

This setting doesn't apply to RDS Custom.

" } }, "EnableIAMDatabaseAuthentication": { @@ -3050,7 +3050,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n \n

This setting doesn't apply to RDS Custom.

" } }, "EnableCloudwatchLogsExports": { @@ -3601,7 +3601,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an RDS event notification subscription. This action requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n \n

RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.

\n " + "smithy.api#documentation": "

Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n \n

RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.

\n " } }, "com.amazonaws.rds#CreateEventSubscriptionMessage": { @@ -3684,7 +3684,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

\n

You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

\n

You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

\n \n

This action applies only to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#CreateGlobalClusterMessage": { @@ -3723,7 +3723,7 @@ "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon\n Aurora will not create a database in the global database cluster you are creating.

" + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you do not provide\n a name, Amazon Aurora will not create a database in the global database cluster you are\n creating.

" } }, "StorageEncrypted": { @@ -4325,7 +4325,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "ServerlessV2ScalingConfiguration": { @@ -5733,7 +5733,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n " } }, "EnabledCloudwatchLogsExports": { @@ -10581,7 +10581,7 @@ "target": "com.amazonaws.rds#EventsMessage" }, "traits": { - "smithy.api#documentation": "

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", + "smithy.api#documentation": "

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

\n

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11643,7 +11643,7 @@ } }, "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the DescribeEvents action.

" + "smithy.api#documentation": "

This data type is used as a response element in the DescribeEvents action.

" } }, "com.amazonaws.rds#EventCategoriesList": { @@ -11672,7 +11672,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventCategories operation.

" + "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventCategories\n operation.

" } }, "com.amazonaws.rds#EventCategoriesMapList": { @@ -12022,7 +12022,7 @@ } ], "traits": { - "smithy.api#documentation": "

Forces a failover for a DB cluster.

\n

For 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).

\n

For 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).

\n

An 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 readbable standby \n DB instance when the primary DB instance fails.

\n

To 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.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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.

\n

For 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).

\n

For 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).

\n

An 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.

\n

To 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.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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.

" } }, "com.amazonaws.rds#FailoverDBClusterMessage": { @@ -13594,7 +13594,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" } }, "ServerlessV2ScalingConfiguration": { @@ -13622,7 +13622,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.

\n \n

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 action to verify \n that your DB cluster parameter group has been created or modified.

\n

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.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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.

\n \n

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.

\n

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.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For 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

" } }, "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { @@ -13675,7 +13675,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are\n returned as values for the restore attribute.

" + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

" } }, "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { @@ -13691,7 +13691,7 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API action.

\n ", + "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.

\n ", "smithy.api#required": {} } }, @@ -13813,7 +13813,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.

\n

If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.

\n

This setting doesn't apply to RDS Custom for Oracle.

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

\n

If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.

\n

This setting doesn't apply to RDS Custom for Oracle.

\n

Default: Uses existing setting

" } }, "DBSubnetGroupName": { @@ -13843,7 +13843,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

\n \n

Amazon RDS API actions never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n " + "smithy.api#documentation": "

The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

\n \n

Amazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n " } }, "DBParameterGroupName": { @@ -13855,7 +13855,7 @@ "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n " + "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n " } }, "PreferredBackupWindow": { @@ -13999,7 +13999,7 @@ "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide..

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "PerformanceInsightsKMSKeyId": { @@ -14011,7 +14011,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" } }, "CloudwatchLogsExportConfiguration": { @@ -14319,14 +14319,14 @@ "TargetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the new target group to assign to the proxy.

", + "smithy.api#documentation": "

The name of the target group to modify.

", "smithy.api#required": {} } }, "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the new proxy to which to assign the target group.

", + "smithy.api#documentation": "

The name of the proxy.

", "smithy.api#required": {} } }, @@ -14392,7 +14392,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as\n values for the restore attribute.

" + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.

" } }, "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { @@ -14408,7 +14408,7 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API action.

\n ", + "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API operation.

\n ", "smithy.api#required": {} } }, @@ -17204,14 +17204,14 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql\n

", + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql \n (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5, 8.0.mysql_aurora.3.01.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: 9.6.3, 10.7\n

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1,\n 8.0.mysql_aurora.3.02.0\n

" } }, "Port": { @@ -17514,7 +17514,7 @@ "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide..

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EngineMode": { @@ -17750,7 +17750,7 @@ "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide..

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DBClusterParameterGroupName": { @@ -18416,7 +18416,7 @@ "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide..

" + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

" } }, "PerformanceInsightsKMSKeyId": { @@ -18428,7 +18428,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

" } }, "EnableCloudwatchLogsExports": { @@ -19480,7 +19480,7 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication action to be \n called in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API action that can be executed in the Amazon Web Services Region that contains\n the source DB instance.

" + "smithy.api#documentation": "

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " } } } @@ -19765,7 +19765,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

This command doesn't apply to RDS Custom.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { @@ -20432,7 +20432,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The status of the VPC security group.

" + "smithy.api#documentation": "

The membership status of the VPC security group.

\n

Currently, the only valid status is active.

" } } },