From 8e56fb35705643d2d1e4b99534cea165d076308b Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 23 Jun 2023 18:11:55 +0000 Subject: [PATCH] docs(client-rds): Documentation improvements for create, describe, and modify DB clusters and DB instances. --- .../src/commands/DescribeDBClustersCommand.ts | 2 +- .../commands/DescribeDBInstancesCommand.ts | 2 +- .../src/commands/ModifyDBClusterCommand.ts | 2 +- clients/client-rds/src/models/models_0.ts | 1935 ++++++++--------- clients/client-rds/src/models/models_1.ts | 829 +++---- codegen/sdk-codegen/aws-models/rds.json | 586 ++--- 6 files changed, 1713 insertions(+), 1643 deletions(-) diff --git a/clients/client-rds/src/commands/DescribeDBClustersCommand.ts b/clients/client-rds/src/commands/DescribeDBClustersCommand.ts index 4e5131c063191..461bfc63da452 100644 --- a/clients/client-rds/src/commands/DescribeDBClustersCommand.ts +++ b/clients/client-rds/src/commands/DescribeDBClustersCommand.ts @@ -36,7 +36,7 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met /** * @public - *

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

+ *

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

*

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

diff --git a/clients/client-rds/src/commands/DescribeDBInstancesCommand.ts b/clients/client-rds/src/commands/DescribeDBInstancesCommand.ts index d4756950b6a7d..d41b53685a8da 100644 --- a/clients/client-rds/src/commands/DescribeDBInstancesCommand.ts +++ b/clients/client-rds/src/commands/DescribeDBInstancesCommand.ts @@ -36,7 +36,7 @@ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __M /** * @public - *

Returns information about provisioned RDS instances. This API supports pagination.

+ *

Describes provisioned RDS instances. This API supports pagination.

* *

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

* diff --git a/clients/client-rds/src/commands/ModifyDBClusterCommand.ts b/clients/client-rds/src/commands/ModifyDBClusterCommand.ts index a07992d5c2363..a499149bdc143 100644 --- a/clients/client-rds/src/commands/ModifyDBClusterCommand.ts +++ b/clients/client-rds/src/commands/ModifyDBClusterCommand.ts @@ -36,7 +36,7 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M /** * @public - *

Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. + *

Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. * You can change one or more settings by specifying these parameters and the new values in the * request.

*

For more information on Amazon Aurora DB clusters, see diff --git a/clients/client-rds/src/models/models_0.ts b/clients/client-rds/src/models/models_0.ts index afce2f31648bf..705acd9b3683c 100644 --- a/clients/client-rds/src/models/models_0.ts +++ b/clients/client-rds/src/models/models_0.ts @@ -3823,39 +3823,41 @@ export interface CreateDBClusterMessage { *

For information on Amazon Web Services Regions and Availability Zones, see * Choosing the Regions and * Availability Zones in the Amazon Aurora User Guide.

- *

Valid for: Aurora DB clusters only

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ AvailabilityZones?: string[]; /** *

The number of days for which automated backups are retained.

- *

Default: 1

+ *

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

+ *

Default: 1 + *

*

Constraints:

* - *

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

*/ BackupRetentionPeriod?: number; /** - *

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

- *

Valid for: Aurora DB clusters only

+ *

The name of the character set (CharacterSet) to associate the DB cluster with.

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ CharacterSetName?: string; /** - *

The name for your database of up to 64 alphanumeric characters. If you do not + *

The name for your database of up to 64 alphanumeric characters. If you don't * provide a name, Amazon RDS doesn't create a database in the DB cluster you are * creating.

- *

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

+ *

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

*/ DatabaseName?: string; /** - *

The DB cluster identifier. This parameter is stored as a lowercase string.

+ *

The identifier for this DB cluster. This parameter is stored as a lowercase string.

+ *

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

*

Constraints:

* *

Example: my-cluster1 *

- *

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

*/ DBClusterIdentifier: string | undefined; /** *

The name of the DB cluster parameter group to associate - * with this DB cluster. If you do not specify a value, then + * with this DB cluster. If you don't specify a value, then * the default DB cluster parameter group for the specified DB engine and version is used.

+ *

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

*

Constraints:

* - *

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

*/ DBClusterParameterGroupName?: string; /** *

A list of EC2 VPC security groups to associate with this DB cluster.

- *

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

+ *

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

*/ VpcSecurityGroupIds?: string[]; /** *

A DB subnet group to associate with this DB cluster.

*

This setting is required to create a Multi-AZ DB cluster.

- *

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

- *

Example: mydbsubnetgroup - *

- *

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

- */ - DBSubnetGroupName?: string; - - /** - *

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

- *

Valid Values:

+ *

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

+ *

Constraints:

* - *

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

+ *

Example: mydbsubnetgroup + *

+ */ + DBSubnetGroupName?: string; + + /** + *

The database engine to use for this DB cluster.

+ *

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

+ *

Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres + *

*/ Engine: string | undefined; @@ -3954,50 +3942,49 @@ export interface CreateDBClusterMessage { *

* aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" *

- *

- * Aurora MySQL - *

- *

For information, see Database engine updates for Amazon Aurora MySQL in the + *

For information about a specific engine, see the following topics:

+ * + *

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

*/ EngineVersion?: string; /** *

The port number on which the instances in the DB cluster accept connections.

- *

- * RDS for MySQL and Aurora MySQL - *

- *

Default: 3306 - *

- *

Valid values: 1150-65535 - *

- *

- * RDS for PostgreSQL and Aurora PostgreSQL - *

- *

Default: 5432 - *

- *

Valid values: 1150-65535 + *

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

+ *

Valid Values: 1150-65535 *

- *

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

+ *

Default:

+ * */ Port?: number; /** *

The name of the master user for the DB cluster.

+ *

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

*

Constraints:

* - *

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

*/ MasterUsername?: string; /** - *

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

+ *

The password for the master database user.

+ *

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

*

Constraints:

* - *

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

*/ MasterUserPassword?: string; /** - *

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

+ *

The option group to associate the DB cluster with.

*

DB clusters are associated with a default option group that can't be modified.

*/ OptionGroupName?: string; @@ -4039,6 +4028,7 @@ export interface CreateDBClusterMessage { *

The daily time range during which automated backups are created * if automated backups are enabled * using the BackupRetentionPeriod parameter.

+ *

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

*

The default is a 30-minute window selected at random from an * 8-hour block of time for each Amazon Web Services Region. * To view the time blocks available, see @@ -4059,41 +4049,51 @@ export interface CreateDBClusterMessage { *

Must be at least 30 minutes.

* * - *

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

*/ PreferredBackupWindow?: string; /** - *

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

- *

Format: ddd:hh24:mi-ddd:hh24:mi - *

+ *

The weekly time range during which system maintenance can occur.

+ *

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

*

The default is a 30-minute window selected at random from an * 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the * week. To see the time blocks available, see * * Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

- *

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

- *

Constraints: Minimum 30-minute window.

- *

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

+ *

Constraints:

+ * */ PreferredMaintenanceWindow?: string; /** *

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB * cluster is created as a read replica.

- *

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

+ *

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

*/ ReplicationSourceIdentifier?: string; /** *

Tags to assign to the DB cluster.

- *

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

+ *

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

*/ Tags?: Tag[]; /** - *

A value that indicates whether the DB cluster is encrypted.

- *

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

+ *

Specifies whether the DB cluster is encrypted.

+ *

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

*/ StorageEncrypted?: boolean; @@ -4105,21 +4105,21 @@ export interface CreateDBClusterMessage { * *

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account * has a different default KMS key for each Amazon Web Services Region.

- *

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you - * must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services + *

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make + * sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services * Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

- *

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

+ *

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

*/ KmsKeyId?: string; @@ -4167,57 +4167,60 @@ export interface CreateDBClusterMessage { * SourceRegion autogenerates a presigned URL that is a valid request * for the operation that can run in the source Amazon Web Services Region.

* - *

Valid for: Aurora DB clusters only

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ PreSignedUrl?: string; /** - *

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access + *

Specifies whether to enable mapping of Amazon Web Services Identity and Access * Management (IAM) accounts to database accounts. By default, mapping isn't * enabled.

*

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

- *

Valid for: Aurora DB clusters only

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ EnableIAMDatabaseAuthentication?: boolean; /** *

The target backtrack window, in seconds. To disable backtracking, set this value to - * 0.

- *

Default: 0

+ * 0.

+ *

Valid for Cluster Type: Aurora MySQL DB clusters only

+ *

Default: 0 + *

*

Constraints:

* - *

Valid for: Aurora MySQL DB clusters only

*/ BacktrackWindow?: number; /** - *

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values - * in the list depend on the DB engine being used.

- *

- * RDS for MySQL - *

- *

Possible values are error, general, and slowquery.

- *

- * RDS for PostgreSQL - *

- *

Possible values are postgresql and upgrade.

- *

- * Aurora MySQL - *

- *

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

- *

- * Aurora PostgreSQL - *

- *

Possible value is postgresql.

+ *

The list of log types that need to be enabled for exporting to CloudWatch Logs.

+ *

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

+ *

The following values are valid for each DB engine:

+ * *

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

*

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

- *

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

*/ EnableCloudwatchLogsExports?: string[]; @@ -4240,47 +4243,47 @@ export interface CreateDBClusterMessage { *

* * - *

Valid for: Aurora DB clusters only

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ EngineMode?: string; /** *

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

- *

Valid for: Aurora DB clusters only

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ ScalingConfiguration?: ScalingConfiguration; /** - *

A value that indicates whether the DB cluster has deletion protection enabled. + *

Specifies whether the DB cluster has deletion protection enabled. * The database can't be deleted when deletion protection is enabled. By default, * deletion protection isn't enabled.

- *

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

+ *

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

*/ DeletionProtection?: boolean; /** *

The global cluster ID of an Aurora cluster that becomes the primary cluster * in the new global database cluster.

- *

Valid for: Aurora DB clusters only

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ GlobalClusterIdentifier?: string; /** - *

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint + *

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint * is disabled.

*

When enabled, the HTTP endpoint provides a connectionless web service API for running * SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database * from inside the RDS console with the query editor.

*

For more information, see Using the Data API for Aurora Serverless v1 in the * Amazon Aurora User Guide.

- *

Valid for: Aurora DB clusters only

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ EnableHttpEndpoint?: boolean; /** - *

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. + *

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. * The default is not to copy them.

- *

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

+ *

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

*/ CopyTagsToSnapshot?: boolean; @@ -4289,53 +4292,73 @@ export interface CreateDBClusterMessage { *

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

*

For more information, see Kerberos authentication * in the Amazon Aurora User Guide.

- *

Valid for: Aurora DB clusters only

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ Domain?: string; /** - *

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

- *

Valid for: Aurora DB clusters only

+ *

The name of the IAM role to use when making API calls to the Directory Service.

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ DomainIAMRoleName?: string; /** - *

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an - * Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that + *

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster + * (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that * are secondary clusters in an Aurora global database.

*

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter - * enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to + * enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to * this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the - * primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

- *

Valid for: Aurora DB clusters only

+ * primary is demoted by a global cluster API operation, but it does nothing until then.

+ *

Valid for Cluster Type: Aurora DB clusters only

*/ EnableGlobalWriteForwarding?: boolean; /** - *

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. + *

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. * Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

*

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

*

This setting is required to create a Multi-AZ DB cluster.

- *

Valid for: Multi-AZ DB clusters only

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

*/ DBClusterInstanceClass?: string; /** *

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

*

This setting is required to create a Multi-AZ DB cluster.

- *

Valid for: Multi-AZ DB clusters only

*/ AllocatedStorage?: number; /** - *

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

+ *

The storage type to associate with the DB cluster.

+ *

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB + * clusters, see Settings for creating Multi-AZ DB clusters.

*

This setting is required to create a Multi-AZ DB cluster.

*

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

- *

Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

- *

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

- *

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

- *

For more information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For more information on storage types for Multi-AZ DB - * clusters, see Settings for creating Multi-AZ DB clusters.

+ *

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

+ *

Valid Values:

+ * + *

Default:

+ * */ StorageType?: string; @@ -4345,13 +4368,18 @@ export interface CreateDBClusterMessage { *

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS * User Guide.

*

This setting is required to create a Multi-AZ DB cluster.

- *

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

- *

Valid for: Multi-AZ DB clusters only

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

+ *

Constraints:

+ * */ Iops?: number; /** - *

A value that indicates whether the DB cluster is publicly accessible.

+ *

Specifies whether the DB cluster is publicly accessible.

*

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint * resolves to the private IP address from within the DB cluster's virtual private cloud * (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access @@ -4359,6 +4387,7 @@ export interface CreateDBClusterMessage { * access isn't permitted if the security group assigned to the DB cluster doesn't permit * it.

*

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

*

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

*

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

* - *

Valid for: Multi-AZ DB clusters only

*/ PubliclyAccessible?: boolean; /** - *

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. + *

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. * By default, minor engine upgrades are applied automatically.

- *

Valid for: Multi-AZ DB clusters only

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

*/ AutoMinorVersionUpgrade?: boolean; /** *

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off - * collecting Enhanced Monitoring metrics, specify 0. The default is 0.

+ * collecting Enhanced Monitoring metrics, specify 0.

*

If MonitoringRoleArn is specified, also set MonitoringInterval - * to a value other than 0.

- *

Valid Values: 0, 1, 5, 10, 15, 30, 60 + * to a value other than 0.

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

+ *

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 + *

+ *

Default: 0 *

- *

Valid for: Multi-AZ DB clusters only

*/ MonitoringInterval?: number; @@ -4405,16 +4435,16 @@ export interface CreateDBClusterMessage { * An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, * see Setting * up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

- *

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

- *

Valid for: Multi-AZ DB clusters only

+ *

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

*/ MonitoringRoleArn?: string; /** - *

A value that indicates whether to turn on Performance Insights for the DB cluster.

+ *

Specifies whether to turn on Performance Insights for the DB cluster.

*

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

- *

Valid for: Multi-AZ DB clusters only

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

*/ EnablePerformanceInsights?: boolean; @@ -4424,41 +4454,33 @@ export interface CreateDBClusterMessage { *

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS * uses your default KMS key. There is a default KMS key for your Amazon Web Services account. * Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

- *

Valid for: Multi-AZ DB clusters only

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

*/ PerformanceInsightsKMSKeyId?: string; /** - *

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

+ *

The number of days to retain Performance Insights data.

+ *

Valid for Cluster Type: Multi-AZ DB clusters only

+ *

Valid Values:

* - *

For example, the following values are valid:

- * - *

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

- *

Valid for: Multi-AZ DB clusters only

+ *

Default: 7 days

+ *

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

*/ PerformanceInsightsRetentionPeriod?: number; @@ -4471,19 +4493,6 @@ export interface CreateDBClusterMessage { /** *

The network type of the DB cluster.

- *

Valid values:

- * *

The network type is determined by the DBSubnetGroup specified for the DB cluster. * A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 * protocols (DUAL).

@@ -4491,7 +4500,9 @@ export interface CreateDBClusterMessage { * Working with a DB instance in a VPC in the * Amazon Aurora User Guide. *

- *

Valid for: Aurora DB clusters only

+ *

Valid for Cluster Type: Aurora DB clusters only

+ *

Valid Values: IPV4 | DUAL + *

*/ NetworkType?: string; @@ -4501,11 +4512,12 @@ export interface CreateDBClusterMessage { DBSystemId?: string; /** - *

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

+ *

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

*

For more information, see Password management with Amazon Web Services Secrets Manager * in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager * in the Amazon Aurora User Guide. *

+ *

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

*

Constraints:

* - *

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

*/ ManageMasterUserPassword?: boolean; @@ -4530,7 +4541,7 @@ export interface CreateDBClusterMessage { * managed KMS key.

*

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account * has a different default KMS key for each Amazon Web Services Region.

- *

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

+ *

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

*/ MasterUserSecretKmsKeyId?: string; } @@ -4785,7 +4796,7 @@ export interface ClusterPendingModifiedValues { /** * @public - *

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

+ *

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

*

For more information, see Using Amazon Aurora Serverless v1 in the * Amazon Aurora User Guide.

*/ @@ -4834,7 +4845,7 @@ export interface ScalingConfigurationInfo { /** * @public - *

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

+ *

The scaling configuration for an Aurora Serverless v2 DB cluster.

*

For more information, see Using Amazon Aurora Serverless v2 in the * Amazon Aurora User Guide.

*/ @@ -4884,12 +4895,12 @@ export interface DBCluster { AllocatedStorage?: number; /** - *

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

+ *

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

*/ AvailabilityZones?: string[]; /** - *

Specifies the number of days for which automatic DB snapshots are retained.

+ *

The number of days for which automatic DB snapshots are retained.

*/ BackupRetentionPeriod?: number; @@ -4899,27 +4910,27 @@ export interface DBCluster { CharacterSetName?: string; /** - *

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

+ *

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

*/ DatabaseName?: string; /** - *

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

+ *

The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

*/ DBClusterIdentifier?: string; /** - *

Specifies the name of the DB cluster parameter group for the DB cluster.

+ *

The name of the DB cluster parameter group for the DB cluster.

*/ DBClusterParameterGroup?: string; /** - *

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

+ *

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

*/ DBSubnetGroup?: string; /** - *

Specifies the current state of this DB cluster.

+ *

The current state of this DB cluster.

*/ Status?: string; @@ -4929,7 +4940,7 @@ export interface DBCluster { AutomaticRestartTime?: Date; /** - *

Specifies the progress of the operation as a percentage.

+ *

The progress of the operation as a percentage.

*/ PercentProgress?: string; @@ -4940,7 +4951,7 @@ export interface DBCluster { EarliestRestorableTime?: Date; /** - *

Specifies the connection endpoint for the primary instance of the DB cluster.

+ *

The connection endpoint for the primary instance of the DB cluster.

*/ Endpoint?: string; @@ -4957,59 +4968,59 @@ export interface DBCluster { ReaderEndpoint?: string; /** - *

Identifies all custom endpoints associated with the cluster.

+ *

The custom endpoints associated with the DB cluster.

*/ CustomEndpoints?: string[]; /** - *

Specifies whether the DB cluster has instances in multiple Availability Zones.

+ *

Indicates whether the DB cluster has instances in multiple Availability Zones.

*/ MultiAZ?: boolean; /** - *

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

+ *

The database engine used for this DB cluster.

*/ Engine?: string; /** - *

Indicates the database engine version.

+ *

The version of the database engine.

*/ EngineVersion?: string; /** - *

Specifies the latest time to which a database can be restored with point-in-time restore.

+ *

The latest time to which a database can be restored with point-in-time restore.

*/ LatestRestorableTime?: Date; /** - *

Specifies the port that the database engine is listening on.

+ *

The port that the database engine is listening on.

*/ Port?: number; /** - *

Contains the master username for the DB cluster.

+ *

The master username for the DB cluster.

*/ MasterUsername?: string; /** - *

Provides the list of option group memberships for this DB cluster.

+ *

The list of option group memberships for this DB cluster.

*/ DBClusterOptionGroupMemberships?: DBClusterOptionGroupStatus[]; /** - *

Specifies the daily time range during which automated backups are + *

The daily time range during which automated backups are * created if automated backups are enabled, as determined * by the BackupRetentionPeriod.

*/ PreferredBackupWindow?: string; /** - *

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

+ *

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

*/ PreferredMaintenanceWindow?: string; /** - *

Contains the identifier of the source DB cluster if this DB cluster is a read + *

The identifier of the source DB cluster if this DB cluster is a read * replica.

*/ ReplicationSourceIdentifier?: string; @@ -5021,22 +5032,22 @@ export interface DBCluster { ReadReplicaIdentifiers?: string[]; /** - *

Provides the list of instances that make up the DB cluster.

+ *

The list of DB instances that make up the DB cluster.

*/ DBClusterMembers?: DBClusterMember[]; /** - *

Provides a list of VPC security groups that the DB cluster belongs to.

+ *

The list of VPC security groups that the DB cluster belongs to.

*/ VpcSecurityGroups?: VpcSecurityGroupMembership[]; /** - *

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

+ *

The ID that Amazon Route 53 assigns when you create a hosted zone.

*/ HostedZoneId?: string; /** - *

Specifies whether the DB cluster is encrypted.

+ *

Indicates whether the DB cluster is encrypted.

*/ StorageEncrypted?: boolean; @@ -5058,24 +5069,24 @@ export interface DBCluster { DBClusterArn?: string; /** - *

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. + *

A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. * IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services * on your behalf.

*/ AssociatedRoles?: DBClusterRole[]; /** - *

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

+ *

Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

*/ IAMDatabaseAuthenticationEnabled?: boolean; /** - *

Identifies the clone group to which the DB cluster is associated.

+ *

The ID of the clone group with which the DB cluster is associated.

*/ CloneGroupId?: string; /** - *

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

+ *

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

*/ ClusterCreateTime?: Date; @@ -5085,7 +5096,7 @@ export interface DBCluster { EarliestBacktrackTime?: Date; /** - *

The target backtrack window, in seconds. If this value is set to 0, backtracking is + *

The target backtrack window, in seconds. If this value is set to 0, backtracking is * disabled for the DB cluster. Otherwise, backtracking is enabled.

*/ BacktrackWindow?: number; @@ -5104,7 +5115,7 @@ export interface DBCluster { EnabledCloudwatchLogsExports?: string[]; /** - *

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) + *

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) * when the cluster is paused.

*

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the * Amazon Aurora User Guide.

@@ -5119,20 +5130,20 @@ export interface DBCluster { EngineMode?: string; /** - *

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

+ *

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

*

For more information, see Using Amazon Aurora Serverless v1 in the * Amazon Aurora User Guide.

*/ ScalingConfigurationInfo?: ScalingConfigurationInfo; /** - *

Indicates if the DB cluster has deletion protection enabled. + *

Indicates whether the DB cluster has deletion protection enabled. * The database can't be deleted when deletion protection is enabled.

*/ DeletionProtection?: boolean; /** - *

A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

+ *

Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

*

When enabled, the HTTP endpoint provides a connectionless web service API for running * SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database * from inside the RDS console with the query editor.

@@ -5165,12 +5176,12 @@ export interface DBCluster { ActivityStreamKinesisStreamName?: string; /** - *

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

+ *

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

*/ CopyTagsToSnapshot?: boolean; /** - *

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

+ *

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

*/ CrossAccountClone?: boolean; @@ -5187,13 +5198,12 @@ export interface DBCluster { TagList?: Tag[]; /** - *

Specifies whether a secondary cluster in an Aurora global database has - * write forwarding enabled, not enabled, or is in the process of enabling it.

+ *

The status of write forwarding for a secondary cluster in an Aurora global database.

*/ GlobalWriteForwardingStatus?: WriteForwardingStatus | string; /** - *

Specifies whether you have requested to enable write forwarding for a secondary cluster + *

Specifies whether write forwarding is enabled for a secondary cluster * in an Aurora global database. Because write forwarding takes time to enable, check the * value of GlobalWriteForwardingStatus to confirm that the request has completed * before using the write forwarding feature for this cluster.

@@ -5201,8 +5211,7 @@ export interface DBCluster { GlobalWriteForwardingRequested?: boolean; /** - *

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. - * Specific changes are identified by subelements.

+ *

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

*/ PendingModifiedValues?: ClusterPendingModifiedValues; @@ -5224,20 +5233,21 @@ export interface DBCluster { Iops?: number; /** - *

Specifies the accessibility options for the DB instance.

- *

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private - * IP address from within the DB instance's virtual private cloud (VPC). - * It resolves to the public IP address from outside of the DB instance's VPC. - * Access to the DB instance is ultimately controlled by the security group it uses. - * That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

- *

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

- *

For more information, see CreateDBInstance.

+ *

Indicates whether the DB cluster is publicly accessible.

+ *

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint + * resolves to the private IP address from within the DB cluster's virtual private cloud + * (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access + * to the DB cluster is ultimately controlled by the security group it uses. That public + * access isn't permitted if the security group assigned to the DB cluster doesn't permit + * it.

+ *

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

+ *

For more information, see CreateDBCluster.

*

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

*/ PubliclyAccessible?: boolean; /** - *

A value that indicates that minor version patches are applied automatically.

+ *

Indicates whether minor version patches are applied automatically.

*

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

*/ AutoMinorVersionUpgrade?: boolean; @@ -5255,7 +5265,7 @@ export interface DBCluster { MonitoringRoleArn?: string; /** - *

True if Performance Insights is enabled for the DB cluster, and otherwise false.

+ *

Indicates whether Performance Insights is enabled for the DB cluster.

*

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

*/ PerformanceInsightsEnabled?: boolean; @@ -5268,40 +5278,32 @@ export interface DBCluster { PerformanceInsightsKMSKeyId?: string; /** - *

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

+ *

The number of days to retain Performance Insights data.

+ *

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

+ *

Valid Values:

* - *

For example, the following values are valid:

- * - *

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

+ *

Default: 7 days

*/ PerformanceInsightsRetentionPeriod?: number; /** - *

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

+ *

The scaling configuration for an Aurora Serverless v2 DB cluster.

*

For more information, see Using Amazon Aurora Serverless v2 in the * Amazon Aurora User Guide.

*/ @@ -5309,19 +5311,6 @@ export interface DBCluster { /** *

The network type of the DB instance.

- *

Valid values:

- * *

The network type is determined by the DBSubnetGroup specified for the DB cluster. * A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 * protocols (DUAL).

@@ -5330,6 +5319,8 @@ export interface DBCluster { * Amazon Aurora User Guide. *

*

This setting is only for Aurora DB clusters.

+ *

Valid Values: IPV4 | DUAL + *

*/ NetworkType?: string; @@ -5339,7 +5330,7 @@ export interface DBCluster { DBSystemId?: string; /** - *

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

+ *

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

*

For more information, see Password management with Amazon Web Services Secrets Manager * in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager * in the Amazon Aurora User Guide. @@ -5997,138 +5988,140 @@ export class CertificateNotFoundFault extends __BaseException { */ export interface CreateDBInstanceMessage { /** - *

The meaning of this parameter differs according to the database engine you use.

- *

- * MySQL - *

- *

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

- *

Constraints:

- * - *

- * MariaDB - *

- *

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

- *

Constraints:

- * - *

- * PostgreSQL - *

- *

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres - * is created in the DB instance.

- *

Constraints:

- * - *

- * Oracle - *

- *

The Oracle System ID (SID) of the created DB instance. - * If you specify null, the default value ORCL is used. - * You can't specify the string NULL, or any other reserved word, for DBName.

- *

Default: ORCL - *

- *

Constraints:

- * - *

- * Amazon RDS Custom for Oracle - *

- *

The Oracle System ID (SID) of the created RDS Custom DB instance. - * If you don't specify a value, the default value is ORCL.

- *

Default: ORCL - *

- *

Constraints:

- * - *

- * Amazon RDS Custom for SQL Server - *

- *

Not applicable. Must be null.

- *

- * SQL Server - *

- *

Not applicable. Must be null.

- *

- * Amazon Aurora MySQL - *

- *

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is - * created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created - * in the DB cluster.

- *

Constraints:

- * - *

- * Amazon Aurora PostgreSQL - *

- *

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is - * created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, - * a database named postgres is created in the DB cluster.

- *

Constraints:

- * + *

The meaning of this parameter differs depending on the database engine.

+ *
+ *
Amazon Aurora MySQL
+ *
Amazon Aurora PostgreSQL
+ *
Amazon RDS Custom for Oracle
+ *
Amazon RDS Custom for SQL Server
+ *
RDS for MariaDB
+ *
RDS for MySQL
+ *
RDS for Oracle
+ *
RDS for PostgreSQL
+ *
RDS for SQL Server
+ *
+ *

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is + * created. If you don't specify a value, Amazon RDS doesn't create a database in the DB cluster.

+ *

Constraints:

+ *
    + *
  • + *

    Must contain 1 to 64 alphanumeric characters.

    + *
    • + *
  • + *

    Can't be a word reserved by the database engine.

    + *
    • + *
+ *
+ *
+ *

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is + * created.

+ *

Default: postgres + *

+ *

Constraints:

+ *
    + *
  • + *

    Must contain 1 to 63 alphanumeric characters.

    + *
    • + *
  • + *

    Must begin with a letter. + * Subsequent characters can be letters, underscores, or digits + * (0 to 9).

    + *
    • + *
  • + *

    Can't be a word reserved by the database engine.

    + *
    • + *
+ *
+ *
+ *

The Oracle System ID (SID) of the created RDS Custom DB instance.

+ *

Default: ORCL + *

+ *

Constraints:

+ *
    + *
  • + *

    Must contain 1 to 8 alphanumeric characters.

    + *
    • + *
  • + *

    Must contain a letter.

    + *
    • + *
  • + *

    Can't be a word reserved by the database engine.

    + *
    • + *
+ *
+ *
+ *

Not applicable. Must be null.

+ *
+ *
+ *

The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance.

+ *

Constraints:

+ *
    + *
  • + *

    Must contain 1 to 64 letters or numbers.

    + *
    • + *
  • + *

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    + *
    • + *
  • + *

    Can't be a word reserved by the database engine.

    + *
    • + *
+ *
+ *
+ *

The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance.

+ *

Constraints:

+ *
    + *
  • + *

    Must contain 1 to 64 letters or numbers.

    + *
    • + *
  • + *

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    + *
    • + *
  • + *

    Can't be a word reserved by the database engine.

    + *
    • + *
+ *
+ *
+ *

The Oracle System ID (SID) of the created DB instance.

+ *

Default: ORCL + *

+ *

Constraints:

+ *
    + *
  • + *

    Can't be longer than 8 characters.

    + *
    • + *
  • + *

    Can't be a word reserved by the database engine, such as the string NULL.

    + *
    • + *
+ *
+ *
+ *

The name of the database to create when the DB instance is created.

+ *

Default: postgres + *

+ *

Constraints:

+ *
    + *
  • + *

    Must contain 1 to 63 letters, numbers, or underscores.

    + *
    • + *
  • + *

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    + *
    • + *
  • + *

    Can't be a word reserved by the database engine.

    + *
    • + *
+ *
+ *
+ *

Not applicable. Must be null.

+ *
+ *
*/ DBName?: string; /** - *

The DB instance identifier. This parameter is stored as a lowercase string.

+ *

The identifier for this DB instance. This parameter is stored as a lowercase string.

*

Constraints:

*