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 d4756950b6a7..d41b53685a8d 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.
*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 afce2f31648b..705acd9b3683 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:
*Must be a value from 1 to 35
+ *Must be a value from 1 to 35.
*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:
*If supplied, must match the name of an existing DB cluster parameter group.
*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:
*
- * aurora-mysql
- *
- * aurora-postgresql
- *
- * mysql
- *
Must match the name of an existing DB subnet group.
*
- * postgres
- *
Must not be default.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
+ *Example: mydbsubnetgroup
+ *
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
+ *
* 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:
+ *Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the * Amazon Aurora User Guide.
- *- * Aurora PostgreSQL - *
- *For information, see Amazon Aurora PostgreSQL releases and engine versions in the + *
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the * Amazon Aurora User Guide.
- *- * MySQL - *
- *For information, see Amazon RDS for MySQL in the Amazon RDS User Guide.
- *- * PostgreSQL - *
- *For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
- *Valid for: Aurora DB clusters and Multi-AZ DB clusters
+ *RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide.
+ *RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
+ *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:
+ *RDS for MySQL and Aurora MySQL - 3306
+ *
RDS for PostgreSQL and Aurora PostgreSQL - 5432
+ *
The name of the master user for the DB cluster.
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*Constraints:
*Can't be a reserved word for the chosen database engine.
*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:
*Must contain from 8 to 41 characters.
*Can contain any printable ASCII character except "/", """, or "@".
+ *Can't be specified if ManageMasterUserPassword is turned on.
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:
+ *Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
+ *Must be at least 30 minutes.
+ *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 { *If ReplicationSourceIdentifier identifies an encrypted
- * source, then Amazon RDS will use the KMS key used to encrypt the
- * source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and
* ReplicationSourceIdentifier isn't specified, then Amazon RDS
- * will use 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.
- *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:
*If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*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:
+ *Aurora MySQL - audit | error | general | slowquery
+ *
Aurora PostgreSQL - postgresql
+ *
RDS for MySQL - error | general | slowquery
+ *
RDS for PostgreSQL - postgresql | upgrade
+ *
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:
+ *Aurora DB clusters - aurora | aurora-iopt1
+ *
Multi-AZ DB clusters - io1
+ *
Default:
+ *Aurora DB clusters - aurora
+ *
Multi-AZ DB clusters - io1
+ *
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:
+ *Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
+ *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:
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
* *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, specify0.
* 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 isarn: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:
*7
- *- * month * 31, where month is a number of months from 1-23
- *731
- *For example, the following values are valid:
- *93 (3 months * 31)
- *341 (11 months * 31)
+ *7
+ *
* 589 (19 months * 31)
+ *
+ * month * 31, where month is a number of months from 1-23.
+ * Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
+ *
+ * 731
+ *
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.
The network type of the DB cluster.
- *Valid values:
- *
- * IPV4
- *
- * DUAL
- *
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).
Valid for: Aurora DB clusters only
+ *Valid for Cluster Type: Aurora DB clusters only
+ *Valid Values: IPV4 | DUAL
+ *
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.
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.
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.
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:
*7
- *- * month * 31, where month is a number of months from 1-23
- *731
- *For example, the following values are valid:
- *93 (3 months * 31)
- *341 (11 months * 31)
+ *7
+ *
* 589 (19 months * 31)
+ *
+ * month * 31, where month is a number of months from 1-23.
+ * Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
+ *
+ * 731
+ *
This setting is only for non-Aurora Multi-AZ DB clusters.
+ *Default: 7 days
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:
- *
- * IPV4
- *
- * DUAL
- *
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).
This setting is only for Aurora DB clusters.
+ *Valid Values: IPV4 | DUAL
+ *
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:
- *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 specified database engine
- *- * 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:
- *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 specified database engine
- *- * 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:
- *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 specified database engine
- *- * 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:
- *Can't be longer than 8 characters
- *- * 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:
- *It must contain 1 to 8 alphanumeric characters.
- *It must contain a letter.
- *It can't be a word reserved by the database engine.
- *- * 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:
- *It must contain 1 to 64 alphanumeric characters.
- *It can't be a word reserved by the database engine.
- *- * 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:
- *It must contain 1 to 63 alphanumeric characters.
- *It must begin with a letter. - * Subsequent characters can be letters, underscores, or digits - * (0 to 9).
- *It can't be a word reserved by the - * database engine.
- *The meaning of this parameter differs depending on the database engine.
+ *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.
+ *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:
*The amount of storage in gibibytes (GiB) to allocate for the DB instance.
- *Type: Integer
- *- * Amazon Aurora - *
- *Not applicable. Aurora cluster volumes automatically grow as the amount of data in your - * database increases, though you are only charged for the space that you use in an Aurora cluster volume.
- *- * Amazon RDS Custom - *
- *Constraints to the amount of storage for each storage type are the following:
- *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, - * 16384 for RDS Custom for SQL Server.
- *Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, - * 16384 for RDS Custom for SQL Server.
- *- * MySQL - *
- *Constraints to the amount of storage for each storage type are the following:
- *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
- *Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- *Magnetic storage (standard): Must be an integer from 5 to 3072.
- *- * MariaDB - *
- *Constraints to the amount of storage for each storage type are the following:
- *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
- *Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- *Magnetic storage (standard): Must be an integer from 5 to 3072.
- *- * PostgreSQL - *
- *Constraints to the amount of storage for each storage type are the following:
- *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
- *Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- *Magnetic storage (standard): Must be an integer from 5 to 3072.
- *- * Oracle - *
- *Constraints to the amount of storage for each storage type are the following:
- *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
- *Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- *Magnetic storage (standard): Must be an integer from 10 to 3072.
- *- * SQL Server - *
- *Constraints to the amount of storage for each storage type are the following:
- *General Purpose (SSD) storage (gp2, gp3):
+ *This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your + * database increases, though you are only charged for the space that you use in an Aurora cluster volume.
+ *Constraints to the amount of storage for each storage type are the following:
*Enterprise and Standard editions: Must be an integer from 20 to 16384.
+ *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, + * 16384 for RDS Custom for SQL Server.
*Web and Express editions: Must be an integer from 20 to 16384.
+ *Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, + * 16384 for RDS Custom for SQL Server.
*Provisioned IOPS storage (io1):
+ * + *Constraints to the amount of storage for each storage type are the following:
*Enterprise and Standard editions: Must be an integer from 100 to 16384.
+ *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
+ *Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
*Web and Express editions: Must be an integer from 100 to 16384.
+ *Magnetic storage (standard): Must be an integer from 5 to 3072.
*Magnetic storage (standard):
+ * + *Constraints to the amount of storage for each storage type are the following:
*Enterprise and Standard editions: Must be an integer from 20 to 1024.
+ *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
*Web and Express editions: Must be an integer from 20 to 1024.
+ *Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ *Magnetic storage (standard): Must be an integer from 5 to 3072.
*Constraints to the amount of storage for each storage type are the following:
+ *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
+ *Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ *Magnetic storage (standard): Must be an integer from 10 to 3072.
+ *Constraints to the amount of storage for each storage type are the following:
+ *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
+ *Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ *Magnetic storage (standard): Must be an integer from 5 to 3072.
+ *Constraints to the amount of storage for each storage type are the following:
+ *General Purpose (SSD) storage (gp2, gp3):
+ *Enterprise and Standard editions: Must be an integer from 20 to 16384.
+ *Web and Express editions: Must be an integer from 20 to 16384.
+ *Provisioned IOPS storage (io1):
+ *Enterprise and Standard editions: Must be an integer from 100 to 16384.
+ *Web and Express editions: Must be an integer from 100 to 16384.
+ *Magnetic storage (standard):
+ *Enterprise and Standard editions: Must be an integer from 20 to 1024.
+ *Web and Express editions: Must be an integer from 20 to 1024.
+ *The compute and memory capacity of the DB instance, for example db.m5.large. + *
The compute and memory capacity of the DB instance, for example The name of the database engine to be used for this instance. Not every database engine is available for every Amazon Web Services Region. The database engine to use for this DB instance. Not every database engine is available in every Amazon Web Services Region. Valid Values:
- * db.m5.large.
* 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
@@ -6282,8 +6273,8 @@ export interface CreateDBInstanceMessage {
DBInstanceClass: string | undefined;
/**
- *
*
custom-oracle-ee (for RDS Custom for Oracle DB instances)
- * custom-oracle-ee (for RDS Custom for Oracle DB instances)
- * custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
- *
custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
*
- * custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
- *
custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
*
- * custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
- *
custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
*
- * custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
- *
custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
* @@ -6380,19 +6366,11 @@ export interface CreateDBInstanceMessage { /** *
The name for the master user.
- *- * Amazon Aurora - *
- *Not applicable. The name for the master user is managed by the DB cluster.
- *- * Amazon RDS - *
+ *This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.
+ *This setting is required for RDS DB instances.
*Constraints:
*Required.
- *Must be 1 to 16 letters, numbers, or underscores.
*The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
- *- * Amazon Aurora - *
- *Not applicable. The password for the master user is managed by the DB + *
The password for the master user.
+ *This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB * cluster.
- *Constraints: Can't be specified if ManageMasterUserPassword is turned on.
- * MariaDB - *
- *Constraints: Must contain from 8 to 41 characters.
- *- * Microsoft SQL Server - *
- *Constraints: Must contain from 8 to 128 characters.
- *- * MySQL - *
- *Constraints: Must contain from 8 to 41 characters.
- *- * Oracle - *
- *Constraints: Must contain from 8 to 30 characters.
- *- * PostgreSQL - *
- *Constraints: Must contain from 8 to 128 characters.
+ *Constraints:
+ *Can't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@".
+ *Length Constraints:
+ *RDS for MariaDB - Must contain from 8 to 41 characters.
+ *RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
+ *RDS for MySQL - Must contain from 8 to 41 characters.
+ *RDS for Oracle - Must contain from 8 to 30 characters.
+ *RDS for PostgreSQL - Must contain from 8 to 128 characters.
+ *A list of Amazon EC2 VPC security groups to associate with this DB instance.
- *- * Amazon Aurora - *
- *Not applicable. The associated list of EC2 VPC security groups is managed by + *
This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by * the DB cluster.
*Default: The default EC2 VPC security group for the DB subnet group's VPC.
*/ @@ -6459,55 +6437,82 @@ export interface CreateDBInstanceMessage { * Amazon Web Services Regions and Availability Zones, see * Regions * and Availability Zones. - *- * Amazon Aurora - *
- *Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these + *
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these * Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
*Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
+ *Constraints:
+ *The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
+ *Example: us-east-1d
*
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
- * The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
- *Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
+ *Constraints:
+ *Must match the name of an existing DB subnet group.
+ *Must not be default.
Example: mydbsubnetgroup
*
The time range each week during which system maintenance can occur, - * in Universal Coordinated Time (UTC). - * For more information, see Amazon RDS Maintenance Window.
- *Format: ddd:hh24:mi-ddd:hh24:mi
+ *
The time range each week during which system maintenance can occur. + * For more information, see Amazon RDS Maintenance Window + * in the Amazon RDS User Guide. *
*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.
- *Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
- *Constraints: Minimum 30-minute window.
+ *Constraints:
+ *Must be in the format ddd:hh24:mi-ddd:hh24:mi.
The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC).
+ *Must not conflict with the preferred backup window.
+ *Must be at least 30 minutes.
+ *The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then - * the default DB parameter group for the specified DB engine and version is used.
- *This setting doesn't apply to RDS Custom.
+ *The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then + * Amazon RDS uses the default DB parameter group for the specified DB engine and version.
+ *This setting doesn't apply to RDS Custom DB instances.
*Constraints:
*It must be 1 to 255 letters, numbers, or hyphens.
+ *Must be 1 to 255 letters, numbers, or hyphens.
*The first character must be a letter.
*It can't end with a hyphen or contain two consecutive hyphens.
+ *Can't end with a hyphen or contain two consecutive hyphens.
*The number of days for which automated backups are retained. Setting this parameter to a positive number enables - * backups. Setting this parameter to 0 disables automated backups.
- *
- * Amazon Aurora
+ * backups. Setting this parameter to 0 disables automated backups.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.
+ *Default: 1
*
Not applicable. The retention period for automated backups is managed by the DB cluster.
- *Default: 1
*Constraints:
*Must be a value from 0 to 35
+ *Must be a value from 0 to 35.
*Can't be set to 0 if the DB instance is a source to read replicas
+ *Can't be set to 0 if the DB instance is a source to read replicas.
*Can't be set to 0 for an RDS Custom for Oracle DB instance
+ *Can't be set to 0 for an RDS Custom for Oracle DB instance.
*BackupRetentionPeriod parameter.
* The default is a 30-minute window selected at random from an
* 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
- * - * Amazon Aurora - *
- *Not applicable. The daily time range for creating automated backups is managed by + *
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by * the DB cluster.
*Constraints:
*The port number on which the database accepts connections.
- *- * MySQL - *
- *Default: 3306
- *
Valid values: 1150-65535
- *
Type: Integer
- *- * MariaDB - *
- *Default: 3306
- *
Valid values: 1150-65535
- *
Type: Integer
- *- * PostgreSQL - *
- *Default: 5432
- *
Valid values: 1150-65535
- *
Type: Integer
- *- * Oracle - *
- *Default: 1521
- *
Valid values: 1150-65535
- *
- * SQL Server - *
- *Default: 1433
+ *
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
+ *Valid Values: 1150-65535
*
Valid values: 1150-65535 except 1234, 1434,
- * 3260, 3343, 3389, 47001, and
+ *
Default:
+ *RDS for MariaDB - 3306
+ *
RDS for Microsoft SQL Server - 1433
+ *
RDS for MySQL - 3306
+ *
RDS for Oracle - 1521
+ *
RDS for PostgreSQL - 5432
+ *
Constraints:
+ *For RDS for Microsoft SQL Server, the value can't be 1234, 1434,
+ * 3260, 3343, 3389, 47001, or
* 49152-49156.
- * Amazon Aurora - *
- *Default: 3306
- *
Valid values: 1150-65535
- *
Type: Integer
+ *A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set + *
Specifies whether the DB instance is a Multi-AZ deployment. You can't set
* the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
- *- * Amazon Aurora - *
- *Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
+ *This setting doesn't apply to the following DB instances:
+ *Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
+ *RDS Custom
+ *The version number of the database engine to use.
+ *This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB + * instance uses is managed by the DB cluster.
*For a list of valid engine versions, use the DescribeDBEngineVersions
* operation.
The following are the database engines and links to information about the major and minor versions that are available with * Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
- *- * Amazon Aurora - *
- *Not applicable. The version number of the database engine to be used by the DB - * instance is managed by the DB cluster.
- *- * Amazon RDS Custom for Oracle - *
- *A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV
- * name has the following format: 19.customized_string. A valid CEV name is
- * 19.my_cev1. For more information, see
- * Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
- * Amazon RDS Custom for SQL Server - *
- *See RDS Custom for SQL Server general requirements - * in the Amazon RDS User Guide.
- *- * MariaDB - *
- *For information, see MariaDB on Amazon RDS Versions in the - * Amazon RDS User Guide.
- *- * Microsoft SQL Server - *
- *For information, see Microsoft SQL Server Versions on Amazon RDS in the - * Amazon RDS User Guide.
- *- * MySQL - *
- *For information, see MySQL on Amazon RDS Versions in the - * Amazon RDS User Guide.
- *- * Oracle - *
- *For information, see Oracle Database Engine Release Notes in the - * Amazon RDS User Guide.
- *- * PostgreSQL - *
- *For information, see Amazon RDS for PostgreSQL versions and extensions in the - * Amazon RDS User Guide.
+ *A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV
+ * name has the following format: 19.customized_string. A valid CEV name is
+ * 19.my_cev1. For more information, see
+ * Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
See RDS Custom for SQL Server general requirements + * in the Amazon RDS User Guide.
+ *For information, see MariaDB on Amazon RDS versions in the + * Amazon RDS User Guide.
+ *For information, see Microsoft SQL Server versions on Amazon RDS in the + * Amazon RDS User Guide.
+ *For information, see MySQL on Amazon RDS versions in the + * Amazon RDS User Guide.
+ *For information, see Oracle Database Engine release notes in the + * Amazon RDS User Guide.
+ *For information, see Amazon RDS for PostgreSQL versions and extensions in the + * Amazon RDS User Guide.
+ *A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. + *
Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. * By default, minor engine upgrades are applied automatically.
*If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to
* false.
License model information for this DB instance.
- *Valid values: license-included | bring-your-own-license | general-public-license
- *
This setting doesn't apply to RDS Custom.
- *- * Amazon Aurora - *
- *Not applicable.
+ *The license model information for this DB instance.
+ *This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
+ *Valid Values:
+ *RDS for MariaDB - general-public-license
+ *
RDS for Microsoft SQL Server - license-included
+ *
RDS for MySQL - general-public-license
+ *
RDS for Oracle - bring-your-own-license | license-included
+ *
RDS for PostgreSQL - postgresql-license
+ *
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. + *
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. * For information about valid IOPS values, see * Amazon RDS DB instance storage * in the Amazon RDS User Guide.
- *Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 - * of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 + *
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
+ *Constraints:
+ *For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 * of the storage amount for the DB instance.
- *- * Amazon Aurora - *
- *Not applicable. Storage is managed by the DB cluster.
+ *For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
+ *A value that indicates that the DB instance should be associated with the specified option group.
+ *The option group to associate the DB instance with.
*Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed * from an option group. Also, that option group can't be removed from a DB instance after it is * associated with a DB instance.
- *This setting doesn't apply to RDS Custom.
- *- * Amazon Aurora - *
- *Not applicable.
+ *This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*/ OptionGroupName?: string; /** - *For supported engines, this value indicates that the DB instance should be associated with the
- * specified CharacterSet.
This setting doesn't apply to RDS Custom. However, if you need to change the character set, - * you can change it on the database itself.
- *- * Amazon Aurora - *
- *Not applicable. The character set is managed by + *
For supported engines, the character set (CharacterSet) to associate the DB instance with.
This setting doesn't apply to the following DB instances:
+ *Amazon Aurora - The character set is managed by
* the DB cluster. For more information, see CreateDBCluster.
RDS Custom - However, if you need to change the character set, + * you can change it on the database itself.
+ *The name of the NCHAR character set for the Oracle DB instance.
- *This parameter doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ NcharCharacterSetName?: string; /** - *A value that indicates whether the DB instance is publicly accessible.
+ *Specifies whether the DB instance is publicly accessible.
*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. @@ -6781,51 +6791,39 @@ export interface CreateDBInstanceMessage { Tags?: Tag[]; /** - *
The identifier of the DB cluster that the instance will belong to.
- *This setting doesn't apply to RDS Custom.
+ *The identifier of the DB cluster that this DB instance will belong to.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ DBClusterIdentifier?: string; /** - *Specifies the storage type to be associated with the DB instance.
- *Valid values: gp2 | gp3 | io1 | standard
- *
The storage type to associate with the DB instance.
*If you specify io1 or gp3, you must also include a value for the
* Iops parameter.
Default: io1 if the Iops parameter
- * is specified, otherwise gp2
- *
- * Amazon Aurora + *
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
+ *Valid Values: gp2 | gp3 | io1 | standard
*
Not applicable. Storage is managed by the DB cluster.
+ *Default: io1, if the Iops parameter
+ * is specified. Otherwise, gp2.
The ARN from the key store with which to associate the instance for TDE encryption.
- *This setting doesn't apply to RDS Custom.
- *- * Amazon Aurora - *
- *Not applicable.
+ *This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*/ TdeCredentialArn?: string; /** *The password for the given ARN from the key store in order to access the device.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ TdeCredentialPassword?: string; /** - *A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
- *For RDS Custom instances, either set this parameter to true or leave it unset.
- * If you set this parameter to false, RDS reports an error.
- * Amazon Aurora - *
- *Not applicable. The encryption for DB instances is managed by the DB cluster.
+ *Specifes whether the DB instance is encrypted. By default, it isn't encrypted.
+ *For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.
+ *This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.
*/ StorageEncrypted?: boolean; @@ -6833,55 +6831,52 @@ export interface CreateDBInstanceMessage { *The Amazon Web Services KMS key identifier for an encrypted DB instance.
*The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
- *- * Amazon Aurora - *
- *Not applicable. The Amazon Web Services KMS key identifier is managed by + *
This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by
* the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do
* not specify a value for the KmsKeyId parameter, 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.
- * Amazon RDS Custom - *
- *A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty + *
For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty
* while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom
* doesn't use the default key when this parameter is empty. You must explicitly specify a key.
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL - * Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
+ *The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL + * Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
*For more information, see * Kerberos Authentication in the Amazon RDS User Guide.
- *This setting doesn't apply to RDS Custom.
- *- * Amazon Aurora - *
- *Not applicable. The domain is managed by the DB cluster.
+ *This setting doesn't apply to the following DB instances:
+ *Amazon Aurora (The domain is managed by the DB cluster.)
+ *RDS Custom
+ *A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
- *- * Amazon Aurora - *
- *Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this + *
Spcifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
+ *This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this * value for an Aurora DB instance has no effect on the DB cluster setting.
*/ CopyTagsToSnapshot?: boolean; /** *The interval, in seconds, between points when Enhanced Monitoring metrics are collected for - * the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
+ * the DB instance. To disable collection of Enhanced Monitoring metrics, specify0.
* If MonitoringRoleArn is specified, then you must set MonitoringInterval
- * to a value other than 0.
This setting doesn't apply to RDS Custom.
- *Valid Values: 0, 1, 5, 10, 15, 30, 60
+ * to a value other than 0.
This setting doesn't apply to RDS Custom DB instances.
+ *Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
+ *
Default: 0
*
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, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
+ *If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
*/ MonitoringRoleArn?: string; /** - *Specify the name of the IAM role to be used when making API calls to the Directory Service.
- *This setting doesn't apply to RDS Custom.
- *- * Amazon Aurora - *
- *Not applicable. The domain is managed by the DB cluster.
+ *The name of the IAM role to use when making API calls to the Directory Service.
+ *This setting doesn't apply to the following DB instances:
+ *Amazon Aurora (The domain is managed by the DB cluster.)
+ *RDS Custom
+ *A value that specifies the order in which an Aurora Replica is promoted to the primary instance + *
The order of priority in which an Aurora Replica is promoted to the primary instance * after a failure of the existing primary instance. For more information, - * see + * see * Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
- *This setting doesn't apply to RDS Custom.
- *Default: 1
- *Valid Values: 0 - 15
+ *This setting doesn't apply to RDS Custom DB instances.
+ *Default: 1
+ *
Valid Values: 0 - 15
+ *
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management + *
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 for MySQL and PostgreSQL in the Amazon RDS User Guide.
- *This setting doesn't apply to RDS Custom.
- *- * Amazon Aurora - *
- *Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
+ *This setting doesn't apply to the following DB instances:
+ *Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)
+ *RDS Custom
+ *A value that indicates whether to enable Performance Insights for the DB instance. For more information, see + *
Specifies whether to enable Performance Insights for the DB instance. For more information, see * Using Amazon Performance Insights in the Amazon RDS User Guide.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ EnablePerformanceInsights?: boolean; /** *The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
*The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- *If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS
+ *
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.
This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ 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 doesn't apply to RDS Custom DB instances.
+ *Valid Values:
*7
+ *
+ * 7
+ *
- * month * 31, where month is a number of months from 1-23
+ * month * 31, where month is a number of months from 1-23. + * Examples:93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
* 731
+ *
+ * 731
+ *
For example, the following values are valid:
+ *Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see + * + * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
+ *This setting doesn't apply to the following DB instances:
*93 (3 months * 31)
+ *Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
*341 (11 months * 31)
+ *RDS Custom
*The following values are valid for each DB engine:
+ *589 (19 months * 31)
+ *RDS for MariaDB - audit | error | general | slowquery
+ *
731
+ *RDS for Microsoft SQL Server - agent | error
+ *
RDS for MySQL - audit | error | general | slowquery
+ *
RDS for Oracle - alert | audit | listener | trace | oemagent
+ *
RDS for PostgreSQL - postgresql | upgrade
+ *
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
- *This setting doesn't apply to RDS Custom.
- */ - PerformanceInsightsRetentionPeriod?: 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. For more information, see - * - * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
- *- * Amazon Aurora - *
- *Not applicable. CloudWatch Logs exports are managed by the DB cluster.
- *- * RDS Custom - *
- *Not applicable.
- *- * MariaDB - *
- *Possible values are audit, error, general, and slowquery.
- * Microsoft SQL Server - *
- *Possible values are agent and error.
- * MySQL - *
- *Possible values are audit, error, general, and slowquery.
- * Oracle - *
- *Possible values are alert, audit, listener, trace, and
- * oemagent.
- * PostgreSQL - *
- *Possible values are postgresql and upgrade.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
- *This setting doesn't apply to RDS Custom.
- *- * Amazon Aurora - *
- *Not applicable.
+ *This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*/ ProcessorFeatures?: ProcessorFeature[]; /** - *A value that indicates whether the DB instance has deletion protection enabled. + *
Specifies whether the DB instance has deletion protection enabled. * The database can't be deleted when deletion protection is enabled. By default, * deletion protection isn't enabled. For more information, see * * Deleting a DB Instance.
- *- * Amazon Aurora - *
- *Not applicable. You can enable or disable deletion protection for the DB cluster. + *
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster.
* For more information, see CreateDBCluster. DB instances in a DB
* cluster can be deleted even when deletion protection is enabled for the DB cluster.
This setting doesn't apply to RDS Custom.
- *- * Amazon Aurora - *
- *Not applicable. Storage is managed by the DB cluster.
+ *This setting doesn't apply to the following DB instances:
+ *Amazon Aurora (Storage is managed by the DB cluster.)
+ *RDS Custom
+ *A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS + *
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS * on Outposts DB instance.
*A CoIP provides local or external connectivity to resources in * your Outpost subnets through your on-premises network. For some use cases, a CoIP can @@ -7081,7 +7077,9 @@ export interface CreateDBInstanceMessage { /** *
The instance profile associated with the underlying Amazon EC2 instance of an - * RDS Custom DB instance. The instance profile must meet the following requirements:
+ * RDS Custom DB instance. + *This setting is required for RDS Custom.
+ *Constraints:
*The profile must exist in your account.
@@ -7096,33 +7094,31 @@ export interface CreateDBInstanceMessage { *For the list of permissions required for the IAM role, see * * Configure IAM and your VPC in the Amazon RDS User Guide.
- *This setting is required for RDS Custom.
*/ CustomIamInstanceProfile?: string; /** - *Specifies where automated backups and manual snapshots are stored.
- *Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working - * with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
- */ - BackupTarget?: string; - - /** - *The network type of the DB instance.
- *Valid values:
+ *The location for storing automated backups and manual snapshots.
+ *Valie Values:
*
- * IPV4
- *
outposts (Amazon Web Services Outposts)
*
- * DUAL
- *
region (Amazon Web Services Region)
* Default: region
+ *
For more information, see Working + * with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
+ */ + BackupTarget?: string; + + /** + *The network type of the DB instance.
*The network type is determined by the DBSubnetGroup specified for the DB instance.
* A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6
* protocols (DUAL).
Valid Values: IPV4 | DUAL
+ *
Specifies the storage throughput value for the DB instance.
+ *The storage throughput value for the DB instance.
*This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
+ *This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*/ StorageThroughput?: number; /** - *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. *
@@ -7172,8 +7170,8 @@ export interface CreateDBInstanceMessage { MasterUserSecretKmsKeyId?: string; /** - *Specifies the CA certificate identifier to use for the DB instance’s server certificate.
- *This setting doesn't apply to RDS Custom.
+ *The CA certificate identifier to use for the DB instance's server certificate.
+ *This setting doesn't apply to RDS Custom DB instances.
*For more information, see Using SSL/TLS to encrypt a connection to a DB
* instance in the Amazon RDS User Guide and
*
@@ -7676,22 +7674,22 @@ export interface DBInstanceStatusInfo {
*/
export interface DBInstance {
/**
- * Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance. The user-supplied database identifier. This identifier is the unique key that identifies a DB instance. Contains the name of the compute and memory capacity class of the DB instance. The name of the compute and memory capacity class of the DB instance. The name of the database engine to be used for this DB instance. The database engine used for this DB instance. Specifies the current state of this database. The current state of this database. For information about DB instance statuses, see
* Viewing DB instance status
* in the Amazon RDS User Guide.
@@ -7705,51 +7703,50 @@ export interface DBInstance {
AutomaticRestartTime?: Date;
/**
- * Contains the master username for the DB instance. The master username for the DB instance. The meaning of this parameter differs according to the database engine you use.
- * MySQL, MariaDB, SQL Server, PostgreSQL
- * Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance. Type: String
- * Oracle
- * Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance. The meaning of this parameter differs depending on the database engine. For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance. For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance. Specifies the connection endpoint. The connection endpoint for the DB instance. The endpoint might not be shown for instances whose status is The endpoint might not be shown for instances with the status of Specifies the allocated storage size specified in gibibytes (GiB). The amount of storage in gibibytes (GiB) allocated for the DB instance. Provides the date and time the DB instance was created. The date and time when the DB instance was created. 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 Specifies the number of days for which automatic DB snapshots are retained. The number of days for which automatic DB snapshots are retained. Provides a list of VPC security group elements that the DB instance belongs to. The list of Amazon EC2 VPC security groups that the DB instance belongs to. Provides the list of DB parameter groups applied to this DB instance. The list of DB parameter groups applied to this DB instance. Specifies the name of the Availability Zone the DB instance is located in. The name of the Availability Zone where the DB instance is located. Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group. Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group. 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). A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements. Specifies the latest time to which a database can be restored with point-in-time restore. The latest time to which a database in this DB instance can be restored with point-in-time restore. Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom. Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. Indicates the database engine version. The version of the database engine. A value that indicates that minor version patches are applied automatically. Indicates whether minor version patches are applied automatically. Contains the identifier of the source DB instance if this DB instance is a read
+ * The identifier of the source DB instance if this DB instance is a read
* replica. Contains one or more identifiers of the read replicas associated with this DB
+ * The identifiers of the read replicas associated with this DB
* instance. Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance
+ * The identifiers of Aurora DB clusters to which the RDS DB instance
* is replicated as a read replica. For example, when you create an Aurora read replica of
* an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is
* shown. This output doesn't contain information about cross-Region Aurora read
@@ -7844,17 +7841,17 @@ export interface DBInstance {
ReplicaMode?: ReplicaMode | string;
/**
- * License model information for this DB instance. This setting doesn't apply to RDS Custom. The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances. Specifies the Provisioned IOPS (I/O operations per second) value. The Provisioned IOPS (I/O operations per second) value for the DB instance. Provides the list of option group memberships for this DB instance. The list of option group memberships for this DB instance. Specifies the accessibility options for the DB instance. Indicates whether the DB instance 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
@@ -7888,13 +7885,13 @@ export interface DBInstance {
PubliclyAccessible?: boolean;
/**
- * The status of a read replica. If the instance isn't a read replica, this is
+ * The status of a read replica. If the DB instance isn't a read replica, the value is
* blank. Specifies the storage type associated with the DB instance. The storage type associated with the DB instance. Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port. The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port. If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of. Specifies whether the DB instance is encrypted. Indicates whether the DB instance is encrypted. If If The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
- * Amazon Aurora
- * Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this
+ * Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this
* value for an Aurora DB instance has no effect on the DB cluster setting. For more
* information, see A value that specifies the order in which an Aurora Replica is promoted to the primary instance
- * after a failure of the existing primary instance. For more information,
- * see
+ * The order of priority in which an Aurora Replica is promoted to the primary instance
+ * after a failure of the existing primary instance. For more information,
+ * see
* Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see
* IAM database authentication
* in the Amazon RDS User Guide and IAM
@@ -8004,7 +7998,7 @@ export interface DBInstance {
IAMDatabaseAuthenticationEnabled?: boolean;
/**
- * True if Performance Insights is enabled for the DB instance, and otherwise false. Indicates whether Performance Insights is enabled for the DB instance. 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 Values: 7
- * month * 31, where month is a number of months from 1-23 731 For example, the following values are valid: 93 (3 months * 31) 341 (11 months * 31)
+ *
*/
DBName?: string;
/**
- * creating.creating.BackupRetentionPeriod.StorageEncrypted is true, the Amazon Web Services KMS key identifier
+ * StorageEncrypted is enabled, the Amazon Web Services KMS key identifier
* for the encrypted DB instance.DBCluster.
*
- *
- *
7
+ *
589 (19 months * 31)
+ *
+ * month * 31, where month is a number of months from 1-23.
+ * Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
+ *
+ * 731
+ *
Default: 7 days
A list of log types that this DB instance is configured to export to CloudWatch Logs.
*Log types vary by DB engine. For information about the log types for each DB engine, see - * Amazon RDS Database Log Files in the Amazon RDS User Guide. + * Monitoring Amazon RDS log files in the Amazon RDS User Guide. *
*/ EnabledCloudwatchLogsExports?: string[]; @@ -8060,7 +8046,7 @@ export interface DBInstance { ProcessorFeatures?: ProcessorFeature[]; /** - *Indicates if the DB instance has deletion protection enabled. + *
Indicates whether the DB instance has deletion protection enabled.
* The database can't be deleted when deletion protection is enabled.
* For more information, see
*
@@ -8074,7 +8060,7 @@ export interface DBInstance {
AssociatedRoles?: DBInstanceRole[];
/**
- * Specifies the listener connection endpoint for SQL Server Always On. The listener connection endpoint for SQL Server Always On. Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in
* your Outpost subnets through your on-premises network. For some use cases, a CoIP can
* provide lower latency for connections to the DB instance from outside of its virtual
@@ -8175,25 +8161,12 @@ export interface DBInstance {
CustomIamInstanceProfile?: string;
/**
- * Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region. The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region. The network type of the DB instance. Valid values:
- *
- * The network type is determined by the
- *
* IPV4
- * DUAL
- * DBSubnetGroup specified for the DB instance.
* A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6
* protocols (DUAL).
Valid Values: IPV4 | DUAL
+ *
Specifies the storage throughput for the DB instance.
+ *The storage throughput for the DB instance.
*This setting applies only to the gp3 storage type.
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also - * the name of the CDB. This setting is valid for RDS Custom only.
+ * the name of the CDB. This setting is only valid for RDS Custom DB instances. */ 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. *
@@ -8238,7 +8213,7 @@ export interface DBInstance { CertificateDetails?: CertificateDetails; /** - *Contains the identifier of the source DB cluster if this DB instance is a read + *
The identifier of the source DB cluster if this DB instance is a read * replica.
*/ ReadReplicaSourceDBClusterIdentifier?: string; @@ -12219,7 +12194,7 @@ export interface DescribeDBClusterParametersMessage { */ export interface DBClusterMessage { /** - *A pagination token that can be used in a later DescribeDBClusters request.
+ *A pagination token that can be used in a later DescribeDBClusters request.
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, - * information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
+ * information for only the specific DB cluster is returned. This parameter isn't case-sensitive. *Constraints:
*If supplied, must match an existing DBClusterIdentifier.
+ *If supplied, must match an existing DB cluster identifier.
*A filter that specifies one or more DB clusters to describe.
- *Supported filters:
+ *Supported Filters:
*@@ -12303,7 +12278,7 @@ export interface DescribeDBClustersMessage { Marker?: string; /** - *
Optional Boolean parameter that specifies whether the output includes information about clusters + *
Specifies whether the output includes information about clusters * shared from other Amazon Web Services accounts.
*/ IncludeShared?: boolean; @@ -12900,7 +12875,7 @@ export interface DescribeDBInstancesMessage { *Constraints:
*If supplied, must match the identifier of an existing DBInstance.
+ *If supplied, must match the identifier of an existing DB instance.
*A filter that specifies one or more DB instances to describe.
- *Supported filters:
+ *Supported Filters:
*@@ -12924,8 +12899,8 @@ export interface DescribeDBInstancesMessage { *
- * dbi-resource-id - Accepts DB instance resource identifiers. The results list will
- * only include information about the DB instances identified by these DB instance resource identifiers.
dbi-resource-id - Accepts DB instance resource identifiers. The results list
+ * only includes information about the DB instances identified by these DB instance resource identifiers.
* diff --git a/clients/client-rds/src/models/models_1.ts b/clients/client-rds/src/models/models_1.ts index a79e3c735566..68e810a10708 100644 --- a/clients/client-rds/src/models/models_1.ts +++ b/clients/client-rds/src/models/models_1.ts @@ -3660,34 +3660,38 @@ export interface CloudwatchLogsExportConfiguration { export interface ModifyDBClusterMessage { /** *
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
- *Constraints: This identifier must match the identifier of an existing DB - * cluster.
- *Valid for: Aurora DB clusters and Multi-AZ DB clusters
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
+ *Constraints:
+ *Must match the identifier of an existing DB cluster.
+ *The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*Constraints:
*Must contain from 1 to 63 letters, numbers, or hyphens
+ *Must contain from 1 to 63 letters, numbers, or hyphens.
*The first character must be a letter
+ *The first character must be a letter.
*Can't end with a hyphen or contain two consecutive hyphens
+ *Can't end with a hyphen or contain two consecutive hyphens.
*Example: my-cluster2
*
Valid for: Aurora DB clusters and Multi-AZ DB clusters
*/ NewDBClusterIdentifier?: string; /** - *A value that indicates whether the modifications in this request and any pending modifications are + *
Specifies whether the modifications in this request and any pending modifications are
* asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting
* for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next
* maintenance window.
By default, this parameter is disabled.
- *Valid for: Aurora DB clusters and Multi-AZ DB clusters
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ ApplyImmediately?: boolean; /** - *The number of days for which automated backups are retained. Specify a minimum value of 1.
- *Default: 1
+ *The number of days for which automated backups are retained. Specify a minimum value of 1.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
+ *Default: 1
+ *
Constraints:
*Must be a value from 1 to 35
+ *Must be a value from 1 to 35.
*Valid for: Aurora DB clusters and Multi-AZ DB clusters
*/ BackupRetentionPeriod?: number; /** *The name of the DB cluster parameter group to use for 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
*/ DBClusterParameterGroupName?: string; /** - *A list of VPC security groups that the DB cluster will belong to.
- *Valid for: Aurora DB clusters and Multi-AZ DB clusters
+ *A list of EC2 VPC security groups to associate with this DB cluster.
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ VpcSecurityGroupIds?: string[]; /** *The port number on which the DB cluster accepts connections.
- *Constraints: Value must be 1150-65535
+ *
Valid for Cluster Type: Aurora DB clusters only
+ *Valid Values: 1150-65535
*
Default: The same port as the original DB cluster.
- *Valid for: Aurora DB clusters only
*/ Port?: number; /** - *The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
+ *The new password for the master database user.
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*Constraints:
*Must contain from 8 to 41 characters.
*Can contain any printable ASCII character except "/", """, or "@".
+ *Can't be specified if ManageMasterUserPassword is turned on.
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; @@ -3763,6 +3771,7 @@ export interface ModifyDBClusterMessage { * To view the time blocks available, see * * Backup window in the Amazon Aurora User Guide. + *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*Constraints:
*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
- *
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:
+ *Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
+ *Must be at least 30 minutes.
+ *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:
*If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*Valid for: Aurora MySQL DB clusters only
*/ BacktrackWindow?: number; /** - *The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. 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 configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
+ *The following values are valid for each DB engine:
+ *Aurora MySQL - audit | error | general | slowquery
+ *
Aurora PostgreSQL - postgresql
+ *
RDS for MySQL - error | general | slowquery
+ *
RDS for PostgreSQL - postgresql | upgrade
+ *
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
*/ CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration; @@ -3872,16 +3894,21 @@ export interface ModifyDBClusterMessage { *
* aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
*
Valid for: Aurora DB clusters and Multi-AZ DB clusters
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ EngineVersion?: string; /** - *A value that indicates whether major version upgrades are allowed.
- *Constraints: You must allow major version upgrades when specifying a value for the + *
Specifies whether major version upgrades are allowed.
+ *Valid for Cluster Type: Aurora DB clusters only
+ *Constraints:
+ *You must allow major version upgrades when specifying a value for the
* EngineVersion parameter that is a different major version than the DB
* cluster's current version.
Valid for: Aurora DB clusters only
+ *Valid for Cluster Type: Aurora DB clusters only
*Default: The existing name setting
*Constraints:
*AllowMajorVersionUpgrade parameter for a major version upgrade only.
* Valid for: Aurora DB clusters only
*/ DBInstanceParameterGroupName?: string; @@ -3913,82 +3940,104 @@ export interface ModifyDBClusterMessage { * The domain must be created prior to this operation. *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; /** *The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
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; /** - *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; /** - *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 - * 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
+ * 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 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.
- *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: Multi-AZ DB clusters only
+ *Valid for Cluster Type: 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.
*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
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
+ *Valid Values:
+ *Aurora DB clusters - aurora | aurora-iopt1
+ *
Multi-AZ DB clusters - io1
+ *
Default:
+ *Aurora DB clusters - aurora
+ *
Multi-AZ DB clusters - io1
+ *
For information about valid IOPS values, see * Amazon RDS Provisioned IOPS storage * in the Amazon RDS User Guide.
- *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:
+ *Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
+ *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.
+ * To turn off collecting Enhanced Monitoring metrics, specify0.
* 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; @@ -4027,16 +4083,16 @@ export interface ModifyDBClusterMessage { * see To * create an IAM role for Amazon RDS 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; @@ -4046,41 +4102,33 @@ export interface ModifyDBClusterMessage { *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:
*7
- *- * month * 31, where month is a number of months from 1-23
- *731
- *For example, the following values are valid:
- *93 (3 months * 31)
- *341 (11 months * 31)
+ *7
+ *
* 589 (19 months * 31)
+ *
+ * month * 31, where month is a number of months from 1-23.
+ * Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
+ *
+ * 731
+ *
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.
The network type of the DB cluster.
- *Valid values:
- *
- * IPV4
- *
- * DUAL
- *
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).
Valid for: Aurora DB clusters only
+ *Valid for Cluster Type: Aurora DB clusters only
+ *Valid Values: IPV4 | DUAL
+ *
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.
*If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
* on this management. In this case, you can't specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the @@ -4129,12 +4166,12 @@ export interface ModifyDBClusterMessage { * in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager * in the Amazon Aurora User Guide. *
- *Valid for: Aurora DB clusters and Multi-AZ DB clusters
+ *Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ ManageMasterUserPassword?: boolean; /** - *A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the + *
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the * master user password.
*This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets * Manager for the DB cluster. The secret value contains the updated password.
@@ -4142,13 +4179,13 @@ export interface ModifyDBClusterMessage { * 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:
*You must apply the change immediately when rotating the master user password.
*Valid for: Aurora DB clusters and Multi-AZ DB clusters
*/ RotateMasterUserPassword?: boolean; @@ -4176,7 +4213,7 @@ export interface ModifyDBClusterMessage { * To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. *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; @@ -4187,16 +4224,21 @@ export interface ModifyDBClusterMessage { * *For more information, see * CreateDBCluster.
- *Valid for: Aurora DB clusters only
+ *Valid for Cluster Type: Aurora DB clusters only
*/ EngineMode?: string; /** - *A value that indicates whether engine mode changes from serverless to provisioned
+ *
Specifies whether engine mode changes from serverless to provisioned
* are allowed.
Constraints: You must allow engine mode changes when specifying a different value for the EngineMode parameter
+ *
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
+ *Constraints:
+ *You must allow engine mode changes when specifying a different value for the EngineMode parameter
* from the DB cluster's current engine mode.
Valid for: Aurora Serverless v1 DB clusters only
+ *The DB instance identifier. This value is stored as a lowercase string.
+ *The identifier of DB instance to modify. This value is stored as a lowercase string.
*Constraints:
*Must match the identifier of an existing DBInstance.
+ *Must match the identifier of an existing DB instance.
*The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
- *For MariaDB, MySQL, Oracle, and PostgreSQL, + *
For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, * the value supplied must be at least 10% greater than the current value. * Values that are not at least 10% greater than the existing value are rounded up * so that they are 10% greater than the current value.
@@ -4454,7 +4496,7 @@ export interface ModifyDBInstanceMessage { AllocatedStorage?: number; /** - *The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all + *
The new compute and memory capacity of the DB instance, for example Changing the subnet group causes an outage during the change.
* The change is applied during the next maintenance window,
* unless you enable This parameter doesn't apply to RDS Custom. Constraints: If supplied, must match the name of an existing DBSubnetGroup. This parameter doesn't apply to RDS Custom DB instances. Constraints: If supplied, must match existing DB subnet group. Example: A list of DB security groups to authorize on this DB instance. Changing this setting doesn't
* result in an outage and the change is asynchronously applied as soon as possible. This setting doesn't apply to RDS Custom. This setting doesn't apply to RDS Custom DB instances. Constraints: If supplied, must match existing DBSecurityGroups. If supplied, must match existing DB security groups. A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is
+ * A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is
* asynchronously applied as soon as possible. This setting doesn't apply to RDS Custom.
- * Amazon Aurora
- * Not applicable. The associated list of EC2 VPC security groups is managed by
- * the DB cluster. For more information, see This setting doesn't apply to the following DB instances: Amazon Aurora (The associated list of EC2 VPC security groups is managed by
+ * the DB cluster. For more information, see RDS Custom Constraints: If supplied, must match existing VpcSecurityGroupIds. If supplied, must match existing VPC security group IDs. A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible,
+ * Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible,
* regardless of the If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage
* and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in
@@ -4529,45 +4580,54 @@ export interface ModifyDBInstanceMessage {
ApplyImmediately?: boolean;
/**
- * The new password for the master user. The password can include any printable ASCII
- * character except "/", """, or "@". The new password for the master user. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
* Between the time of the request and the completion of the request,
* the This setting doesn't apply to RDS Custom.
- * Amazon Aurora
- * Not applicable. The password for the master user is managed by the DB cluster. For
- * more information, see Default: Uses existing setting Constraints: Can't be specified if
- * MariaDB
- * Constraints: Must contain from 8 to 41 characters.
- * Microsoft SQL Server
- * Constraints: Must contain from 8 to 128 characters.
- * MySQL
- * Constraints: Must contain from 8 to 41 characters.
- * Oracle
- * Constraints: Must contain from 8 to 30 characters.
- * PostgreSQL
- * Constraints: Must contain from 8 to 128 characters. Amazon RDS API operations never return the password,
* so this action provides a way to regain access to a primary instance user if the password is lost.
* This includes restoring privileges that might have been accidentally revoked. This setting doesn't apply to the following DB instances: Amazon Aurora (The password for the master user is managed by the DB cluster. For
+ * more information, see RDS Custom Default: Uses existing setting Constraints: Can't be specified if Can include any printable ASCII character except "/", """, or "@". Length Constraints: RDS for MariaDB - Must contain from 8 to 41 characters. RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. RDS for MySQL - Must contain from 8 to 41 characters. RDS for Oracle - Must contain from 8 to 30 characters. RDS for PostgreSQL - Must contain from 8 to 128 characters.db.m4.large. 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 or
* Aurora
@@ -4479,8 +4521,13 @@ export interface ModifyDBInstanceMessage {
* ApplyImmediately.
+ *
* mydbsubnetgroup
*
*
*/
DBSecurityGroups?: string[];
/**
- * ModifyDBCluster.
+ *
* ModifyDBCluster.)
*
*/
VpcSecurityGroupIds?: string[];
/**
- * PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.MasterUserPassword element exists in the
* PendingModifiedValues element of the operation response.ModifyDBCluster.ManageMasterUserPassword is turned on.
+ *
+ * ModifyDBCluster.)
+ *
+ * ManageMasterUserPassword is turned on.
+ *
*/
MasterUserPassword?: string;
@@ -4579,9 +4639,14 @@ export interface ModifyDBInstanceMessage {
* parameter changes aren't applied during the next maintenance window. However, if you modify
* dynamic parameters in the newly associated DB parameter group, these changes are applied
* immediately without a reboot.
This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*Default: Uses existing setting
- *Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
+ *Constraints:
+ *Must be in the same DB parameter group family as the DB instance.
+ *These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled
* for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously
* applied as soon as possible.
- * Amazon Aurora - *
- *Not applicable. The retention period for automated backups is managed by the DB + *
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB
* cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
*Constraints:
*It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to - * read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
+ *Must be a value from 0 to 35.
*It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or - * later.
+ *Can't be set to 0 if the DB instance is a source to + * read replicas.
*It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL - * 9.3.5.
+ *Can't be set to 0 for an RDS Custom for Oracle DB instance.
*BackupRetentionPeriod parameter.
* Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
- * The default is a 30-minute window selected at random from an
- * 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
- *
- * - * Amazon Aurora - *
- *Not applicable. The daily time range for creating automated backups is managed by
- * the DB cluster. For more information, see ModifyDBCluster.
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by
+ * the DB cluster. For more information, see ModifyDBCluster.
Constraints:
*Must be in the format hh24:mi-hh24:mi
+ *Must be in the format hh24:mi-hh24:mi.
Must be in Universal Time Coordinated (UTC)
+ *Must be in Universal Coordinated Time (UTC).
*Must not conflict with the preferred maintenance window
+ *Must not conflict with the preferred maintenance window.
*Must be at least 30 minutes
+ *Must be at least 30 minutes.
*The weekly time range (in UTC) during which system maintenance can occur, which + *
The weekly time range during which system maintenance can occur, which * might result in an outage. Changing this parameter doesn't result in an outage, except * in the following situation, and the change is asynchronously applied as soon as * possible. If there are pending actions that cause a reboot, and the maintenance window - * is changed to include the current time, then changing this parameter will cause a reboot - * of the DB instance. If moving this window to the current time, there must be at least 30 + * is changed to include the current time, then changing this parameter causes a reboot + * of the DB instance. If you change this window to the current time, there must be at least 30 * minutes between the current time and end of the window to ensure pending changes are * applied.
*For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide. *
*Default: Uses existing setting
- *Format: ddd:hh24:mi-ddd:hh24:mi
- *Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
- *Constraints: Must be at least 30 minutes
+ *Constraints:
+ *Must be in the format ddd:hh24:mi-ddd:hh24:mi.
The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC).
+ *Must not conflict with the preferred backup window.
+ *Must be at least 30 minutes.
+ *A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result + *
Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result
* in an outage. The change is applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ MultiAZ?: boolean; @@ -4683,12 +4754,12 @@ export interface ModifyDBInstanceMessage { * new DB parameter group in the DB parameter group family for the new engine version must * be specified. The new DB parameter group can be the default for that DB parameter group * family. - *If you specify only a major version, Amazon RDS will update the DB instance to the + *
If you specify only a major version, Amazon RDS updates the DB instance to the
* default minor version if the current minor version is lower.
* For information about valid engine versions, see CreateDBInstance,
* or call DescribeDBEngineVersions.
If the instance that you're modifying is acting as a read replica, the engine version - * that you specify must be the same or later than the version that the source DB instance + * that you specify must be the same or higher than the version that the source DB instance * or cluster is running.
*In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
* PATCH_DB_FAILURE lifecycle.
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't + *
Specifies whether major version upgrades are allowed. Changing this parameter doesn't * result in an outage and the change is asynchronously applied as soon as possible.
- *This setting doesn't apply to RDS Custom.
- *Constraints: Major version upgrades must be allowed when specifying a value - * for the EngineVersion parameter that is a different major version than the DB instance's current version.
+ *This setting doesn't apply to RDS Custom DB instances.
+ *Constraints:
+ *Major version upgrades must be allowed when specifying a value
+ * for the EngineVersion parameter that's a different major version than the DB instance's current version.
A value that indicates whether minor version upgrades are applied automatically to the DB instance + *
Specifies whether minor version upgrades are applied automatically to the DB instance * during the maintenance window. An outage occurs when all the following conditions are met:
*RDS has enabled automatic patching for the engine version.
*If any of the preceding conditions isn't met, RDS applies the change as soon as possible and + *
If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and * doesn't cause an outage.
- *For an RDS Custom DB instance, set AutoMinorVersionUpgrade
- * to false. Otherwise, the operation returns an error.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
*/ AutoMinorVersionUpgrade?: boolean; /** *The license model for the DB instance.
- *This setting doesn't apply to RDS Custom.
- *Valid values: license-included | bring-your-own-license |
- * general-public-license
- *
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
+ *Valid Values:
+ *RDS for MariaDB - general-public-license
+ *
RDS for Microsoft SQL Server - license-included
+ *
RDS for MySQL - general-public-license
+ *
RDS for Oracle - bring-your-own-license | license-included
+ *
RDS for PostgreSQL - postgresql-license
+ *
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, - * the value supplied must be at least 10% greater than the current value. + *
Constraints:
+ *For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. * Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
+ *Default: Uses existing setting
*/ Iops?: number; /** - *A value that indicates the DB instance should be associated with the specified option group.
+ *The option group to associate the DB instance with.
*Changing this parameter doesn't result in an outage, with one exception. If the parameter change results * in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which * new connections are rejected but existing connections aren't interrupted.
@@ -4769,15 +4868,15 @@ export interface ModifyDBInstanceMessage { *Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed * from an option group, and that option group can't be removed from a DB instance after * it is associated with a DB instance.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ OptionGroupName?: string; /** - *The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance + *
The new identifier for the DB instance when renaming a DB instance. When you change the DB instance
* identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur
- * during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom.
+ * during the next maintenance window if you disableApplyImmediately. This value is stored as a lowercase string.
+ * This setting doesn't apply to RDS Custom DB instances.
*Constraints:
*Specifies the storage type to be associated with the DB instance.
+ *The storage type to associate with the DB instance.
*If you specify Provisioned IOPS (io1),
* you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using @@ -4810,29 +4909,28 @@ export interface ModifyDBInstanceMessage { * instance are suspended. No other Amazon RDS operations can take place for the instance, * including modifying the instance, rebooting the instance, deleting the instance, * creating a read replica for the instance, and creating a DB snapshot of the instance.
- *Valid values: gp2 | gp3 | io1 | standard
- *
Default: io1 if the Iops parameter
- * is specified, otherwise gp2
+ *
Valid Values: gp2 | gp3 | io1 | standard
*
Default: io1, if the Iops parameter
+ * is specified. Otherwise, gp2.
The ARN from the key store with which to associate the instance for TDE encryption.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ TdeCredentialArn?: string; /** *The password for the given ARN from the key store in order to access the device.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ TdeCredentialPassword?: string; /** - *Specifies the CA certificate identifier to use for the DB instance’s server certificate.
- *This setting doesn't apply to RDS Custom.
+ *The CA certificate identifier to use for the DB instance6's server certificate.
+ *This setting doesn't apply to RDS Custom DB instances.
*For more information, see Using SSL/TLS to encrypt a connection to a DB * instance in the Amazon RDS User Guide and * @@ -4848,27 +4946,27 @@ export interface ModifyDBInstanceMessage { * Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
*For more information, see * Kerberos Authentication in the Amazon RDS User Guide.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ Domain?: string; /** - *A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
- *- * Amazon Aurora - *
- *Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this + *
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
+ *This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this
* value for an Aurora DB instance has no effect on the DB cluster setting. For more
* information, see ModifyDBCluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected - * for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
- *If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
- *Valid Values: 0, 1, 5, 10, 15, 30, 60
+ *
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for
+ * the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, set MonitoringInterval
+ * to a value other than 0.
This setting doesn't apply to RDS Custom DB instances.
+ *Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
+ *
Default: 0
*
If you change the DBPortNumber value, your database restarts regardless of
* the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
- *- * MySQL - *
- *Default: 3306
- *
Valid values: 1150-65535
- *
- * MariaDB - *
- *Default: 3306
- *
Valid values: 1150-65535
- *
- * PostgreSQL - *
- *Default: 5432
- *
Valid values: 1150-65535
+ *
This setting doesn't apply to RDS Custom DB instances.
+ *Valid Values: 1150-65535
*
Type: Integer
- *- * Oracle - *
- *Default: 1521
- *
Valid values: 1150-65535
- *
- * SQL Server - *
- *Default: 1433
- *
Valid values: 1150-65535 except 1234, 1434,
- * 3260, 3343, 3389, 47001, and
+ *
Default:
+ *Amazon Aurora - 3306
+ *
RDS for MariaDB - 3306
+ *
RDS for Microsoft SQL Server - 1433
+ *
RDS for MySQL - 3306
+ *
RDS for Oracle - 1521
+ *
RDS for PostgreSQL - 5432
+ *
Constraints:
+ *For RDS for Microsoft SQL Server, the value can't be 1234, 1434,
+ * 3260, 3343, 3389, 47001, or
* 49152-49156.
- * Amazon Aurora - *
- *Default: 3306
- *
Valid values: 1150-65535
- *
A value that indicates whether the DB instance is publicly accessible.
+ *Specifies whether the DB instance 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 @@ -4950,31 +5041,33 @@ export interface ModifyDBInstanceMessage { * see To * create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. *
- *If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn
+ *
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn
* value.
This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ MonitoringRoleArn?: string; /** *The name of the IAM role to use when making API calls to the Directory Service.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ DomainIAMRoleName?: string; /** - *A value that specifies the order in which an Aurora Replica is promoted to the primary instance
- * after a failure of the existing primary instance. For more information,
- * see
+ * The order of priority in which an Aurora Replica is promoted to the primary instance
+ * after a failure of the existing primary instance. For more information,
+ * see
* Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. Default: 1 Valid Values: 0 - 15 This setting doesn't apply to RDS Custom DB instances. Default: Valid Values: A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
+ * Specifies whether to enable mapping of Amazon Web Services Identity and Access Management
* (IAM) accounts to database accounts. By default, mapping isn't enabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB
* cluster.1
+ * 0 - 15
+ *
This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ EnableIAMDatabaseAuthentication?: boolean; /** - *A value that indicates whether to enable Performance Insights for the DB instance.
+ *Specifies whether to enable Performance Insights for the DB instance.
*For more information, see * Using Amazon Performance Insights in the Amazon RDS User Guide.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ EnablePerformanceInsights?: boolean; /** *The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
*The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- *If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS
+ *
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.
This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ 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 doesn't apply to RDS Custom DB instances.
+ *Valid Values:
*7
- *- * month * 31, where month is a number of months from 1-23
- *731
- *For example, the following values are valid:
- *93 (3 months * 31)
- *341 (11 months * 31)
+ *7
+ *
* 589 (19 months * 31)
+ *
+ * month * 31, where month is a number of months from 1-23.
+ * Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
+ *
+ * 731
+ *
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
- *This setting doesn't apply to RDS Custom.
+ *Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a + *
The log types to be enabled for export to CloudWatch Logs for a * specific DB instance.
*A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance
* immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration; /** *The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ ProcessorFeatures?: ProcessorFeature[]; /** - *A value that indicates whether the DB instance class of the DB instance uses its default + *
Specifies whether the DB instance class of the DB instance uses its default * processor features.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ UseDefaultProcessorFeatures?: boolean; /** - *A value that indicates whether the DB instance has deletion protection enabled. + *
Specifies whether the DB instance has deletion protection enabled. * The database can't be deleted when deletion protection is enabled. By default, * deletion protection isn't enabled. For more information, see * @@ -5075,12 +5160,12 @@ export interface ModifyDBInstanceMessage { * * Managing capacity automatically with Amazon RDS storage autoscaling * in the Amazon RDS User Guide.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ MaxAllocatedStorage?: number; /** - *A value that indicates whether the DB instance is restarted when you rotate your + *
Specifies whether the DB instance is restarted when you rotate your * SSL/TLS certificate.
*By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate * is not updated until the DB instance is restarted.
@@ -5102,7 +5187,7 @@ export interface ModifyDBInstanceMessage { * Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ CertificateRotationRestart?: boolean; @@ -5117,12 +5202,12 @@ export interface ModifyDBInstanceMessage { * accept user connections, a mounted replica can't serve a read-only workload. * For more information, see Working with Oracle Read Replicas for Amazon RDS * in the Amazon RDS User Guide. - *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ ReplicaMode?: ReplicaMode | string; /** - *A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
+ *Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
*A CoIP provides local or external connectivity to resources in * your Outpost subnets through your on-premises network. For some use cases, a CoIP can * provide lower latency for connections to the DB instance from outside of its virtual @@ -5136,12 +5221,12 @@ export interface ModifyDBInstanceMessage { /** *
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ AwsBackupRecoveryPointArn?: string; /** - *The automation mode of the RDS Custom DB instance: full or all paused.
+ *
The automation mode of the RDS Custom DB instance.
* If full, the DB instance automates monitoring and instance recovery. If
* all paused, the instance pauses automation for the duration set by
* ResumeFullAutomationModeMinutes.
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes
- * full automation. The minimum value is 60 (default). The maximum value is 1,440.
The network type of the DB instance.
- *Valid values:
+ * full automation. + *Default: 60
+ *
Constraints:
*
- * IPV4
- *
Must be at least 60.
*
- * DUAL
- *
Must be no more than 1,440.
*The network type of the DB instance.
*The network type is determined by the DBSubnetGroup specified for the DB instance.
* A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6
* protocols (DUAL).
Valid Values: IPV4 | DUAL
+ *
Specifies the storage throughput value for the DB instance.
+ *The storage throughput value for the DB instance.
*This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
+ *This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*/ StorageThroughput?: number; /** - *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.
*If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
* on this management. In this case, you can't specify MasterUserPassword.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the
* master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword.
- * In this case, RDS deletes the secret and uses the new password for the master user specified by
+ * In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by
* MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager * in the Amazon RDS User Guide. @@ -5208,7 +5293,7 @@ export interface ModifyDBInstanceMessage { ManageMasterUserPassword?: boolean; /** - *
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the + *
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the * master user password.
*This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets * Manager for the DB cluster. The secret value contains the updated password.
@@ -5563,6 +5648,16 @@ export interface ModifyDBSnapshotMessage { *
+ * 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB
+ * snapshots)
+ * 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB
+ * snapshots)
* 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
\nFor information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
\nFor information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which automated backups are retained.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The number of days for which automated backups are retained.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nDefault: 1\n
Constraints:
\nMust be a value from 1 to 35.
\nA value that indicates that the DB cluster should be associated with the specified CharacterSet.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The name of the character set (CharacterSet) to associate the DB cluster with.
Valid for Cluster Type: Aurora DB clusters only
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name for your database of up to 64 alphanumeric characters. If you don't\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB cluster identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The identifier for this DB cluster. This parameter is stored as a lowercase string.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the DB cluster parameter group to associate\n with this DB cluster. If you don't specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nA list of EC2 VPC security groups to associate with this DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A DB subnet group to associate with this DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A DB subnet group to associate with this DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust match the name of an existing DB subnet group.
\nMust not be default.
Example: mydbsubnetgroup\n
The name of the database engine to be used for this DB cluster.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The database engine to use for this DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: aurora-mysql | aurora-postgresql | mysql | postgres\n
The version number of the database engine to use.
\nTo list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible),\n use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or\n version 3, respectively.
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
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nFor information, see Database engine updates for Amazon Aurora MySQL in the \n Amazon Aurora User Guide.
\n\n Aurora PostgreSQL\n
\nFor information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.
\n\n MySQL\n
\nFor information, see Amazon RDS for MySQL in the Amazon RDS User Guide.
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The version number of the database engine to use.
\nTo list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible),\n use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or\n version 3, respectively.
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
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
For information about a specific engine, see the following topics:
\nAurora MySQL - see Database engine updates for Amazon Aurora MySQL in the \n Amazon Aurora User Guide.
\nAurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.
\nRDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide.
\nRDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the instances in the DB cluster accept connections.
\n\n RDS for MySQL and Aurora MySQL\n
\nDefault: 3306\n
Valid values: 1150-65535\n
\n RDS for PostgreSQL and Aurora PostgreSQL\n
\nDefault: 5432\n
Valid values: 1150-65535\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The port number on which the instances in the DB cluster accept connections.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: 1150-65535\n
Default:
\nRDS for MySQL and Aurora MySQL - 3306\n
RDS for PostgreSQL and Aurora PostgreSQL - 5432\n
The name of the master user for the DB cluster.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the master user for the DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints:
\nMust contain from 8 to 41 characters.
\nCan't be specified if ManageMasterUserPassword is turned on.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The password for the master database user.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust contain from 8 to 41 characters.
\nCan contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nCan't be specified if ManageMasterUserPassword is turned on.
A value that indicates that the DB cluster should be associated with the specified option group.
\nDB clusters are associated with a default option group that can't be modified.
" + "smithy.api#documentation": "The option group to associate the DB cluster with.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nThe default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nThe default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
\nMust be at least 30 minutes.
\nThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "Tags to assign to the DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Tags to assign to the DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster is encrypted.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether the DB cluster is encrypted.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the KMS key used to encrypt the\n source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nIf you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n 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
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS uses the KMS key used to encrypt the\n source. Otherwise, Amazon RDS uses your default KMS key.
If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n uses your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nIf you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make\n sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "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.
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.
The presigned URL request must contain the following parameter values:
\n\n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
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.
\nIf 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.
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.
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.
The presigned URL request must contain the following parameter values:
\n\n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
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.
\nIf 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.
Valid for Cluster Type: 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.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies 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.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" + "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
\nDefault: 0\n
Constraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The list of log types that need to be enabled for exporting to CloudWatch Logs.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nThe following values are valid for each DB engine:
\nAurora MySQL - audit | error | general | slowquery\n
Aurora PostgreSQL - postgresql\n
RDS for MySQL - error | general | slowquery\n
RDS for PostgreSQL - postgresql | upgrade\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.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
For information about limitations and requirements for Serverless DB clusters, see the \n following sections in the Amazon Aurora User Guide:
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
For information about limitations and requirements for Serverless DB clusters, see the \n following sections in the Amazon Aurora User Guide:
\nValid for Cluster Type: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for Cluster Type: Aurora DB clusters only
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to create the DB cluster in.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
\nFor more information, see Kerberos authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB cluster in.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
\nFor more information, see Kerberos authentication\n in the Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "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.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory Service.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n 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.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for Cluster Type: Multi-AZ DB clusters only
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nValid for Cluster Type: Multi-AZ DB clusters only
\nThis setting is required to create a Multi-AZ DB cluster.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nWhen 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
\nFor 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\n clusters, see Settings for creating Multi-AZ DB clusters.
" + "smithy.api#documentation": "The storage type to associate with the DB cluster.
\nFor 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\n clusters, see Settings for creating Multi-AZ DB clusters.
\nThis setting is required to create a Multi-AZ DB cluster.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values:
\nAurora DB clusters - aurora | aurora-iopt1\n
Multi-AZ DB clusters - io1\n
Default:
\nAurora DB clusters - aurora\n
Multi-AZ DB clusters - io1\n
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS\n User Guide.
\nThis setting is required to create a Multi-AZ DB cluster.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS\n User Guide.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for Cluster Type: Multi-AZ DB clusters only
\nConstraints:
\nMust be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nA value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nValid for Cluster Type: Multi-AZ DB clusters only
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nA value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for Cluster Type: Multi-AZ DB clusters only
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid for Cluster Type: Multi-AZ DB clusters only
\nValid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n
Default: 0\n
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n 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
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n 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 Cluster Type: Multi-AZ DB clusters only
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for Cluster Type: Multi-AZ DB clusters only
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The number of days to retain Performance Insights data.
\nValid for Cluster Type: Multi-AZ DB clusters only
\nValid Values:
\n\n 7\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
\n 731\n
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
The network type of the DB cluster.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The network type of the DB cluster.
\nThe network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid for Cluster Type: Aurora DB clusters only
\nValid Values: IPV4 | DUAL\n
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.
\nThis setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nIf you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.
\nThis setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nIf you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } } }, @@ -4116,46 +4116,46 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe 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.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe 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.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n Amazon RDS Custom for Oracle\n
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.
Default: ORCL\n
Constraints:
\nIt must contain 1 to 8 alphanumeric characters.
\nIt must contain a letter.
\nIt can't be a word reserved by the database engine.
\n\n Amazon RDS Custom for SQL Server\n
\nNot applicable. Must be null.
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe meaning of this parameter differs depending on the database engine.
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If you don't specify a value, Amazon RDS doesn't create a database in the DB cluster.
\nConstraints:
\nMust contain 1 to 64 alphanumeric characters.
\nCan't be a word reserved by the database engine.
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created.
\nDefault: postgres\n
Constraints:
\nMust contain 1 to 63 alphanumeric characters.
\nMust begin with a letter.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nCan't be a word reserved by the database engine.
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.
\nDefault: ORCL\n
Constraints:
\nMust contain 1 to 8 alphanumeric characters.
\nMust contain a letter.
\nCan't be a word reserved by the database engine.
\nNot applicable. Must be null.
\nThe 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.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the database engine.
\nThe 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.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the database engine.
\nThe Oracle System ID (SID) of the created DB instance.
\nDefault: ORCL\n
Constraints:
\nCan't be longer than 8 characters.
\nCan'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.
\nDefault: postgres\n
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the database engine.
\nNot applicable. Must be null.
\nThe DB instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The identifier for this DB instance. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nType: Integer
\n\n Amazon Aurora\n
\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\n\n Amazon RDS Custom\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\n\n MySQL\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n MariaDB\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n PostgreSQL\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n Oracle\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\n\n SQL Server\n
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3):
\nEnterprise and Standard editions: Must be an integer from 20 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 100 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 20 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nThis setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3):
\nEnterprise and Standard editions: Must be an integer from 20 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 100 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 20 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe 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#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.
The name of the database engine to be used for this instance.
\nNot every database engine is available for every Amazon Web Services Region.
\nValid Values:
\n\n aurora-mysql (for Aurora MySQL DB instances)
\n aurora-postgresql (for Aurora PostgreSQL DB instances)
\n custom-oracle-ee (for RDS Custom for Oracle DB instances)\n
\n custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)\n
\n custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)\n
\n custom-sqlserver-se (for RDS Custom for SQL Server DB instances)\n
\n custom-sqlserver-web (for RDS Custom for SQL Server DB instances)\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to use for this DB instance.
\nNot every database engine is available in every Amazon Web Services Region.
\nValid Values:
\n\n aurora-mysql (for Aurora MySQL DB instances)
\n aurora-postgresql (for Aurora PostgreSQL DB instances)
\n custom-oracle-ee (for RDS Custom for Oracle DB instances)
\n custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
\n custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name for the master user.
\n\n Amazon Aurora\n
\nNot applicable. The name for the master user is managed by the DB cluster.
\n\n Amazon RDS\n
\nConstraints:
\nRequired.
\nMust be 1 to 16 letters, numbers, or underscores.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe name for the master user.
\nThis setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.
\nThis setting is required for RDS DB instances.
\nConstraints:
\nMust be 1 to 16 letters, numbers, or underscores.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB\n cluster.
\nConstraints: Can't be specified if ManageMasterUserPassword is turned on.
\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
" + "smithy.api#documentation": "The password for the master user.
\nThis setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.
\nConstraints:
\nCan't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\nLength Constraints:
\nRDS for MariaDB - Must contain from 8 to 41 characters.
\nRDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
\nRDS for MySQL - Must contain from 8 to 41 characters.
\nRDS for Oracle - Must contain from 8 to 30 characters.
\nRDS for PostgreSQL - Must contain from 8 to 128 characters.
\nA list of Amazon EC2 VPC security groups to associate with this DB instance.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" + "smithy.api#documentation": "A list of Amazon EC2 VPC security groups to associate with this DB instance.
\nThis setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by\n the DB cluster.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.
\n\n Amazon Aurora\n
\nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.
\nFor Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nConstraints:
\nThe AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
\nExample: us-east-1d\n
A DB subnet group to associate with this DB instance.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mydbsubnetgroup\n
A DB subnet group to associate with this DB instance.
\nConstraints:
\nMust match the name of an existing DB subnet group.
\nMust not be default.
Example: mydbsubnetgroup\n
The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" + "smithy.api#documentation": "The time range each week during which system maintenance can occur. \n For more information, see Amazon RDS Maintenance Window \n in the Amazon RDS User Guide.\n
\nThe default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.
\nConstraints:
\nMust be in the format ddd:hh24:mi-ddd:hh24:mi.
The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred backup window.
\nMust be at least 30 minutes.
\nThe name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nIt must be 1 to 255 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nIt can't end with a hyphen or contain two consecutive hyphens.
\nThe name of the DB parameter group to associate with this DB instance. If you don't specify a value, then \n Amazon RDS uses the default DB parameter group for the specified DB engine and version.
\nThis setting doesn't apply to RDS Custom DB instances.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe 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
\nNot applicable. The retention period for automated backups is managed by the DB cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\nCan't be set to 0 for an RDS Custom for Oracle DB instance
\nThe 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.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.
\nDefault: 1\n
Constraints:
\nMust be a value from 0 to 35.
\nCan't be set to 0 if the DB instance is a source to read replicas.
\nCan't be set to 0 for an RDS Custom for Oracle DB instance.
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
\n Amazon Aurora\n
\nNot applicable. The daily time range for creating automated backups is managed by\n the DB cluster.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe port number on which the database accepts connections.
\n\n MySQL\n
\nDefault: 3306\n
Valid values: 1150-65535\n
Type: Integer
\n\n MariaDB\n
\nDefault: 3306\n
Valid values: 1150-65535\n
Type: Integer
\n\n PostgreSQL\n
\nDefault: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\nDefault: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\nDefault: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\nDefault: 3306\n
Valid values: 1150-65535\n
Type: Integer
" + "smithy.api#documentation": "The port number on which the database accepts connections.
\nThis setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
\nValid Values: 1150-65535\n
Default:
\nRDS for MariaDB - 3306\n
RDS for Microsoft SQL Server - 1433\n
RDS for MySQL - 3306\n
RDS for Oracle - 1521\n
RDS for PostgreSQL - 5432\n
Constraints:
\nFor RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.
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.
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
" + "smithy.api#documentation": "Specifies 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.
This setting doesn't apply to the following DB instances:
\nAmazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
\nRDS Custom
\nThe version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions\n operation.
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
\nNot 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
\nA 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. A valid CEV name 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 Amazon RDS Custom for SQL Server\n
\nSee RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.
\n\n MariaDB\n
\nFor information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Microsoft SQL Server\n
\nFor information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Oracle\n
\nFor information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.
\n\n PostgreSQL\n
\nFor 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.
\nThis setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB\n instance uses is managed by the DB cluster.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions\n operation.
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.
\nA 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. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.
\nFor information, see MariaDB on Amazon RDS versions in the \n Amazon RDS User Guide.
\nFor information, see Microsoft SQL Server versions on Amazon RDS in the \n Amazon RDS User Guide.
\nFor information, see MySQL on Amazon RDS versions in the \n Amazon RDS User Guide.
\nFor information, see Oracle Database Engine release notes in the \n Amazon RDS User Guide.
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.
\nA value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nIf you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.
Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nIf you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.
License model information for this DB instance.
\nValid values: license-included | bring-your-own-license | general-public-license\n
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" + "smithy.api#documentation": "The license model information for this DB instance.
\nThis setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
\nValid Values:
\nRDS for MariaDB - general-public-license\n
RDS for Microsoft SQL Server - license-included\n
RDS for MySQL - general-public-license\n
RDS for Oracle - bring-your-own-license | license-included\n
RDS for PostgreSQL - postgresql-license\n
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 \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.
\nConstraints: 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
\nNot applicable. Storage is managed by the DB cluster.
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
\nConstraints:
\nFor RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 \n of the storage amount for the DB instance.
\nFor RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
\nA value that indicates that the DB instance should be associated with the specified option group.
\nPermanent 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.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" + "smithy.api#documentation": "The option group to associate the DB instance with.
\nPermanent 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.
\nThis setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "For supported engines, this value indicates that the DB instance should be associated with the \n specified CharacterSet.
This setting doesn't apply to RDS Custom. However, if you need to change the character set, \n you can change it on the database itself.
\n\n Amazon Aurora\n
\nNot applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.
For supported engines, the character set (CharacterSet) to associate the DB instance with.
This setting doesn't apply to the following DB instances:
\nAmazon Aurora - The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.
RDS Custom - However, if you need to change the character set, \n you can change it on the database itself.
\nThe name of the NCHAR character set for the Oracle DB instance.
\nThis parameter doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The name of the NCHAR character set for the Oracle DB instance.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
\nSpecifies whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
\nThe identifier of the DB cluster that the instance will belong to.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The identifier of the DB cluster that this DB instance will belong to.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" + "smithy.api#documentation": "The storage type to associate with the DB instance.
\nIf you specify io1 or gp3, you must also include a value for the\n Iops parameter.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
\nValid Values: gp2 | gp3 | io1 | standard\n
Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.
The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
\nFor RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.
\n Amazon Aurora\n
\nNot applicable. The encryption for DB instances is managed by the DB cluster.
" + "smithy.api#documentation": "Specifes whether the DB instance is encrypted. By default, it isn't encrypted.
\nFor RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.
\nThis setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB instance.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\n\n Amazon Aurora\n
\nNot applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
\n Amazon RDS Custom\n
\nA KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.
The Amazon Web Services KMS key identifier for an encrypted DB instance.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nThis setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.
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.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The domain is managed by the DB cluster.
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL \n Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (The domain is managed by the DB cluster.)
\nRDS Custom
\nA value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.
" + "smithy.api#documentation": "Spcifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
\nThis setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom DB instances.
\nValid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n
Default: 0\n
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
" } }, "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.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The domain is managed by the DB cluster.
" + "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory Service.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (The domain is managed by the DB cluster.)
\nRDS Custom
\nA value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom.
\nDefault: 1
\nValid Values: 0 - 15
" + "smithy.api#documentation": "The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
\nDefault: 1\n
Valid Values: 0 - 15\n
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.
\nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)
\nRDS Custom
\nA value that indicates whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data.
\nThis setting doesn't apply to RDS Custom DB instances.
\nValid Values:
\n\n 7\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
\n 731\n
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\n\n Amazon Aurora\n
\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.
\n\n RDS Custom\n
\nNot applicable.
\n\n MariaDB\n
\nPossible values are audit, error, general, and slowquery.
\n Microsoft SQL Server\n
\nPossible values are agent and error.
\n MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Oracle\n
\nPossible values are alert, audit, listener, trace, and\n oemagent.
\n PostgreSQL\n
\nPossible values are postgresql and upgrade.
The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
\nRDS Custom
\nThe following values are valid for each DB engine:
\nRDS for MariaDB - audit | error | general | slowquery\n
RDS for Microsoft SQL Server - agent | error\n
RDS for MySQL - audit | error | general | slowquery\n
RDS for Oracle - alert | audit | listener | trace | oemagent\n
RDS for PostgreSQL - postgresql | upgrade\n
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
\n\n Amazon Aurora\n
\nNot applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.
Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
\nThis setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor 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.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor 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.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (Storage is managed by the DB cluster.)
\nRDS Custom
\nA value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance.
\nThis setting is required for RDS Custom.
\nConstraints:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
" } }, "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The location for storing automated backups and manual snapshots.
\nValie Values:
\n\n outposts (Amazon Web Services Outposts)
\n region (Amazon Web Services Region)
Default: region\n
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nThe network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
\nValid Values: IPV4 | DUAL\n
Specifies the storage throughput value for the DB instance.
\nThis setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "The storage throughput value for the DB instance.
\nThis setting applies only to the gp3 storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
" } }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
Specifies the CA certificate identifier to use for the DB instance’s server certificate.
\nThis setting doesn't apply to RDS Custom.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "The CA certificate identifier to use for the DB instance's server certificate.
\nThis setting doesn't apply to RDS Custom DB instances.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" } } }, @@ -5653,13 +5653,13 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
" + "smithy.api#documentation": "The list of Availability Zones (AZs) where instances in the DB cluster can be created.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the number of days for which automatic DB snapshots are retained.
" + "smithy.api#documentation": "The number of days for which automatic DB snapshots are retained.
" } }, "CharacterSetName": { @@ -5671,31 +5671,31 @@ "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "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.
" + "smithy.api#documentation": "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.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
" + "smithy.api#documentation": "The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
" } }, "DBClusterParameterGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the name of the DB cluster parameter group for the DB cluster.
" + "smithy.api#documentation": "The name of the DB cluster parameter group for the DB cluster.
" } }, "DBSubnetGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
" + "smithy.api#documentation": "Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the current state of this DB cluster.
" + "smithy.api#documentation": "The current state of this DB cluster.
" } }, "AutomaticRestartTime": { @@ -5707,7 +5707,7 @@ "PercentProgress": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the progress of the operation as a percentage.
" + "smithy.api#documentation": "The progress of the operation as a percentage.
" } }, "EarliestRestorableTime": { @@ -5719,7 +5719,7 @@ "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the connection endpoint for the primary instance of the DB cluster.
" + "smithy.api#documentation": "The connection endpoint for the primary instance of the DB cluster.
" } }, "ReaderEndpoint": { @@ -5731,67 +5731,67 @@ "CustomEndpoints": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "Identifies all custom endpoints associated with the cluster.
" + "smithy.api#documentation": "The custom endpoints associated with the DB cluster.
" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies whether the DB cluster has instances in multiple Availability Zones.
" + "smithy.api#documentation": "Indicates whether the DB cluster has instances in multiple Availability Zones.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the database engine to be used for this DB cluster.
" + "smithy.api#documentation": "The database engine used for this DB cluster.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Indicates the database engine version.
" + "smithy.api#documentation": "The version of the database engine.
" } }, "LatestRestorableTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "Specifies the latest time to which a database can be restored with point-in-time restore.
" + "smithy.api#documentation": "The latest time to which a database can be restored with point-in-time restore.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the port that the database engine is listening on.
" + "smithy.api#documentation": "The port that the database engine is listening on.
" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Contains the master username for the DB cluster.
" + "smithy.api#documentation": "The master username for the DB cluster.
" } }, "DBClusterOptionGroupMemberships": { "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", "traits": { - "smithy.api#documentation": "Provides the list of option group memberships for this DB cluster.
" + "smithy.api#documentation": "The list of option group memberships for this DB cluster.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.
The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
" } }, "ReplicationSourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Contains the identifier of the source DB cluster if this DB cluster is a read\n replica.
" + "smithy.api#documentation": "The identifier of the source DB cluster if this DB cluster is a read\n replica.
" } }, "ReadReplicaIdentifiers": { @@ -5803,26 +5803,26 @@ "DBClusterMembers": { "target": "com.amazonaws.rds#DBClusterMemberList", "traits": { - "smithy.api#documentation": "Provides the list of instances that make up the DB cluster.
" + "smithy.api#documentation": "The list of DB instances that make up the DB cluster.
" } }, "VpcSecurityGroups": { "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "Provides a list of VPC security groups that the DB cluster belongs to.
" + "smithy.api#documentation": "The list of VPC security groups that the DB cluster belongs to.
" } }, "HostedZoneId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
" + "smithy.api#documentation": "The ID that Amazon Route 53 assigns when you create a hosted zone.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether the DB cluster is encrypted.
" + "smithy.api#documentation": "Indicates whether the DB cluster is encrypted.
" } }, "KmsKeyId": { @@ -5846,25 +5846,25 @@ "AssociatedRoles": { "target": "com.amazonaws.rds#DBClusterRoles", "traits": { - "smithy.api#documentation": "Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.
" + "smithy.api#documentation": "A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.
" } }, "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" + "smithy.api#documentation": "Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" } }, "CloneGroupId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Identifies the clone group to which the DB cluster is associated.
" + "smithy.api#documentation": "The ID of the clone group with which the DB cluster is associated.
" } }, "ClusterCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
" + "smithy.api#documentation": "The time when the DB cluster was created, in Universal Coordinated Time (UTC).
" } }, "EarliestBacktrackTime": { @@ -5876,7 +5876,7 @@ "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.
" + "smithy.api#documentation": "The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.
\nFor more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.
" + "smithy.api#documentation": "The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.
" } }, "EngineMode": { @@ -5909,13 +5909,13 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Indicates if the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.
" + "smithy.api#documentation": "Indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.
" } }, "HttpEndpointEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
" + "smithy.api#documentation": "Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
" } }, "ActivityStreamMode": { @@ -5945,13 +5945,13 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
" + "smithy.api#documentation": "Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
" } }, "CrossAccountClone": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
" + "smithy.api#documentation": "Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
" } }, "DomainMemberships": { @@ -5966,19 +5966,19 @@ "GlobalWriteForwardingStatus": { "target": "com.amazonaws.rds#WriteForwardingStatus", "traits": { - "smithy.api#documentation": "Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.
" + "smithy.api#documentation": "The status of write forwarding for a secondary cluster in an Aurora global database.
" } }, "GlobalWriteForwardingRequested": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies whether you have requested to enable write forwarding for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.
Specifies whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. \n Specific changes are identified by subelements.
" + "smithy.api#documentation": "Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
" } }, "DBClusterInstanceClass": { @@ -6002,14 +6002,14 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies the accessibility options for the DB instance.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private \n IP address from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "Indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBCluster.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates that minor version patches are applied automatically.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "Indicates whether minor version patches are applied automatically.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "MonitoringInterval": { @@ -6027,7 +6027,7 @@ "PerformanceInsightsEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "True if Performance Insights is enabled for the DB cluster, and otherwise false.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "Indicates whether Performance Insights is enabled for the DB cluster.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "PerformanceInsightsKMSKeyId": { @@ -6039,7 +6039,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
\nValid Values:
\n\n 7\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
\n 731\n
Default: 7 days
The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nThis setting is only for Aurora DB clusters.
" + "smithy.api#documentation": "The network type of the DB instance.
\nThe network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nThis setting is only for Aurora DB clusters.
\nValid Values: IPV4 | DUAL\n
Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
" } }, "IOOptimizedNextAllowedModificationTime": { @@ -6428,7 +6428,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A pagination token that can be used in a later DescribeDBClusters request.
" + "smithy.api#documentation": "A pagination token that can be used in a later DescribeDBClusters request.
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
" + "smithy.api#documentation": "The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Contains the name of the compute and memory capacity class of the DB instance.
" + "smithy.api#documentation": "The name of the compute and memory capacity class of the DB instance.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the database engine to be used for this DB instance.
" + "smithy.api#documentation": "The database engine used for this DB instance.
" } }, "DBInstanceStatus": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the current state of this database.
\nFor information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The current state of this database.
\nFor information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n
" } }, "AutomaticRestartTime": { @@ -7230,45 +7230,45 @@ "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Contains the master username for the DB instance.
" + "smithy.api#documentation": "The master username for the DB instance.
" } }, "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The meaning of this parameter differs according to the database engine you use.
\n\n MySQL, MariaDB, SQL Server, PostgreSQL\n
\nContains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
\nType: String
\n\n Oracle\n
\nContains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
" + "smithy.api#documentation": "The meaning of this parameter differs depending on the database engine.
\nFor RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
\nFor RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
\nSpecifies the connection endpoint.
\nThe endpoint might not be shown for instances whose status is creating.
The connection endpoint for the DB instance.
\nThe endpoint might not be shown for instances with the status of creating.
Specifies the allocated storage size specified in gibibytes (GiB).
" + "smithy.api#documentation": "The amount of storage in gibibytes (GiB) allocated for the DB instance.
" } }, "InstanceCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "Provides the date and time the DB instance was created.
" + "smithy.api#documentation": "The date and time when the DB instance was created.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.
The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.
Specifies the number of days for which automatic DB snapshots are retained.
" + "smithy.api#documentation": "The number of days for which automatic DB snapshots are retained.
" } }, "DBSecurityGroups": { @@ -7280,81 +7280,81 @@ "VpcSecurityGroups": { "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "Provides a list of VPC security group elements that the DB instance belongs to.
" + "smithy.api#documentation": "The list of Amazon EC2 VPC security groups that the DB instance belongs to.
" } }, "DBParameterGroups": { "target": "com.amazonaws.rds#DBParameterGroupStatusList", "traits": { - "smithy.api#documentation": "Provides the list of DB parameter groups applied to this DB instance.
" + "smithy.api#documentation": "The list of DB parameter groups applied to this DB instance.
" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the name of the Availability Zone the DB instance is located in.
" + "smithy.api#documentation": "The name of the Availability Zone where the DB instance is located.
" } }, "DBSubnetGroup": { "target": "com.amazonaws.rds#DBSubnetGroup", "traits": { - "smithy.api#documentation": "Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
" + "smithy.api#documentation": "Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
" } }, "PendingModifiedValues": { "target": "com.amazonaws.rds#PendingModifiedValues", "traits": { - "smithy.api#documentation": "A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" + "smithy.api#documentation": "Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
" } }, "LatestRestorableTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "Specifies the latest time to which a database can be restored with point-in-time restore.
" + "smithy.api#documentation": "The latest time to which a database in this DB instance can be restored with point-in-time restore.
" } }, "MultiAZ": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Indicates the database engine version.
" + "smithy.api#documentation": "The version of the database engine.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates that minor version patches are applied automatically.
" + "smithy.api#documentation": "Indicates whether minor version patches are applied automatically.
" } }, "ReadReplicaSourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Contains the identifier of the source DB instance if this DB instance is a read\n replica.
" + "smithy.api#documentation": "The identifier of the source DB instance if this DB instance is a read\n replica.
" } }, "ReadReplicaDBInstanceIdentifiers": { "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", "traits": { - "smithy.api#documentation": "Contains one or more identifiers of the read replicas associated with this DB\n instance.
" + "smithy.api#documentation": "The identifiers of the read replicas associated with this DB\n instance.
" } }, "ReadReplicaDBClusterIdentifiers": { "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", "traits": { - "smithy.api#documentation": "Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.
\nCurrently, each RDS DB instance can have only one Aurora read replica.
\nThe identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.
\nCurrently, each RDS DB instance can have only one Aurora read replica.
\nLicense model information for this DB instance. This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the Provisioned IOPS (I/O operations per second) value.
" + "smithy.api#documentation": "The Provisioned IOPS (I/O operations per second) value for the DB instance.
" } }, "OptionGroupMemberships": { "target": "com.amazonaws.rds#OptionGroupMembershipList", "traits": { - "smithy.api#documentation": "Provides the list of option group memberships for this DB instance.
" + "smithy.api#documentation": "The list of option group memberships for this DB instance.
" } }, "CharacterSetName": { @@ -7403,19 +7403,19 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies the accessibility options for the DB instance.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "Indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "StatusInfos": { "target": "com.amazonaws.rds#DBInstanceStatusInfoList", "traits": { - "smithy.api#documentation": "The status of a read replica. If the instance isn't a read replica, this is\n blank.
" + "smithy.api#documentation": "The status of a read replica. If the DB instance isn't a read replica, the value is\n blank.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type associated with the DB instance.
" + "smithy.api#documentation": "The storage type associated with the DB instance.
" } }, "TdeCredentialArn": { @@ -7428,26 +7428,26 @@ "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
" + "smithy.api#documentation": "The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
" + "smithy.api#documentation": "If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether the DB instance is encrypted.
" + "smithy.api#documentation": "Indicates whether the DB instance is encrypted.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" + "smithy.api#documentation": "If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "DbiResourceId": { @@ -7472,7 +7472,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
\nThis setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
" } }, "DBInstanceArn": { @@ -7515,13 +7515,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
\nFor a list of engine versions that support IAM database authentication, see \n IAM database authentication\n in the Amazon RDS User Guide and IAM \n database authentication in Aurora in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
\nFor a list of engine versions that support IAM database authentication, see \n IAM database authentication\n in the Amazon RDS User Guide and IAM \n database authentication in Aurora in the Amazon Aurora User Guide.
" } }, "PerformanceInsightsEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "True if Performance Insights is enabled for the DB instance, and otherwise false.
" + "smithy.api#documentation": "Indicates whether Performance Insights is enabled for the DB instance.
" } }, "PerformanceInsightsKMSKeyId": { @@ -7533,13 +7533,13 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nThe number of days to retain Performance Insights data.
\nValid Values:
\n\n 7\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
\n 731\n
Default: 7 days
A list of log types that this DB instance is configured to export to CloudWatch Logs.
\nLog types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A list of log types that this DB instance is configured to export to CloudWatch Logs.
\nLog types vary by DB engine. For information about the log types for each DB engine, see\n Monitoring Amazon RDS log files in the Amazon RDS User Guide.\n
" } }, "ProcessorFeatures": { @@ -7552,7 +7552,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.
" + "smithy.api#documentation": "Indicates whether the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.
" } }, "AssociatedRoles": { @@ -7564,7 +7564,7 @@ "ListenerEndpoint": { "target": "com.amazonaws.rds#Endpoint", "traits": { - "smithy.api#documentation": "Specifies the listener connection endpoint for SQL Server Always On.
" + "smithy.api#documentation": "The listener connection endpoint for SQL Server Always On.
" } }, "MaxAllocatedStorage": { @@ -7585,7 +7585,7 @@ "CustomerOwnedIpEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "AwsBackupRecoveryPointArn": { @@ -7645,13 +7645,13 @@ "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
" + "smithy.api#documentation": "The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nThe network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid Values: IPV4 | DUAL\n
Specifies the storage throughput for the DB instance.
\nThis setting applies only to the gp3 storage type.
The storage throughput for the DB instance.
\nThis setting applies only to the gp3 storage type.
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also\n the name of the CDB. This setting is valid for RDS Custom only.
" + "smithy.api#documentation": "The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also\n the name of the CDB. This setting is only valid for RDS Custom DB instances.
" } }, "MasterUserSecret": { "target": "com.amazonaws.rds#MasterUserSecret", "traits": { - "smithy.api#documentation": "Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
" } }, "CertificateDetails": { @@ -7687,7 +7687,7 @@ "ReadReplicaSourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Contains the identifier of the source DB cluster if this DB instance is a read\n replica.
" + "smithy.api#documentation": "The identifier of the source DB cluster if this DB instance is a read\n replica.
" } } }, @@ -11149,7 +11149,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
", + "smithy.api#documentation": "Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11292,13 +11292,13 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing DBClusterIdentifier.
\nThe user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information for only the specific DB cluster is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing DB cluster identifier.
\nA filter that specifies one or more DB clusters to describe.
\nSupported filters:
\n\n clone-group-id - Accepts clone group identifiers. \n The results list only includes information about\n the DB clusters associated with these clone groups.
\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about\n the DB clusters identified by these ARNs.
\n db-cluster-resource-id - Accepts DB cluster resource identifiers.\n The results list will only include information about the DB clusters identified\n by these DB cluster resource identifiers.
\n domain - Accepts Active Directory directory IDs. \n The results list only includes information about\n the DB clusters associated with these domains.
\n engine - Accepts engine names. \n The results list only includes information about\n the DB clusters for these engines.
A filter that specifies one or more DB clusters to describe.
\nSupported Filters:
\n\n clone-group-id - Accepts clone group identifiers. \n The results list only includes information about\n the DB clusters associated with these clone groups.
\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about\n the DB clusters identified by these ARNs.
\n db-cluster-resource-id - Accepts DB cluster resource identifiers.\n The results list will only include information about the DB clusters identified\n by these DB cluster resource identifiers.
\n domain - Accepts Active Directory directory IDs. \n The results list only includes information about\n the DB clusters associated with these domains.
\n engine - Accepts engine names. \n The results list only includes information about\n the DB clusters for these engines.
Optional Boolean parameter that specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.
" + "smithy.api#documentation": "Specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.
" } } }, @@ -11490,7 +11490,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about provisioned RDS instances. This API supports pagination.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
\nDescribes provisioned RDS instances. This API supports pagination.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
\nThe user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBInstance.
\nThe user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match the identifier of an existing DB instance.
\nA filter that specifies one or more DB instances to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about \n the DB instances associated with the DB clusters identified by these ARNs.
\n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list only includes information about\n the DB instances identified by these ARNs.
\n dbi-resource-id - Accepts DB instance resource identifiers. The results list will \n only include information about the DB instances identified by these DB instance resource identifiers.
\n domain - Accepts Active Directory directory IDs. The results list only includes \n information about the DB instances associated with these domains.
\n engine - Accepts engine names. The results list only includes information \n about the DB instances for these engines.
A filter that specifies one or more DB instances to describe.
\nSupported Filters:
\n\n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about \n the DB instances associated with the DB clusters identified by these ARNs.
\n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list only includes information about\n the DB instances identified by these ARNs.
\n dbi-resource-id - Accepts DB instance resource identifiers. The results list \n only includes information about the DB instances identified by these DB instance resource identifiers.
\n domain - Accepts Active Directory directory IDs. The results list only includes \n information about the DB instances associated with these domains.
\n engine - Accepts engine names. The results list only includes information \n about the DB instances for these engines.
Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" + "smithy.api#documentation": "Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.
" } }, "com.amazonaws.rds#ModifyDBClusterEndpoint": { @@ -15868,208 +15868,208 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nConstraints: This identifier must match the identifier of an existing DB\n cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust match the identifier of an existing DB cluster.
\nThe new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster2\n
A value that indicates whether the modifications in this request and any pending modifications are \n asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting \n for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next \n maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some \n modifications, such as turning on deletion protection and changing the master password, are applied \n immediately—regardless of when you choose to apply them.
\nBy default, this parameter is disabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether the modifications in this request and any pending modifications are \n asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting \n for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next \n maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some \n modifications, such as turning on deletion protection and changing the master password, are applied \n immediately—regardless of when you choose to apply them.
\nBy default, this parameter is disabled.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which automated backups are retained. Specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The number of days for which automated backups are retained. Specify a minimum value of 1.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nDefault: 1\n
Constraints:
\nMust be a value from 1 to 35.
\nThe name of the DB cluster parameter group to use for the DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the DB cluster parameter group to use for the DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of VPC security groups that the DB cluster will belong to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the DB cluster accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB cluster.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The port number on which the DB cluster accepts connections.
\nValid for Cluster Type: Aurora DB clusters only
\nValid Values: 1150-65535\n
Default: The same port as the original DB cluster.
" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints:
\nMust contain from 8 to 41 characters.
\nCan't be specified if ManageMasterUserPassword is turned on.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The new password for the master database user.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust contain from 8 to 41 characters.
\nCan contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nCan't be specified if ManageMasterUserPassword is turned on.
A value that indicates that the DB cluster should be associated with the specified option group.
\nDB clusters are associated with a default option group that can't be modified.
" + "smithy.api#documentation": "The option group to associate the DB cluster with.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nThe default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
\nConstraints:
\nMust be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
\nMust be at least 30 minutes.
\nA 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.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies 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.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" + "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
\nDefault: 0\n
Constraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nThe following values are valid for each DB engine:
\nAurora MySQL - audit | error | general | slowquery\n
Aurora PostgreSQL - postgresql\n
RDS for MySQL - error | general | slowquery\n
RDS for PostgreSQL - postgresql | upgrade\n
For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to which you want to upgrade. Changing this\n parameter results in an outage. The change is applied during the next maintenance window\n unless ApplyImmediately is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must\n be running an engine version that's the same or later than the version you\n specify.
\nTo list all of the available engine versions for Aurora MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query\n \"DBEngineVersions[].EngineVersion\"\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
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The version number of the database engine to which you want to upgrade. Changing this\n parameter results in an outage. The change is applied during the next maintenance window\n unless ApplyImmediately is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must\n be running an engine version that's the same or later than the version you\n specify.
\nTo list all of the available engine versions for Aurora MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query\n \"DBEngineVersions[].EngineVersion\"\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
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies whether major version upgrades are allowed.
\nValid for Cluster Type: Aurora DB clusters only
\nConstraints:
\nYou must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
The name of the DB parameter group to apply to all instances of the DB cluster.
\nWhen you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.
Default: The existing name setting
\nConstraints:
\nThe DB parameter group must be in the same DB parameter group family as this DB cluster.
\nThe DBInstanceParameterGroupName parameter is valid in combination with the\n AllowMajorVersionUpgrade parameter for a major version upgrade only.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "The name of the DB parameter group to apply to all instances of the DB cluster.
\nWhen you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
\nDefault: The existing name setting
\nConstraints:
\nThe DB parameter group must be in the same DB parameter group family as this DB cluster.
\nThe DBInstanceParameterGroupName parameter is valid in combination with the\n AllowMajorVersionUpgrade parameter for a major version upgrade only.
The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.
For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.
For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "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.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory Service.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n 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 \n DB Instance Class in the Amazon RDS User Guide.
\nValid for Cluster Type: Multi-AZ DB clusters only
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nValid for Cluster Type: Multi-AZ DB clusters only
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nWhen 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
" + "smithy.api#documentation": "The storage type to associate with the DB cluster.
\nFor 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\n clusters, see Settings for creating Multi-AZ DB clusters.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values:
\nAurora DB clusters - aurora | aurora-iopt1\n
Multi-AZ DB clusters - io1\n
Default:
\nAurora DB clusters - aurora\n
Multi-AZ DB clusters - io1\n
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.
\nValid for Cluster Type: Multi-AZ DB clusters only
\nConstraints:
\nMust be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nA value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for Cluster Type: Multi-AZ DB clusters only
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid for Cluster Type: Multi-AZ DB clusters only
\nValid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n
Default: 0\n
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for Cluster Type: Multi-AZ DB clusters only
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for Cluster Type: Multi-AZ DB clusters only
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The number of days to retain Performance Insights data.
\nValid for Cluster Type: Multi-AZ DB clusters only
\nValid Values:
\n\n 7\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
\n 731\n
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
The network type of the DB cluster.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The network type of the DB cluster.
\nThe network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid for Cluster Type: Aurora DB clusters only
\nValid Values: IPV4 | DUAL\n
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
\nIf the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
\nIf the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "RotateMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.
\nThis setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
\nConstraints:
\nYou must apply the change immediately when rotating the master user password.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.
\nThis setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nYou must apply the change immediately when rotating the master user password.
\nThe Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.
\nThis setting is valid only if both of the following conditions are met:
\nThe DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
\nIf the DB cluster already manages the master user password in Amazon Web Services Secrets\n Manager, you can't change the KMS key that is used to encrypt the secret.
\nYou are turning on ManageMasterUserPassword to manage the master user password \n in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don't specify \n MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nThere is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.
\nThis setting is valid only if both of the following conditions are met:
\nThe DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
\nIf the DB cluster already manages the master user password in Amazon Web Services Secrets\n Manager, you can't change the KMS key that is used to encrypt the secret.
\nYou are turning on ManageMasterUserPassword to manage the master user password \n in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword and don't specify \n MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nThere is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned or serverless.
The DB engine mode can be modified only from serverless to provisioned.
For more information, see \n CreateDBCluster.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned or serverless.
The DB engine mode can be modified only from serverless to provisioned.
For more information, see \n CreateDBCluster.
\nValid for Cluster Type: Aurora DB clusters only
" } }, "AllowEngineModeChange": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether engine mode changes from serverless to provisioned \n are allowed.
Constraints: You must allow engine mode changes when specifying a different value for the EngineMode parameter\n from the DB cluster's current engine mode.
Valid for: Aurora Serverless v1 DB clusters only
" + "smithy.api#documentation": "Specifies whether engine mode changes from serverless to provisioned \n are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
\nConstraints:
\nYou must allow engine mode changes when specifying a different value for the EngineMode parameter\n from the DB cluster's current engine mode.
The DB instance identifier. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
\nThe identifier of DB instance to modify. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DB instance.
\nThe new amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nFor MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.
\nFor the valid values for allocated storage for each engine,\n see CreateDBInstance.
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nFor RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.
\nFor the valid values for allocated storage for each engine,\n see CreateDBInstance.
The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n 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 \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.
\nIf you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.
Default: Uses existing setting
" + "smithy.api#documentation": "The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n 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 \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.
Default: Uses existing setting
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.
\nChanging the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.
This parameter doesn't apply to RDS Custom.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.
\nChanging the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.
This parameter doesn't apply to RDS Custom DB instances.
\nConstraints:
\nIf supplied, must match existing DB subnet group.
\nExample: mydbsubnetgroup\n
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match existing DBSecurityGroups.
\nA list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom DB instances.
\nConstraints:
\nIf supplied, must match existing DB security groups.
\nA list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nIf supplied, must match existing VpcSecurityGroupIds.
\nA list of Amazon EC2 VPC security groups to associate with this DB instance. This change is \n asynchronously applied as soon as possible.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.)
RDS Custom
\nConstraints:
\nIf supplied, must match existing VPC security group IDs.
\nA value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.
The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".
\nChanging 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.
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints: Can't be specified if ManageMasterUserPassword is turned on.
\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
\nAmazon 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.
\nThe new password for the master user.
\nChanging 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.
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.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.)
RDS Custom
\nDefault: Uses existing setting
\nConstraints:
\nCan't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\nLength Constraints:
\nRDS for MariaDB - Must contain from 8 to 41 characters.
\nRDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
\nRDS for MySQL - Must contain from 8 to 41 characters.
\nRDS for Oracle - Must contain from 8 to 30 characters.
\nRDS for PostgreSQL - Must contain from 8 to 128 characters.
\nThe name of the DB parameter group to apply to the DB instance.
\nChanging this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Uses existing setting
\nConstraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
" + "smithy.api#documentation": "The name of the DB parameter group to apply to the DB instance.
\nChanging this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.
\nThis setting doesn't apply to RDS Custom DB instances.
\nDefault: Uses existing setting
\nConstraints:
\nMust be in the same DB parameter group family as the DB instance.
\nThe number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling 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.
\nThese 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 Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nIt must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
\nIt can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.
\nIt can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.
\nThe number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling 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.
\nThese 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.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nMust be a value from 0 to 35.
\nCan't be set to 0 if the DB instance is a source to \n read replicas.
\nCan't be set to 0 for an RDS Custom for Oracle DB instance.
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n
\n Amazon Aurora\n
\nNot applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nMust be in the format hh24:mi-hh24:mi
\nMust be in Universal Time Coordinated (UTC)
\nMust not conflict with the preferred maintenance window
\nMust be at least 30 minutes
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.
\nFor more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n
\nDefault: Uses existing setting
\nFormat: ddd:hh24:mi-ddd:hh24:mi
\nValid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
\nConstraints: Must be at least 30 minutes
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter causes a reboot\n of the DB instance. If you change this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.
\nFor more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n
\nDefault: Uses existing setting
\nConstraints:
\nMust be in the format ddd:hh24:mi-ddd:hh24:mi.
The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred backup window.
\nMust be at least 30 minutes.
\nA value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.
This setting doesn't apply to RDS Custom DB instances.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or later than the version that the source DB instance\n or cluster is running.
\nIn RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.
The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS updates the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or higher than the version that the source DB instance\n or cluster is running.
\nIn RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\nConstraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.
" + "smithy.api#documentation": "Specifies whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom DB instances.
\nConstraints:
\nMajor version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that's a different major version than the DB instance's current version.
A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:
\nThe automatic upgrade is enabled for the maintenance window.
\nA newer minor version is available.
\nRDS has enabled automatic patching for the engine version.
\nIf any of the preceding conditions isn't met, RDS applies the change as soon as possible and\n doesn't cause an outage.
\nFor an RDS Custom DB instance, set AutoMinorVersionUpgrade \n to false. Otherwise, the operation returns an error.
Specifies whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:
\nThe automatic upgrade is enabled for the maintenance window.
\nA newer minor version is available.
\nRDS has enabled automatic patching for the engine version.
\nIf any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and\n doesn't cause an outage.
\nFor an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The license model for the DB instance.
\nThis setting doesn't apply to RDS Custom.
\nValid values: license-included | bring-your-own-license | \n general-public-license\n
The license model for the DB instance.
\nThis setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
\nValid Values:
\nRDS for MariaDB - general-public-license\n
RDS for Microsoft SQL Server - license-included\n
RDS for MySQL - general-public-license\n
RDS for Oracle - bring-your-own-license | license-included\n
RDS for PostgreSQL - postgresql-license\n
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
\nChanging this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
\nDefault: Uses existing setting
" + "smithy.api#documentation": "The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
\nChanging this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nConstraints:
\nFor RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
\nDefault: Uses existing setting
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates the DB instance should be associated with the specified option group.
\nChanging this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.
\nThe change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The option group to associate the DB instance with.
\nChanging this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.
\nThe change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "NewDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The new identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable ApplyImmediately. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom DB instances.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
Specifies the storage type to be associated with the DB instance.
\nIf you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nValid values: gp2 | gp3 | io1 | standard\n
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The storage type to associate with the DB instance.
\nIf you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.
\nValid Values: gp2 | gp3 | io1 | standard\n
Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.
The ARN from the key store with which to associate the instance for TDE encryption.
\nThis 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.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the CA certificate identifier to use for the DB instance’s server certificate.
\nThis setting doesn't apply to RDS Custom.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "The CA certificate identifier to use for the DB instance6's server certificate.
\nThis setting doesn't apply to RDS Custom DB instances.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
\n\n Amazon Aurora\n
\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
\nThis setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected \n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
\nIf MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom DB instances.
\nValid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n
Default: 0\n
The port number on which the database accepts connections.
\nThe value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
\n\n MySQL\n
\nDefault: 3306\n
Valid values: 1150-65535\n
\n MariaDB\n
\nDefault: 3306\n
Valid values: 1150-65535\n
\n PostgreSQL\n
\nDefault: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\nDefault: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\nDefault: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\nDefault: 3306\n
Valid values: 1150-65535\n
The port number on which the database accepts connections.
\nThe value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom DB instances.
\nValid Values: 1150-65535\n
Default:
\nAmazon Aurora - 3306\n
RDS for MariaDB - 3306\n
RDS for Microsoft SQL Server - 1433\n
RDS for MySQL - 3306\n
RDS for Oracle - 1521\n
RDS for PostgreSQL - 5432\n
Constraints:
\nFor RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
Specifies whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.
This setting doesn't apply to RDS Custom DB instances.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom.
\nDefault: 1
\nValid Values: 0 - 15
" + "smithy.api#documentation": "The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
\nDefault: 1\n
Valid Values: 0 - 15\n
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.
\nThis setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data.
\nThis setting doesn't apply to RDS Custom DB instances.
\nValid Values:
\n\n 7\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
\n 731\n
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.
\nA change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.
\nA change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom DB instances.
" } }, "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.
\nThis 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.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" + "smithy.api#documentation": "Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" } }, "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.
\nFor 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.
\nThis 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.
\nFor 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.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "CertificateRotationRestart": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.
\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.
\nSet this parameter only if you are not using SSL/TLS to connect to the DB instance.
\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:
\nFor more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.\n
\nFor more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.
\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.
\nSet this parameter only if you are not using SSL/TLS to connect to the DB instance.
\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:
\nFor more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.\n
\nFor more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "A value that sets the open mode of a replica database to either mounted or read-only.
\nCurrently, this parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that sets the open mode of a replica database to either mounted or read-only.
\nCurrently, this parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "AutomationMode": { "target": "com.amazonaws.rds#AutomationMode", "traits": { - "smithy.api#documentation": "The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.
The automation mode of the RDS Custom DB instance. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation. The minimum value is 60 (default). The maximum value is 1,440.
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation.
\nDefault: 60\n
Constraints:
\nMust be at least 60.
\nMust be no more than 1,440.
\nThe network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nThe network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
\nValid Values: IPV4 | DUAL\n
Specifies the storage throughput value for the DB instance.
\nThis setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "The storage throughput value for the DB instance.
\nThis setting applies only to the gp3 storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
" } }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
\nIf the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
\nIf the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.
For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.
\nThis setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
\nConstraints:
\nYou must apply the change immediately when rotating the master user password.
\nSpecifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.
\nThis setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
\nConstraints:
\nYou must apply the change immediately when rotating the master user password.
\nThe engine version to upgrade the DB snapshot to.
\nThe following are the database engines and engine versions that are available when you upgrade a DB snapshot.
\n\n MySQL\n
\n\n 5.5.46 (supported for 5.1 DB snapshots)
\n Oracle\n
\n\n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
\n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
\n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
\n PostgreSQL\n
\nFor the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.
" + "smithy.api#documentation": "The engine version to upgrade the DB snapshot to.
\nThe following are the database engines and engine versions that are available when you upgrade a DB snapshot.
\n\n MySQL\n
\n\n 5.5.46 (supported for 5.1 DB snapshots)
\n Oracle\n
\n\n 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB\n snapshots)
\n 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB\n snapshots)
\n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
\n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
\n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
\n PostgreSQL\n
\nFor the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.
" } }, "OptionGroupName": { @@ -21864,7 +21864,7 @@ } }, "traits": { - "smithy.api#documentation": "Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.
" + "smithy.api#documentation": "The scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { @@ -21904,7 +21904,7 @@ } }, "traits": { - "smithy.api#documentation": "Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
\nFor more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.
" + "smithy.api#documentation": "The scaling configuration for an Aurora Serverless v2 DB cluster.
\nFor more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": {