Amazon Aurora doesn't support this operation. Call the CreateDBInstance
- * operation to create a DB instance for an Aurora DB cluster.
Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance
+ * operation.
All read replica DB instances are created with backups disabled. All other attributes * (including DB security groups and DB parameter groups) are inherited from the source DB * instance or cluster, except as specified.
diff --git a/clients/client-rds/src/commands/DeleteDBInstanceCommand.ts b/clients/client-rds/src/commands/DeleteDBInstanceCommand.ts index c06d320f6c5f..d654d2516ba7 100644 --- a/clients/client-rds/src/commands/DeleteDBInstanceCommand.ts +++ b/clients/client-rds/src/commands/DeleteDBInstanceCommand.ts @@ -37,12 +37,11 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _ /** * @public - *The DeleteDBInstance action deletes a previously provisioned DB instance. + *
Deletes a previously provisioned DB instance.
* When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered.
- * Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot
- * the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance
- * is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created.
+ * This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.
When a DB instance is in a failure state and has a status of failed, incompatible-restore,
* or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following @@ -55,11 +54,12 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _ *
The DB instance is the only instance in the DB cluster.
* * - *To delete a DB instance in this case, first call the
- * PromoteReadReplicaDBCluster API action to promote the DB cluster so
- * it's no longer a read replica. After the promotion completes, then call the
- * DeleteDBInstance API action to delete the final instance in the DB
- * cluster.
To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it's no longer a read replica.
+ * After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete + * these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
+ *Returns a list of the available DB engines.
+ *Describes the properties of specific versions of DB engines.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/models/models_0.ts b/clients/client-rds/src/models/models_0.ts index 2084eac1e39e..cdc9844d186f 100644 --- a/clients/client-rds/src/models/models_0.ts +++ b/clients/client-rds/src/models/models_0.ts @@ -711,7 +711,7 @@ export interface ApplyPendingMaintenanceActionMessage { /** * @public *The pending maintenance action to apply to this resource.
- *Valid values: system-update, db-upgrade,
+ *
Valid Values: system-update, db-upgrade,
* hardware-maintenance, ca-certificate-rotation
*
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in
* request of type immediate can't be undone.
Valid values:
+ *Valid Values:
*@@ -986,13 +986,13 @@ export interface EC2SecurityGroup { export interface IPRange { /** * @public - *
Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
+ *The status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
*/ Status?: string; /** * @public - *Specifies the IP range.
+ *The IP range.
*/ CIDRIP?: string; } @@ -1153,14 +1153,14 @@ export interface BacktrackDBClusterMessage { /** * @public - *A value that indicates whether to force the DB cluster to backtrack when binary logging is + *
Specifies whether to force the DB cluster to backtrack when binary logging is * enabled. Otherwise, an error occurs when binary logging is enabled.
*/ Force?: boolean; /** * @public - *A value that indicates whether to backtrack the DB cluster to the earliest possible + *
Specifies whether to backtrack the DB cluster to the earliest possible * backtrack time when BacktrackTo is set to a timestamp earlier than the earliest * backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest * backtrack time, an error occurs.
@@ -1257,7 +1257,7 @@ export type ExportSourceType = (typeof ExportSourceType)[keyof typeof ExportSour /** * @public *Contains the details of a snapshot or cluster export to Amazon S3.
- *This data type is used as a response element in the DescribeExportTasks action.
This data type is used as a response element in the DescribeExportTasks operation.
The data exported from the snapshot or cluster. Valid values are the following:
+ *The data exported from the snapshot or cluster.
+ *Valid Values:
*@@ -1305,25 +1306,25 @@ export interface ExportTask { /** * @public - *
The time that the snapshot was created.
+ *The time when the snapshot was created.
*/ SnapshotTime?: Date; /** * @public - *The time that the snapshot or cluster export task started.
+ *The time when the snapshot or cluster export task started.
*/ TaskStartTime?: Date; /** * @public - *The time that the snapshot or cluster export task ended.
+ *The time when the snapshot or cluster export task ended.
*/ TaskEndTime?: Date; /** * @public - *The Amazon S3 bucket that the snapshot or cluster is exported to.
+ *The Amazon S3 bucket where the snapshot or cluster is exported to.
*/ S3Bucket?: string; @@ -1740,7 +1741,7 @@ export interface CopyDBClusterSnapshotMessage { /** * @public - *A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. + *
Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. * By default, tags are not copied.
*/ CopyTags?: boolean; @@ -1763,49 +1764,49 @@ export interface CopyDBClusterSnapshotMessage { export interface DBClusterSnapshot { /** * @public - *Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
+ *The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
*/ AvailabilityZones?: string[]; /** * @public - *Specifies the identifier for the DB cluster snapshot.
+ *The identifier for the DB cluster snapshot.
*/ DBClusterSnapshotIdentifier?: string; /** * @public - *Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
+ *The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
*/ DBClusterIdentifier?: string; /** * @public - *Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
+ *The time when the snapshot was taken, in Universal Coordinated Time (UTC).
*/ SnapshotCreateTime?: Date; /** * @public - *Specifies the name of the database engine for this DB cluster snapshot.
+ *The name of the database engine for this DB cluster snapshot.
*/ Engine?: string; /** * @public - *Provides the engine mode of the database engine for this DB cluster snapshot.
+ *The engine mode of the database engine for this DB cluster snapshot.
*/ EngineMode?: string; /** * @public - *Specifies the allocated storage size in gibibytes (GiB).
+ *The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
*/ AllocatedStorage?: number; /** * @public - *Specifies the status of this DB cluster snapshot. Valid statuses are the following:
+ *The status of this DB cluster snapshot. Valid statuses are the following:
*@@ -1828,55 +1829,55 @@ export interface DBClusterSnapshot { /** * @public - *
Specifies the port that the DB cluster was listening on at the time of the snapshot.
+ *The port that the DB cluster was listening on at the time of the snapshot.
*/ Port?: number; /** * @public - *Provides the VPC ID associated with the DB cluster snapshot.
+ *The VPC ID associated with the DB cluster snapshot.
*/ VpcId?: string; /** * @public - *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; /** * @public - *Provides the master username for this DB cluster snapshot.
+ *The master username for this DB cluster snapshot.
*/ MasterUsername?: string; /** * @public - *Provides the version of the database engine for this DB cluster snapshot.
+ *The version of the database engine for this DB cluster snapshot.
*/ EngineVersion?: string; /** * @public - *Provides the license model information for this DB cluster snapshot.
+ *The license model information for this DB cluster snapshot.
*/ LicenseModel?: string; /** * @public - *Provides the type of the DB cluster snapshot.
+ *The type of the DB cluster snapshot.
*/ SnapshotType?: string; /** * @public - *Specifies the percentage of the estimated data that has been transferred.
+ *The percentage of the estimated data that has been transferred.
*/ PercentProgress?: number; /** * @public - *Specifies whether the DB cluster snapshot is encrypted.
+ *Indicates whether the DB cluster snapshot is encrypted.
*/ StorageEncrypted?: boolean; @@ -1889,7 +1890,7 @@ export interface DBClusterSnapshot { /** * @public - *Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot.
+ *The Amazon Resource Name (ARN) for the DB cluster snapshot.
*/ DBClusterSnapshotArn?: string; @@ -1902,7 +1903,7 @@ export interface DBClusterSnapshot { /** * @public - *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.
*/ IAMDatabaseAuthenticationEnabled?: boolean; @@ -1929,7 +1930,7 @@ export interface DBClusterSnapshot { /** * @public - *Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from.
+ *The resource ID of the DB cluster that this DB cluster snapshot was created from.
*/ DbClusterResourceId?: string; } @@ -2233,7 +2234,7 @@ export interface CopyDBSnapshotMessage { /** * @public - *A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. + *
Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. * By default, tags aren't copied.
*/ CopyTags?: boolean; @@ -2317,7 +2318,7 @@ export interface CopyDBSnapshotMessage { /** * @public - *A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target + *
Specifies whether to copy the DB option group associated with the source DB snapshot to the target * Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with * cross-account snapshot copy calls.
*/ @@ -2548,7 +2549,7 @@ export interface DBSnapshot { /** * @public - *Specifies whether the DB snapshot is encrypted.
+ *Indicates whether the DB snapshot is encrypted.
*/ Encrypted?: boolean; @@ -2579,7 +2580,7 @@ export interface DBSnapshot { /** * @public - *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.
*/ IAMDatabaseAuthenticationEnabled?: boolean; @@ -2861,13 +2862,13 @@ export interface OptionSetting { /** * @public - *A Boolean value that, when true, indicates the option setting can be modified from the default.
+ *Indicates whether the option setting can be modified from the default.
*/ IsModifiable?: boolean; /** * @public - *Indicates if the option setting is part of a collection.
+ *Indicates whether the option setting is part of a collection.
*/ IsCollection?: boolean; } @@ -2893,7 +2894,7 @@ export interface VpcSecurityGroupMembership { /** * @public - *Option details.
+ *The details of an option.
*/ export interface Option { /** @@ -2910,13 +2911,13 @@ export interface Option { /** * @public - *Indicate if this option is persistent.
+ *Indicates whether this option is persistent.
*/ Persistent?: boolean; /** * @public - *Indicate if this option is permanent.
+ *Indicates whether this option is permanent.
*/ Permanent?: boolean; @@ -3774,13 +3775,13 @@ export interface UpgradeTarget { /** * @public - *A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.
+ *Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
*/ IsMajorVersionUpgrade?: boolean; @@ -3792,25 +3793,25 @@ export interface UpgradeTarget { /** * @public - *A value that indicates whether you can use Aurora parallel query with the target engine version.
+ *Indicates whether you can use Aurora parallel query with the target engine version.
*/ SupportsParallelQuery?: boolean; /** * @public - *A value that indicates whether you can use Aurora global databases with the target engine version.
+ *Indicates whether you can use Aurora global databases with the target engine version.
*/ SupportsGlobalDatabases?: boolean; /** * @public - *A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
+ *Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
*/ SupportsBabelfish?: boolean; /** * @public - *A value that indicates whether the target engine version supports forwarding write operations from reader DB instances + *
Indicates whether the target engine version supports forwarding write operations from reader DB instances * to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
*Valid for: Aurora DB clusters only
*/ @@ -3905,7 +3906,7 @@ export interface DBEngineVersion { /** * @public - *A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
+ *Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
*/ SupportsLogExportsToCloudwatchLogs?: boolean; @@ -3947,13 +3948,13 @@ export interface DBEngineVersion { /** * @public - *A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
+ *Indicates whether you can use Aurora parallel query with a specific DB engine version.
*/ SupportsParallelQuery?: boolean; /** * @public - *A value that indicates whether you can use Aurora global databases with a specific DB engine version.
+ *Indicates whether you can use Aurora global databases with a specific DB engine version.
*/ SupportsGlobalDatabases?: boolean; @@ -4005,7 +4006,7 @@ export interface DBEngineVersion { /** * @public - *A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
+ *Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
*/ SupportsBabelfish?: boolean; @@ -4021,7 +4022,7 @@ export interface DBEngineVersion { /** * @public - *A value that indicates whether the engine version supports rotating the server certificate without + *
Indicates whether the engine version supports rotating the server certificate without * rebooting the DB instance.
*/ SupportsCertificateRotationWithoutRestart?: boolean; @@ -4039,7 +4040,7 @@ export interface DBEngineVersion { /** * @public - *A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances + *
Indicates whether the DB engine version supports forwarding write operations from reader DB instances * to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
*Valid for: Aurora DB clusters only
*/ @@ -4093,7 +4094,7 @@ export interface ScalingConfiguration { /** * @public - *A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
+ *
Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
* A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. @@ -5007,7 +5008,7 @@ export interface DBClusterMember { /** * @public - *
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Indicates whether the cluster member is the primary DB instance for the DB cluster.
*/ IsClusterWriter?: boolean; @@ -5225,7 +5226,7 @@ export interface ClusterPendingModifiedValues { /** * @public - *A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
+ *Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
*/ IAMDatabaseAuthenticationEnabled?: boolean; @@ -5283,7 +5284,7 @@ export interface ScalingConfigurationInfo { /** * @public - *A value that indicates whether automatic pause is allowed for the Aurora DB cluster + *
Indicates whether automatic pause is allowed for the Aurora DB cluster
* in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
*/ @@ -5735,7 +5736,7 @@ export interface DBCluster { /** * @public - *Specifies whether write forwarding is enabled for a secondary cluster + *
Indicates 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.
Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process + *
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process * of enabling it.
*/ LocalWriteForwardingStatus?: LocalWriteForwardingStatus | string; @@ -6986,7 +6987,7 @@ export interface CreateDBInstanceMessage { *Can't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@".
+ *Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
*Length Constraints:
@@ -7886,7 +7887,7 @@ export interface CreateDBInstanceMessage { /** * @public - *Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
+ *Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
*/ export interface DBInstanceRole { /** @@ -7905,7 +7906,7 @@ export interface DBInstanceRole { /** * @public - *Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following + *
Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following * values:
*A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
+ *Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
*/ MultiAZ?: boolean; @@ -8337,7 +8338,7 @@ export interface PendingModifiedValues { /** * @public - *Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
+ *Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
*/ IAMDatabaseAuthenticationEnabled?: boolean; @@ -8397,13 +8398,13 @@ export interface DBInstanceStatusInfo { /** * @public - *Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
+ *A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
*/ Normal?: boolean; /** * @public - *Status of the DB instance. For a StatusType of read replica, the values can be + *
The status of the DB instance. For a StatusType of read replica, the values can be * replicating, replication stop point set, replication stop point reached, error, stopped, * or terminated.
*/ @@ -9226,9 +9227,8 @@ export interface CreateDBInstanceReadReplicaMessage { *The compute and memory capacity of the read replica, for example * 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.
- *Default: Inherits from the source DB instance.
+ * availability for your engine, see DB Instance Class in the Amazon RDS User Guide. + *Default: Inherits the value from the source DB instance.
*/ DBInstanceClass?: string; @@ -9244,68 +9244,67 @@ export interface CreateDBInstanceReadReplicaMessage { /** * @public *The port number that the DB instance uses for connections.
- *Default: Inherits from the source DB instance
*Valid Values: 1150-65535
*
Default: Inherits the value from the source DB instance.
*/ Port?: number; /** * @public - *A value that indicates whether the read replica is in a Multi-AZ deployment.
+ *Specifies whether the read replica is in a Multi-AZ deployment.
*You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your * replica in another Availability Zone for failover support for the replica. Creating your * read replica as a Multi-AZ DB instance is independent of whether the source is a * Multi-AZ DB instance or a Multi-AZ DB cluster.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ MultiAZ?: boolean; /** * @public - *A value that indicates whether minor engine upgrades are applied automatically to the + *
Specifies whether to automatically apply minor engine upgrades to the * read replica during the maintenance window.
- *This setting doesn't apply to RDS Custom.
- *Default: Inherits from the source DB instance
+ *This setting doesn't apply to RDS Custom DB instances.
+ *Default: Inherits the value from the source DB instance.
*/ AutoMinorVersionUpgrade?: boolean; /** * @public - *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.
*/ Iops?: number; /** * @public - *The option group the DB instance is associated with. If omitted, the option group - * associated with the source instance or cluster is used.
+ *The option group to associate the DB instance with. If not specified, RDS uses the option group + * associated with the source DB instance or cluster.
*For SQL Server, you must use the option group associated with the source.
*This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ OptionGroupName?: string; /** * @public *The name of the DB parameter group to associate with this DB instance.
- *If you do not specify a value for DBParameterGroupName, then Amazon RDS
- * uses the DBParameterGroup of source DB instance for a same Region read
+ *
If you don't specify a value for DBParameterGroupName, then Amazon RDS
+ * uses the DBParameterGroup of the source DB instance for a same Region read
* replica, or the default DBParameterGroup for the specified DB engine for a
* cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. - * It isn't supported for RDS Custom.
+ *Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or for RDS Custom.
*Constraints:
*Must be 1 to 255 letters, numbers, or hyphens.
*First character must be a letter
+ *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.
*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 @@ -9335,18 +9334,18 @@ export interface CreateDBInstanceReadReplicaMessage { /** * @public - *
Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
+ *A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
*Constraints:
*If supplied, must match the name of an existing DBSubnetGroup.
+ *If supplied, must match the name of an existing DB subnet group.
*The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
*All read replicas in one Amazon Web Services Region that are created from the same source DB - * instance must either:>
+ * instance must either: *Specify DB subnet groups from the same VPC. All these read replicas are created in the same @@ -9367,41 +9366,42 @@ export interface CreateDBInstanceReadReplicaMessage { /** * @public *
A list of Amazon EC2 VPC security groups to associate with the read replica.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*Default: The default EC2 VPC security group for the DB subnet group's VPC.
*/ VpcSecurityGroupIds?: string[]; /** * @public - *Specifies the storage type to be associated with the read replica.
- *Valid values: gp2 | gp3 | io1 | standard
- *
The storage type to associate with the read replica.
*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
+ *
Valid Values: gp2 | gp3 | io1 | standard
*
Default: io1 if the Iops parameter
+ * is specified. Otherwise, gp2.
A value that indicates whether to copy all tags from the read replica to snapshots of - * the read replica. By default, tags are not copied.
+ *Specifies whether to copy all tags from the read replica to snapshots of + * the read replica. By default, tags aren't copied.
*/ CopyTagsToSnapshot?: boolean; /** * @public *The interval, in seconds, between points when Enhanced Monitoring metrics are - * collected for the read replica. To disable collecting Enhanced Monitoring metrics, - * specify 0. The default is 0.
- *If MonitoringRoleArn is specified, then you must also set MonitoringInterval
- * to a value other than 0.
This setting doesn't apply to RDS Custom.
+ * collected for the read replica. To disable collection of Enhanced Monitoring metrics, + * specify0. The default is 0.
+ * If MonitoringRoleArn is specified, then you must 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 MonitoringInterval is set to a value other than 0, then you must
* supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ MonitoringRoleArn?: string; @@ -9501,27 +9501,27 @@ export interface CreateDBInstanceReadReplicaMessage { *SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server
* doesn't support cross-Region read replicas.
*
- * This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ PreSignedUrl?: string; /** * @public - *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 about IAM database authentication, see * * IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
- *This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ EnableIAMDatabaseAuthentication?: boolean; /** * @public - *A value that indicates whether to enable Performance Insights for the read replica.
+ *Specifies whether to enable Performance Insights for the read replica.
*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; @@ -9532,42 +9532,34 @@ export interface CreateDBInstanceReadReplicaMessage { *If you do not 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; /** * @public - *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.
This setting doesn't apply to RDS Custom.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ EnableCloudwatchLogsExports?: string[]; /** * @public *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[]; /** * @public - *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; /** * @public - *A value that indicates whether the DB instance has deletion protection enabled. + *
Specifies whether to enable deletion protection for the DB instance. * The database can't be deleted when deletion protection is enabled. By default, * deletion protection isn't enabled. For more information, see * @@ -9612,15 +9604,15 @@ export interface CreateDBInstanceReadReplicaMessage { * Server, 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.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ Domain?: string; /** * @public - *The name of the IAM role to be used when making API calls to the Directory + *
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; @@ -9723,14 +9715,14 @@ export interface CreateDBInstanceReadReplicaMessage { *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.
+ *This setting is required for RDS Custom DB instances.
*/ CustomIamInstanceProfile?: string; /** * @public *The network type of the DB instance.
- *Valid values:
+ *Valid Values:
*@@ -9756,13 +9748,13 @@ export interface CreateDBInstanceReadReplicaMessage { /** * @public *
Specifies the storage throughput value for the read replica.
- *This setting doesn't apply to RDS Custom or Amazon Aurora.
+ *This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.
*/ StorageThroughput?: number; /** * @public - *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 read replica.
*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 @@ -10082,7 +10074,7 @@ export interface UserAuthConfig { /** * @public - *
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. + *
A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
* The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. + *
Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. * By enabling this setting, you can enforce encrypted TLS connections to the proxy.
*/ RequireTLS?: boolean; @@ -10169,7 +10161,7 @@ export interface CreateDBProxyRequest { /** * @public - *Whether the proxy includes detailed information about SQL statements in its logs. + *
Specifies whether the proxy includes detailed information about SQL statements in its logs. * This information helps you to debug issues involving SQL behavior or the performance * and scalability of the proxy connections. The debug information includes the text of * SQL statements that you submit through the proxy. Thus, only enable this setting @@ -10341,7 +10333,7 @@ export interface DBProxy { /** * @public - *
Whether the proxy includes detailed information about SQL statements in its logs. + *
Indicates whether the proxy includes detailed information about SQL statements in its logs. * This information helps you to debug issues involving SQL behavior or the performance * and scalability of the proxy connections. The debug information includes the text of * SQL statements that you submit through the proxy. Thus, only enable this setting @@ -10461,8 +10453,8 @@ export interface CreateDBProxyEndpointRequest { /** * @public - *
A value that indicates whether the DB proxy endpoint can be used for read/write
- * or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server
+ *
The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write
+ * or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server
* support is READ_WRITE.
A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. + *
Indicates whether this endpoint is the default endpoint for the associated DB proxy. * Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the * DB proxy can be either read/write or read-only.
*/ @@ -10972,7 +10964,7 @@ export interface CreateEventSubscriptionMessage { * notified of events generated by a DB instance, you set this parameter to *db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are
* returned.
- * Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
+ *
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
*
A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
+ *Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
*/ Enabled?: boolean; @@ -11369,7 +11361,7 @@ export interface GlobalClusterMember { /** * @public - *Specifies whether the Aurora DB cluster is the primary cluster + *
Indicates whether the Aurora DB cluster is the primary cluster * (that is, has read-write capability) for the global * cluster with which it is associated.
*/ @@ -11377,8 +11369,7 @@ export interface GlobalClusterMember { /** * @public - *Specifies whether a secondary cluster in the global cluster has - * write forwarding enabled, not enabled, or is in the process of enabling it.
+ *The status of write forwarding for a secondary cluster in the global cluster.
*/ GlobalWriteForwardingStatus?: WriteForwardingStatus | string; @@ -11797,7 +11788,7 @@ export interface DeleteDBClusterMessage { /** * @public - *A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. + *
Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. * If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot * is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. * By default, this parameter is disabled.
@@ -11832,7 +11823,7 @@ export interface DeleteDBClusterMessage { /** * @public - *A value that indicates whether to remove automated backups immediately after the DB + *
Specifies whether to remove automated backups immediately after the DB * cluster is deleted. This parameter isn't case-sensitive. The default is to remove * automated backups immediately after the DB cluster is deleted.
*/ @@ -11990,8 +11981,7 @@ export interface DBClusterAutomatedBackup { /** * @public - *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.
*/ IAMDatabaseAuthenticationEnabled?: boolean; @@ -12003,7 +11993,7 @@ export interface DBClusterAutomatedBackup { /** * @public - *Specifies whether the source DB cluster is encrypted.
+ *Indicates whether the source DB cluster is encrypted.
*/ StorageEncrypted?: boolean; @@ -12282,7 +12272,7 @@ export interface DeleteDBInstanceMessage { /** * @public - *A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. + *
Specifies whether to skip the creation of a final DB snapshot before deleting the instance. * If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, * RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, * and the DB snapshot is created.
@@ -12324,7 +12314,7 @@ export interface DeleteDBInstanceMessage { /** * @public - *A value that indicates whether to remove automated backups immediately after the DB + *
Specifies whether to remove automated backups immediately after the DB * instance is deleted. This parameter isn't case-sensitive. The default is to remove * automated backups immediately after the DB instance is deleted.
*/ @@ -12419,19 +12409,19 @@ export interface DBInstanceAutomatedBackup { /** * @public - *Earliest and latest time an instance can be restored to.
+ *The earliest and latest time a DB instance can be restored to.
*/ RestoreWindow?: RestoreWindow; /** * @public - *Specifies the allocated storage size in gibibytes (GiB).
+ *The allocated storage size for the the automated backup in gibibytes (GiB).
*/ AllocatedStorage?: number; /** * @public - *Provides a list of status information for an automated backup:
+ *A list of status information for an automated backup:
*@@ -12469,13 +12459,13 @@ export interface DBInstanceAutomatedBackup { /** * @public - *
Provides the VPC ID associated with the DB instance.
+ *The VPC ID associated with the DB instance.
*/ VpcId?: string; /** * @public - *Provides the date and time that the DB instance was created.
+ *The date and time when the DB instance was created.
*/ InstanceCreateTime?: Date; @@ -12499,7 +12489,7 @@ export interface DBInstanceAutomatedBackup { /** * @public - *License model information for the automated backup.
+ *The license model information for the automated backup.
*/ LicenseModel?: string; @@ -12523,13 +12513,13 @@ export interface DBInstanceAutomatedBackup { /** * @public - *Specifies whether the automated backup is encrypted.
+ *Indicates whether the automated backup is encrypted.
*/ Encrypted?: boolean; /** * @public - *Specifies the storage type associated with the automated backup.
+ *The storage type associated with the automated backup.
*/ StorageType?: string; @@ -12575,13 +12565,13 @@ export interface DBInstanceAutomatedBackup { /** * @public - *Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
+ *The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
*/ BackupTarget?: string; /** * @public - *Specifies the storage throughput for the automated backup.
+ *The storage throughput for the automated backup.
*/ StorageThroughput?: number; @@ -13185,7 +13175,7 @@ export interface Certificate { /** * @public - *Whether there is an override for the default certificate identifier.
+ *Indicates whether there is an override for the default certificate identifier.
*/ CustomerOverride?: boolean; @@ -13661,13 +13651,13 @@ export type ApplyMethod = (typeof ApplyMethod)[keyof typeof ApplyMethod]; export interface Parameter { /** * @public - *Specifies the name of the parameter.
+ *The name of the parameter.
*/ ParameterName?: string; /** * @public - *Specifies the value of the parameter.
+ *The value of the parameter.
*/ ParameterValue?: string; @@ -13679,7 +13669,7 @@ export interface Parameter { /** * @public - *Indicates the source of the parameter value.
+ *The source of the parameter value.
*/ Source?: string; @@ -13769,9 +13759,25 @@ export interface DescribeDBClusterParametersMessage { /** * @public - *A value that indicates to return only parameters for a specific source.
- * Parameter sources can be engine, service,
- * or customer.
A specific source to return parameters for.
+ *Valid Values:
+ *
+ * customer
+ *
+ * engine
+ *
+ * service
+ *
A value that indicates whether to include shared manual DB cluster snapshots + *
Specifies whether to include shared manual DB cluster snapshots * from other Amazon Web Services accounts that this Amazon Web Services account has been given * permission to copy or restore. By default, these snapshots are not included.
*You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from @@ -14134,7 +14140,7 @@ export interface DescribeDBClusterSnapshotsMessage { /** * @public - *
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied + *
Specifies whether to include manual DB cluster snapshots that are public and can be copied * or restored by any Amazon Web Services account. By default, the public snapshots are not included.
*You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
*/ diff --git a/clients/client-rds/src/models/models_1.ts b/clients/client-rds/src/models/models_1.ts index b7da1f4080b9..860139877964 100644 --- a/clients/client-rds/src/models/models_1.ts +++ b/clients/client-rds/src/models/models_1.ts @@ -43,7 +43,7 @@ import { RDSServiceException as __BaseException } from "./RDSServiceException"; export interface DescribeDBEngineVersionsMessage { /** * @public - *The database engine to return.
+ *The database engine to return version details for.
*Valid Values:
*The database engine version to return.
+ *A specific database engine version to return details for.
*Example: 5.1.49
*
Constraints:
*If supplied, must match an existing DBParameterGroupFamily.
+ *If supplied, must match an existing DB parameter group family.
*A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
+ *Specifies whether to return only the default version of the specified engine or the engine and major version combination.
*/ DefaultOnly?: boolean; /** * @public - *A value that indicates whether to list the supported character sets for each engine version.
+ *Specifies whether to list the supported character sets for each engine version.
*If this parameter is enabled and the requested engine supports the CharacterSetName parameter for
* CreateDBInstance, the response includes a list of supported character sets for each engine
* version.
For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets
- * to true, RDS Custom returns no results.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
*/ ListSupportedCharacterSets?: boolean; /** * @public - *A value that indicates whether to list the supported time zones for each engine version.
+ *Specifies whether to list the supported time zones for each engine version.
*If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance,
* the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones
- * to true, RDS Custom returns no results.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
*/ ListSupportedTimezones?: boolean; /** * @public - *A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
+ *Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
*/ IncludeAll?: boolean; } @@ -947,7 +945,7 @@ export interface DBProxyTargetGroup { /** * @public - *Whether this target group is the first one used for connection requests by the associated proxy. + *
Indicates whether this target group is the first one used for connection requests by the associated proxy.
* Because each proxy is currently associated with a single target group, currently this setting
* is always true.
A value that indicates whether to include shared manual DB cluster snapshots + *
Specifies whether to include shared manual DB cluster snapshots * from other Amazon Web Services accounts that this Amazon Web Services account has been given * permission to copy or restore. By default, these snapshots are not included.
*You can give an Amazon Web Services account permission to restore a manual DB snapshot from @@ -1509,7 +1507,7 @@ export interface DescribeDBSnapshotsMessage { /** * @public - *
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied + *
Specifies whether to include manual DB cluster snapshots that are public and can be copied * or restored by any Amazon Web Services account. By default, the public snapshots are not included.
*You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
*This setting doesn't apply to RDS Custom.
@@ -1949,7 +1947,7 @@ export interface DescribeEventCategoriesMessage { /** * @public *The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
+ *
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
*
Boolean value where true indicates that this option group option can be changed from the default value.
+ *Indicates whether this option group option can be changed from the default value.
*/ IsModifiable?: boolean; /** * @public - *Boolean value where true indicates that a value must be specified for this option setting of the option group option.
+ *Indicates whether a value must be specified for this option setting of the option group option.
*/ IsRequired?: boolean; @@ -2613,7 +2611,7 @@ export interface OptionVersion { /** * @public - *True if the version is the default version of the option, and otherwise false.
+ *Indicates whether the version is the default version of the option.
*/ IsDefault?: boolean; } @@ -2655,7 +2653,7 @@ export interface OptionGroupOption { /** * @public - *Specifies whether the option requires a port.
+ *Indicates whether the option requires a port.
*/ PortRequired?: boolean; @@ -2725,7 +2723,7 @@ export interface OptionGroupOption { /** * @public - *Specifies whether the option can be copied across Amazon Web Services accounts.
+ *Indicates whether the option can be copied across Amazon Web Services accounts.
*/ CopyableCrossAccount?: boolean; } @@ -2994,7 +2992,7 @@ export interface DescribeOrderableDBInstanceOptionsMessage { /** * @public - *A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports + *
Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports * only VPC offerings.
*RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output * shows VPC offerings.
@@ -3126,7 +3124,7 @@ export interface OrderableDBInstanceOption { /** * @public - *Indicates the storage type for a DB instance.
+ *The storage type for a DB instance.
*/ StorageType?: string; @@ -3150,7 +3148,7 @@ export interface OrderableDBInstanceOption { /** * @public - *True if a DB instance supports Performance Insights, otherwise false.
+ *Indicates whether a DB instance supports Performance Insights.
*/ SupportsPerformanceInsights?: boolean; @@ -3204,19 +3202,19 @@ export interface OrderableDBInstanceOption { /** * @public - *Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
+ *Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
*/ SupportsStorageAutoscaling?: boolean; /** * @public - *Whether a DB instance supports Kerberos Authentication.
+ *Indicates whether a DB instance supports Kerberos Authentication.
*/ SupportsKerberosAuthentication?: boolean; /** * @public - *Whether a DB instance supports RDS on Outposts.
+ *Indicates whether a DB instance supports RDS on Outposts.
*For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts * in the Amazon RDS User Guide. *
@@ -3233,13 +3231,13 @@ export interface OrderableDBInstanceOption { /** * @public - *A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
+ *Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
*/ SupportsGlobalDatabases?: boolean; /** * @public - *Whether DB instances can be configured as a Multi-AZ DB cluster.
+ *Indicates whether DB instances can be configured as a Multi-AZ DB cluster.
*For more information on Multi-AZ DB clusters, see * * Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. @@ -3435,7 +3433,7 @@ export interface DescribeReservedDBInstancesMessage { /** * @public - *
A value that indicates whether to show only those reservations that support Multi-AZ.
+ *Specifies whether to show only those reservations that support Multi-AZ.
*/ MultiAZ?: boolean; @@ -3568,7 +3566,7 @@ export interface ReservedDBInstance { /** * @public - *Indicates if the reservation applies to Multi-AZ deployments.
+ *Indicates whether the reservation applies to Multi-AZ deployments.
*/ MultiAZ?: boolean; @@ -3687,7 +3685,7 @@ export interface DescribeReservedDBInstancesOfferingsMessage { /** * @public - *A value that indicates whether to show only those reservations that support Multi-AZ.
+ *Specifies whether to show only those reservations that support Multi-AZ.
*/ MultiAZ?: boolean; @@ -3772,7 +3770,7 @@ export interface ReservedDBInstancesOffering { /** * @public - *Indicates if the offering applies to Multi-AZ deployments.
+ *Indicates whether the offering applies to Multi-AZ deployments.
*/ MultiAZ?: boolean; @@ -3891,7 +3889,7 @@ export interface SourceRegion { /** * @public - *Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
+ *Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
*/ SupportsDBInstanceAutomatedBackupsReplication?: boolean; } @@ -4016,7 +4014,7 @@ export interface ValidStorageOptions { /** * @public - *Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
+ *Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
*/ SupportsStorageAutoscaling?: boolean; @@ -4112,7 +4110,7 @@ export interface DownloadDBLogFilePortionDetails { /** * @public - *Boolean value that if true, indicates there is more data to be downloaded.
+ *A Boolean value that, if true, indicates there is more data to be downloaded.
*/ AdditionalDataPending?: boolean; } @@ -4184,11 +4182,11 @@ export interface DownloadDBLogFilePortionMessage { export interface FailoverDBClusterMessage { /** * @public - *A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
+ *The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.
*Constraints:
*Must match the identifier of an existing DBCluster.
+ *Must match the identifier of an existing DB cluster.
*A value that indicates whether to remove the override for the default certificate. + *
Specifies whether to remove the override for the default certificate. * If the override is removed, the default certificate is the system * default.
*/ @@ -6739,30 +6737,46 @@ export interface ConnectionPoolConfiguration { *The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the
* max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
- *Constraints: Must be between 1 and 100.
+ *Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints:
+ *Must be between 1 and 100.
+ *Controls how actively the proxy closes idle database connections in the connection pool. + *
A value that controls how actively the proxy closes idle database connections in the connection pool.
* The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
* With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of
- * MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and
- * for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent.
MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and
+ * for all other engines, the default is 50.
+ * Constraints:
+ *Must be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the - * proxy has opened its maximum number of connections and all connections are busy with client sessions.
- *Default: 120
- *Constraints: between 1 and 3600, or 0 representing unlimited
+ *The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the
+ * proxy has opened its maximum number of connections and all connections are busy with client sessions. For an unlimited wait time, specify 0.
Default: 120
+ *
Constraints:
+ *Must be between 0 and 3600.
+ *The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
+ *
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
*
A value that indicates whether to activate the subscription.
+ *Specifies whether to activate the subscription.
*/ Enabled?: boolean; } @@ -7237,7 +7251,7 @@ export interface ModifyOptionGroupMessage { /** * @public - *A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
+ *Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
*/ ApplyImmediately?: boolean; } @@ -7536,7 +7550,7 @@ export interface RebootDBInstanceMessage { /** * @public - *A value that indicates whether the reboot is conducted through a Multi-AZ failover.
+ *Specifies whether the reboot is conducted through a Multi-AZ failover.
*Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
*/ ForceFailover?: boolean; @@ -7824,7 +7838,7 @@ export interface ResetDBClusterParameterGroupMessage { /** * @public - *A value that indicates whether to reset all parameters in the DB cluster parameter group + *
Specifies whether to reset all parameters in the DB cluster parameter group
* to their default values. You can't use this parameter if there
* is a list of parameter names specified for the Parameters parameter.
A value that indicates whether to reset all parameters in the DB parameter group to default values. + *
Specifies whether to reset all parameters in the DB parameter group to default values. * By default, all parameters in the DB parameter group are reset to default values.
*/ ResetAllParameters?: boolean; @@ -8122,7 +8136,7 @@ export interface RestoreDBClusterFromS3Message { /** * @public - *A value that indicates whether the restored DB cluster is encrypted.
+ *Specifies whether the restored DB cluster is encrypted.
*/ StorageEncrypted?: boolean; @@ -8141,7 +8155,7 @@ export interface RestoreDBClusterFromS3Message { /** * @public - *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 @@ -8154,7 +8168,7 @@ export interface RestoreDBClusterFromS3Message { * @public *
The identifier for the database engine that was backed up to create the files stored in the * Amazon S3 bucket.
- *Valid values: mysql
+ *
Valid Values: mysql
*
A value that indicates whether the DB cluster has deletion protection enabled. + *
Specifies whether to enable deletion protection for the DB cluster. * The database can't be deleted when deletion protection is enabled. By default, * deletion protection isn't enabled.
*/ @@ -8228,7 +8242,7 @@ export interface RestoreDBClusterFromS3Message { /** * @public - *A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
+ *Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
*/ CopyTagsToSnapshot?: boolean; @@ -8259,7 +8273,7 @@ export interface RestoreDBClusterFromS3Message { /** * @public *The network type of the DB cluster.
- *Valid values:
+ *Valid Values:
*@@ -8284,7 +8298,7 @@ export interface RestoreDBClusterFromS3Message { /** * @public - *
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. @@ -8319,7 +8333,7 @@ export interface RestoreDBClusterFromS3Message { /** * @public *
Specifies the storage type to be associated with the DB cluster.
- *Valid values: aurora, aurora-iopt1
+ *
Valid Values: aurora, aurora-iopt1
*
Default: aurora
*
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 @@ -8672,7 +8686,7 @@ export interface RestoreDBClusterFromSnapshotMessage { /** * @public - *
A value that indicates whether the DB cluster has deletion protection enabled. + *
Specifies whether to enable deletion protection for the DB cluster. * 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
@@ -8681,14 +8695,14 @@ export interface RestoreDBClusterFromSnapshotMessage { /** * @public - *A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
+ *Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
*Valid for: Aurora DB clusters and Multi-AZ DB clusters
*/ CopyTagsToSnapshot?: boolean; /** * @public - *Specify the Active Directory directory ID to restore the DB cluster in. + *
The Active Directory directory ID to restore the DB cluster in. * The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL * Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
*For more information, see
@@ -8699,7 +8713,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
/**
* @public
- * Specify the name of the IAM role to be used when making API calls to the Directory Service. The name of the IAM role to be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only Specifies the storage type to be associated with the DB cluster. When specified for a Multi-AZ DB cluster, a value for the Valid values: Valid Values: Default: Valid for: Aurora DB clusters and Multi-AZ DB clusters 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 to the DB cluster is ultimately controlled by the security group it uses.
@@ -8779,7 +8793,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
/**
* @public
* The network type of the DB cluster. Valid values: Valid Values:
@@ -8918,7 +8932,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
/**
* @public
- * A value that indicates whether to restore the DB cluster to the latest
+ * Specifies whether to restore the DB cluster to the latest
* restorable backup time. By default, the DB cluster isn't restored to the latest
* restorable backup time. Constraints: Can't be specified if 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
@@ -9069,7 +9083,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
/**
* @public
- * A value that indicates whether the DB cluster has deletion protection enabled.
+ * Specifies whether to enable deletion protection for the DB cluster.
* 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 A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters Specify the Active Directory directory ID to restore the DB cluster in.
+ * The Active Directory directory ID to restore the DB cluster in.
* The domain must be created prior to this operation. 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
@@ -9096,7 +9110,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
/**
* @public
- * Specify the name of the IAM role to be used when making API calls to the Directory Service. The name of the IAM role to be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only Specifies the storage type to be associated with the DB cluster. When specified for a Multi-AZ DB cluster, a value for the Valid values: Valid Values: Default: Valid for: Aurora DB clusters and Multi-AZ DB clusters 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.
@@ -9196,7 +9210,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
/**
* @public
* The network type of the DB cluster. Valid values: Valid Values:
@@ -9344,7 +9358,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
/**
* @public
- * A value that indicates whether the DB instance is a Multi-AZ deployment. Specifies whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom. Constraint: You can't specify the 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
@@ -9364,7 +9378,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
/**
* @public
- * A value that indicates whether minor version upgrades are applied automatically to the DB instance
+ * Specifies whether to automatically apply minor version upgrades to the DB instance
* during the maintenance window. If you restore an RDS Custom DB instance, you must disable this parameter. License model information for the restored DB instance. This setting doesn't apply to RDS Custom. Default: Same as source. Valid values: Valid Values: Specifies the storage type to be associated with the DB instance. Valid values: Valid Values: If you specify The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Constraints: Can't be longer than 64 characters. Example: A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you
* specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from
* the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance. 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 is disabled. For more information about IAM database authentication, see
*
@@ -9634,7 +9653,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
/**
* @public
- * 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. A value that indicates whether the DB instance has deletion protection enabled.
+ * Specifies whether to enable deletion protection for the DB instance.
* The database can't be deleted when deletion protection is enabled. By default,
* deletion protection isn't enabled. For more information, see
*
@@ -9676,7 +9695,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
/**
* @public
- * 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
@@ -9723,7 +9742,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
/**
* @public
* The network type of the DB instance. Valid values: Valid Values:
@@ -10038,7 +10057,7 @@ export interface RestoreDBInstanceFromS3Message {
/**
* @public
- * A value that indicates whether the DB instance is a Multi-AZ deployment.
+ * Specifies whether the DB instance is a Multi-AZ deployment.
* If the DB instance is a Multi-AZ deployment, you can't set the A value that indicates whether minor engine upgrades are applied automatically
+ * Specifies whether to automatically apply minor engine upgrades
* to the DB instance during the maintenance window. By default, minor engine upgrades
* are not applied automatically. 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.
@@ -10108,7 +10127,7 @@ export interface RestoreDBInstanceFromS3Message {
/**
* @public
* Specifies the storage type to be associated with the DB instance. Valid values: Valid Values: If you specify A value that indicates whether the new DB instance is encrypted or not. Specifies whether the new DB instance is encrypted or not. 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. Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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 about IAM database authentication, see
*
@@ -10220,7 +10239,7 @@ export interface RestoreDBInstanceFromS3Message {
/**
* @public
- * 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. 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. A value that indicates whether the DB instance has deletion protection enabled.
+ * Specifies whether to enable deletion protection for the DB instance.
* The database can't be deleted when deletion protection is enabled. By default,
* deletion protection isn't enabled. For more information, see
*
@@ -10314,7 +10333,7 @@ export interface RestoreDBInstanceFromS3Message {
/**
* @public
* The network type of the DB instance. Valid values: Valid Values:
@@ -10346,7 +10365,7 @@ export interface RestoreDBInstanceFromS3Message {
/**
* @public
- * 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.
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom. The data to be exported from the snapshot or cluster.
- * If this parameter is not provided, all of the data is exported.
- * Valid values are the following: Valid Values:
diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json
index 115d8172f5e4..570178888e23 100644
--- a/codegen/sdk-codegen/aws-models/rds.json
+++ b/codegen/sdk-codegen/aws-models/rds.json
@@ -2003,14 +2003,14 @@
"ApplyAction": {
"target": "com.amazonaws.rds#String",
"traits": {
- "smithy.api#documentation": " The pending maintenance action to apply to this resource. Valid values: The pending maintenance action to apply to this resource. Valid Values: A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type Valid values: \n \n \n A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type Valid Values: \n \n \n A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled. Specifies whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled. A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs. Specifies whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs. Whether there is an override for the default certificate identifier. Indicates whether there is an override for the default certificate identifier. A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n If you specify Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines Constraints: Must be between 1 and 100. The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n If you specify Default: Constraints: Must be between 1 and 100. Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the If you specify this parameter, then you must also include a value for Default: The default value is half of the value of Constraints: Must be between 0 and the value of A value that controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the If you specify this parameter, then you must also include a value for Default: The default value is half of the value of Constraints: Must be between 0 and the value of The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions. Default: 120 Constraints: between 1 and 3600, or 0 representing unlimited The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions. For an unlimited wait time, specify Default: Constraints: Must be between 0 and 3600. A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied. Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied. A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied. Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied. A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls. Specifies whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls. 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\n cluster. 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. 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\n cluster. Constraints: Can't be specified if Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character. 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. Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide. Amazon Aurora doesn't support this operation. Call the All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified. Your source DB instance or cluster must have backup retention enabled. Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide. Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified. Your source DB instance or cluster must have backup retention enabled. The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide. Default: Inherits from the source DB instance. The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: Inherits the value from the source DB instance. The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: The port number that the DB instance uses for connections. Valid Values: Default: Inherits the value from the source DB instance. A value that indicates whether the read replica is in a Multi-AZ deployment. You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your\n replica in another Availability Zone for failover support for the replica. Creating your\n read replica as a Multi-AZ DB instance is independent of whether the source is a\n Multi-AZ DB instance or a Multi-AZ DB cluster. This setting doesn't apply to RDS Custom. Specifies whether the read replica is in a Multi-AZ deployment. You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your\n replica in another Availability Zone for failover support for the replica. Creating your\n read replica as a Multi-AZ DB instance is independent of whether the source is a\n Multi-AZ DB instance or a Multi-AZ DB cluster. This setting doesn't apply to RDS Custom DB instances. A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window. This setting doesn't apply to RDS Custom. Default: Inherits from the source DB instance Specifies whether to automatically apply minor engine upgrades to the\n read replica during the maintenance window. This setting doesn't apply to RDS Custom DB instances. Default: Inherits the value from the source DB instance. 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. The option group the DB instance is associated with. If omitted, the option group\n associated with the source instance or cluster is used. For SQL Server, you must use the option group associated with the source. This setting doesn't apply to RDS Custom. The option group to associate the DB instance with. If not specified, RDS uses the option group\n associated with the source DB instance or cluster. For SQL Server, you must use the option group associated with the source. This setting doesn't apply to RDS Custom DB instances. The name of the DB parameter group to associate with this DB instance. If you do not specify a value for Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens The name of the DB parameter group to associate with this DB instance. If you don't specify a value for Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or for RDS Custom. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. A value that indicates whether the DB instance is publicly accessible. When 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. 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. Specifies whether the DB instance is publicly accessible. When 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. 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. Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC. Constraints: If supplied, must match the name of an existing DBSubnetGroup. The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running. All read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:> Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC. Not specify a DB subnet group. All these read replicas are created outside of any\n VPC. Example: A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC. Constraints: If supplied, must match the name of an existing DB subnet group. The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running. All read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either: Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC. Not specify a DB subnet group. All these read replicas are created outside of any\n VPC. Example: A list of Amazon EC2 VPC security groups to associate with the read replica. This setting doesn't apply to RDS Custom. Default: The default EC2 VPC security group for the DB subnet group's VPC. A list of Amazon EC2 VPC security groups to associate with the read replica. This setting doesn't apply to RDS Custom DB instances. Default: The default EC2 VPC security group for the DB subnet group's VPC. Specifies the storage type to be associated with the read replica. Valid values: If you specify Default: The storage type to associate with the read replica. If you specify Valid Values: Default: A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied. Specifies whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags aren't copied. The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0. If This setting doesn't apply to RDS Custom. Valid Values: The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collection of Enhanced Monitoring metrics,\n specify If This setting doesn't apply to RDS Custom DB instances. Valid Values: Default: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, If This setting doesn't apply to RDS Custom. The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, If This setting doesn't apply to RDS Custom DB instances. When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions. This setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n The presigned URL must be a valid request for the\n \n For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the \n \n To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n \n This setting doesn't apply to RDS Custom. When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions. This setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n The presigned URL must be a valid request for the\n \n For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the \n \n To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n \n This setting doesn't apply to RDS Custom DB instances. 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. For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. 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. For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances. A value that indicates whether to enable Performance Insights for the read replica. For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. Specifies whether to enable Performance Insights for the read replica. For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances. 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 This setting doesn't apply to RDS Custom. 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 This setting doesn't apply to RDS Custom DB instances. The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: 7 \n 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) 589 (19 months * 31) 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. The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: \n \n month * 31, where month is a number of months from 1-23. \n Examples: \n Default: If you specify a retention period that isn't valid, such as The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances. 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. 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 DB instances. A value that indicates whether the DB instance class of the DB instance uses its default\n processor features. This setting doesn't apply to RDS Custom. Specifies whether the DB instance class of the DB instance uses its default\n processor features. This setting doesn't apply to RDS Custom DB instances. 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. Specifies whether to enable deletion protection for the DB instance. \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. 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. For more information, see \n Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. 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. For more information, see \n Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances. The name of the IAM role to be used when making API calls to the Directory\n Service. This setting doesn't apply to RDS Custom. The name of the IAM role to use when making API calls to the Directory\n Service. This setting doesn't apply to RDS Custom DB instances. 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: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide. This setting is required for RDS Custom. 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: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide. This setting is required for RDS Custom DB instances. The network type of the DB instance. Valid values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n The network type of the DB instance. Valid Values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n Specifies the storage throughput value for the read replica. This setting doesn't apply to RDS Custom or Amazon Aurora. Specifies the storage throughput value for the read replica. This setting doesn't apply to RDS Custom or Amazon Aurora DB instances. A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica. A 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 read replica from outside of its virtual\n private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide. Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica. A 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 read replica from outside of its virtual\n private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide. A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write\n or only read operations. The default is A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy. Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy. Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs. Specifies whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs. The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n Valid values: The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n Valid Values: A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. 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 Indicates 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 Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it. Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it. True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and \n otherwise false. Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. Specifies whether the source DB cluster is encrypted. Indicates whether the source DB cluster is encrypted. Value that is Indicates whether the cluster member is the primary DB instance for the DB cluster. Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored. The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored. Specifies the identifier for the DB cluster snapshot. The identifier for the DB cluster snapshot. Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from. The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from. Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). The time when the snapshot was taken, in Universal Coordinated Time (UTC). Specifies the name of the database engine for this DB cluster snapshot. The name of the database engine for this DB cluster snapshot. Provides the engine mode of the database engine for this DB cluster snapshot. The engine mode of the database engine for this DB cluster snapshot. Specifies the allocated storage size in gibibytes (GiB). The allocated storage size of the DB cluster snapshot in gibibytes (GiB). Specifies the status of this DB cluster snapshot. Valid statuses are the following: \n \n \n The status of this DB cluster snapshot. Valid statuses are the following: \n \n \n Specifies the port that the DB cluster was listening on at the time of the snapshot. The port that the DB cluster was listening on at the time of the snapshot. Provides the VPC ID associated with the DB cluster snapshot. The VPC ID associated with the DB cluster snapshot. 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). Provides the master username for this DB cluster snapshot. The master username for this DB cluster snapshot. Provides the version of the database engine for this DB cluster snapshot. The version of the database engine for this DB cluster snapshot. Provides the license model information for this DB cluster snapshot. The license model information for this DB cluster snapshot. Provides the type of the DB cluster snapshot. The type of the DB cluster snapshot. Specifies the percentage of the estimated data that has been transferred. The percentage of the estimated data that has been transferred. Specifies whether the DB cluster snapshot is encrypted. Indicates whether the DB cluster snapshot is encrypted. Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot. The Amazon Resource Name (ARN) for the DB cluster snapshot. 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. Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from. The resource ID of the DB cluster that this DB cluster snapshot was created from. A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs. Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs. A value that indicates whether you can use Aurora parallel query with a specific DB engine version. Indicates whether you can use Aurora parallel query with a specific DB engine version. A value that indicates whether you can use Aurora global databases with a specific DB engine version. Indicates whether you can use Aurora global databases with a specific DB engine version. A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL. Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. A value that indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance. Indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance. A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only Indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only Earliest and latest time an instance can be restored to. The earliest and latest time a DB instance can be restored to. Specifies the allocated storage size in gibibytes (GiB). The allocated storage size for the the automated backup in gibibytes (GiB). Provides a list of status information for an automated backup: \n \n \n A list of status information for an automated backup: \n \n \n Provides the VPC ID associated with the DB instance. The VPC ID associated with the DB instance. Provides the date and time that the DB instance was created. The date and time when the DB instance was created. License model information for the automated backup. The license model information for the automated backup. Specifies whether the automated backup is encrypted. Indicates whether the automated backup is encrypted. Specifies the storage type associated with the automated backup. The storage type associated with the automated backup. Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region. The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region. Specifies the storage throughput for the automated backup. The storage throughput for the automated backup. Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values: \n \n \n Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values: \n \n \n Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated. The status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated. Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs. Indicates whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs. A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only. Indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only. Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always Indicates whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always Specifies whether the DB snapshot is encrypted. Indicates whether the DB snapshot is encrypted. 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. A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled. You must specify a Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled. You must specify a A value that indicates whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted. Specifies whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted. The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by If you request a final DB snapshot \n the status of the Amazon RDS DB instance is When a DB instance is in a failure state and has a status of If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true: The DB cluster is a read replica of another Amazon Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first call the\n Deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n However, manual DB snapshots of the DB instance aren't deleted. If you request a final DB snapshot, the status of the Amazon RDS DB instance is When a DB instance is in a failure state and has a status of If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true: The DB cluster is a read replica of another Amazon Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first use the For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete \n these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail. A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created. If you don't enable this parameter, you must specify the When a DB instance is in a failure state and has a status of If you delete a read replica or an RDS Custom instance, you must enable this setting. This setting is required for RDS Custom. Specifies whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created. If you don't enable this parameter, you must specify the When a DB instance is in a failure state and has a status of If you delete a read replica or an RDS Custom instance, you must enable this setting. This setting is required for RDS Custom. A value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted. Specifies whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted. A value that indicates to return only parameters for a specific source. \n Parameter sources can be A specific source to return parameters for. Valid Values: \n \n \n A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the Specifies whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action. Specifies whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action. Returns a list of the available DB engines. Describes the properties of specific versions of DB engines. The database engine to return. Valid Values: \n \n \n \n \n \n \n \n \n \n \n \n \n \n The database engine to return version details for. Valid Values: \n \n \n \n \n \n \n \n \n \n \n \n \n \n The database engine version to return. Example: A specific database engine version to return details for. Example: The name of a specific DB parameter group family to return details for. Constraints: If supplied, must match an existing DBParameterGroupFamily. The name of a specific DB parameter group family to return details for. Constraints: If supplied, must match an existing DB parameter group family. A value that indicates whether only the default version of the specified engine or engine and major version combination is returned. Specifies whether to return only the default version of the specified engine or the engine and major version combination. A value that indicates whether to list the supported character sets for each engine version. If this parameter is enabled and the requested engine supports the For RDS Custom, the default is not to list supported character sets. If you set Specifies whether to list the supported character sets for each engine version. If this parameter is enabled and the requested engine supports the For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results. A value that indicates whether to list the supported time zones for each engine version. If this parameter is enabled and the requested engine supports the For RDS Custom, the default is not to list supported time zones. If you set Specifies whether to list the supported time zones for each engine version. If this parameter is enabled and the requested engine supports the For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results. A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions. Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions. A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the This setting doesn't apply to RDS Custom. Specifies whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the This setting doesn't apply to RDS Custom. A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API. This setting doesn't apply to RDS Custom. Specifies whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API. This setting doesn't apply to RDS Custom. The type of source that is generating the events. For RDS Proxy events, specify Valid values: The type of source that is generating the events. For RDS Proxy events, specify Valid Values: A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings. RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings. Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings. RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings. A value that indicates whether to show only those reservations that support Multi-AZ. Specifies whether to show only those reservations that support Multi-AZ. A value that indicates whether to show only those reservations that support Multi-AZ. Specifies whether to show only those reservations that support Multi-AZ. Boolean value that if true, indicates there is more data to be downloaded. A Boolean value that, if true, indicates there is more data to be downloaded. The data exported from the snapshot or cluster. Valid values are the following: \n \n \n \n The data exported from the snapshot or cluster. Valid Values: \n \n \n \n The time that the snapshot was created. The time when the snapshot was created. The time that the snapshot or cluster export task started. The time when the snapshot or cluster export task started. The time that the snapshot or cluster export task ended. The time when the snapshot or cluster export task ended. The Amazon S3 bucket that the snapshot or cluster is exported to. The Amazon S3 bucket where the snapshot or cluster is exported to. Contains the details of a snapshot or cluster export to Amazon S3. This data type is used as a response element in the Contains the details of a snapshot or cluster export to Amazon S3. This data type is used as a response element in the A DB cluster identifier to force a failover for. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DBCluster. The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DB cluster. Specifies whether the Aurora DB cluster is the primary cluster\n (that is, has read-write capability) for the global\n cluster with which it is associated. Indicates whether the Aurora DB cluster is the primary cluster\n (that is, has read-write capability) for the global\n cluster with which it is associated. Specifies whether a secondary cluster in the global cluster has\n write forwarding enabled, not enabled, or is in the process of enabling it. The status of write forwarding for a secondary cluster in the global cluster. Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\". The status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\". Specifies the IP range. The IP range. A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default. Specifies whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default. The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify Valid values: The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify Valid Values: A value that indicates whether to activate the subscription. Specifies whether to activate the subscription. A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group. Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group. Indicate if this option is persistent. Indicates whether this option is persistent. Indicate if this option is permanent. Indicates whether this option is permanent. Option details. The details of an option. Specifies whether the option requires a port. Indicates whether the option requires a port. Specifies whether the option can be copied across Amazon Web Services accounts. Indicates whether the option can be copied across Amazon Web Services accounts. Boolean value where true indicates that this option group option can be changed from the default value. Indicates whether this option group option can be changed from the default value. Boolean value where true indicates that a value must be specified for this option setting of the option group option. Indicates whether a value must be specified for this option setting of the option group option. A Boolean value that, when true, indicates the option setting can be modified from the default. Indicates whether the option setting can be modified from the default. Indicates if the option setting is part of a collection. Indicates whether the option setting is part of a collection. True if the version is the default version of the option, and otherwise false. Indicates whether the version is the default version of the option. Indicates the storage type for a DB instance. The storage type for a DB instance. True if a DB instance supports Performance Insights, otherwise false. Indicates whether a DB instance supports Performance Insights. Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class. Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class. Whether a DB instance supports Kerberos Authentication. Indicates whether a DB instance supports Kerberos Authentication. Whether a DB instance supports RDS on Outposts. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n Indicates whether a DB instance supports RDS on Outposts. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes. Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes. Whether DB instances can be configured as a Multi-AZ DB cluster. For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n Indicates whether DB instances can be configured as a Multi-AZ DB cluster. For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n Specifies the name of the parameter. The name of the parameter. Specifies the value of the parameter. The value of the parameter. Indicates the source of the parameter value. The source of the parameter value. A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment. Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment. Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. A value that indicates whether the reboot is conducted through a Multi-AZ failover. Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ. Specifies whether the reboot is conducted through a Multi-AZ failover. Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ. Indicates if the reservation applies to Multi-AZ deployments. Indicates whether the reservation applies to Multi-AZ deployments. Indicates if the offering applies to Multi-AZ deployments. Indicates whether the offering applies to Multi-AZ deployments. A value that indicates whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Specifies whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values. Specifies whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values. A value that indicates whether the restored DB cluster is encrypted. Specifies whether the restored DB cluster is encrypted. 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. For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide. 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. For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide. The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket. Valid values: The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket. Valid Values: 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. Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. The network type of the DB cluster. Valid values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n The network type of the DB cluster. Valid Values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n A value that indicates 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 \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n Constraints: Can't manage the master user password with Amazon Web Services Secrets Manager if 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 \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n Constraints: Can't manage the master user password with Amazon Web Services Secrets Manager if Specifies the storage type to be associated with the DB cluster. Valid values: Default: Valid for: Aurora DB clusters only Specifies the storage type to be associated with the DB cluster. Valid Values: Default: Valid for: Aurora DB clusters only 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. For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only 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. For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see \n Kerberos Authentication in the Amazon RDS User Guide. Valid for: Aurora DB clusters only The Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see \n Kerberos Authentication in the Amazon RDS User Guide. Valid for: Aurora DB clusters only 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 be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only Specifies the storage type to be associated with the DB cluster. When specified for a Multi-AZ DB cluster, a value for the Valid values: Default: Valid for: Aurora DB clusters and Multi-AZ DB clusters Specifies the storage type to be associated with the DB cluster. When specified for a Multi-AZ DB cluster, a value for the Valid Values: Default: Valid for: Aurora DB clusters and Multi-AZ DB clusters A value that 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 \n 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. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not 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. Default: The default behavior varies depending on whether If If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. Valid for: Aurora DB clusters and Multi-AZ DB clusters 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 \n 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. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not 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. Default: The default behavior varies depending on whether If If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. Valid for: Aurora DB clusters and Multi-AZ DB clusters The network type of the DB cluster. Valid values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n Valid for: Aurora DB clusters only The network type of the DB cluster. Valid Values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n Valid for: Aurora DB clusters only A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time. Constraints: Can't be specified if Valid for: Aurora DB clusters and Multi-AZ DB clusters Specifies whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time. Constraints: Can't be specified if Valid for: Aurora DB clusters and Multi-AZ DB clusters 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. For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only 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. For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only The Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only 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 be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only Specifies the storage type to be associated with the DB cluster. When specified for a Multi-AZ DB cluster, a value for the Valid values: Default: Valid for: Aurora DB clusters and Multi-AZ DB clusters Specifies the storage type to be associated with the DB cluster. When specified for a Multi-AZ DB cluster, a value for the Valid Values: Default: Valid for: Aurora DB clusters and Multi-AZ DB clusters A value that 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 \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not 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. Default: The default behavior varies depending on whether If If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. 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 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 \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not 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. Default: The default behavior varies depending on whether If If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. 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 The network type of the DB cluster. Valid values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n Valid for: Aurora DB clusters only The network type of the DB cluster. Valid Values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n Valid for: Aurora DB clusters only A value that indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom. Constraint: You can't specify the Specifies whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom. Constraint: You can't specify the A value that indicates 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 \n 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. Access to the DB instance is ultimately controlled \n 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. 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 \n 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. Access to the DB instance is ultimately controlled \n 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. A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. If you restore an RDS Custom DB instance, you must disable this parameter. Specifies whether to automatically apply minor version upgrades to the DB instance \n during the maintenance window. If you restore an RDS Custom DB instance, you must disable this parameter. License model information for the restored DB instance. This setting doesn't apply to RDS Custom. Default: Same as source. Valid values: License model information for the restored DB instance. This setting doesn't apply to RDS Custom. Default: Same as source. Valid Values: Specifies the storage type to be associated with the DB instance. Valid values: If you specify Default: Specifies the storage type to be associated with the DB instance. Valid Values: If you specify Default: The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Constraints: Example: The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Constraints: Can't be longer than 64 characters. Example: A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance. For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide. Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance. For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide. 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 is disabled. For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n This setting doesn't apply to RDS Custom. Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n This setting doesn't apply to RDS Custom. A value that indicates whether the DB instance class of the DB instance uses its default\n processor features. This setting doesn't apply to RDS Custom. Specifies whether the DB instance class of the DB instance uses its default\n processor features. This setting doesn't apply to RDS Custom. 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. Specifies whether to enable deletion protection for the DB instance. \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. A value that indicates 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\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. This setting doesn't apply to RDS Custom. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide. 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\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. This setting doesn't apply to RDS Custom. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide. The network type of the DB instance. Valid values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n The network type of the DB instance. Valid Values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the Specifies whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically. Specifies whether to automatically apply minor engine upgrades \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically. A value that indicates 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 \n 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. 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. 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 \n 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. 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. Specifies the storage type to be associated with the DB instance. Valid values: If you specify Default: Specifies the storage type to be associated with the DB instance. Valid Values: If you specify Default: A value that indicates whether the new DB instance is encrypted or not. Specifies whether the new DB instance is encrypted or not. 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. Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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. For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n 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. For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n A 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. 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. A value that indicates whether the DB instance class of the DB instance uses its default\n processor features. Specifies whether the DB instance class of the DB instance uses its default\n processor features. 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. Specifies whether to enable deletion protection for the DB instance. \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. The network type of the DB instance. Valid values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n The network type of the DB instance. Valid Values: \n \n The network type is determined by the For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n A value that indicates 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 \n in the Amazon RDS User Guide.\n Constraints: Can't manage the master user password with Amazon Web Services Secrets Manager if 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 \n in the Amazon RDS User Guide.\n Constraints: Can't manage the master user password with Amazon Web Services Secrets Manager if A value that indicates whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom. Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom. A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it. Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it. A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes. Indicates whether automatic pause is allowed for the Aurora DB cluster\n in When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes. Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region. Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region. The data to be exported from the snapshot or cluster. \n If this parameter is not provided, all of the data is exported.\n Valid values are the following: \n \n \n \n The data to be exported from the snapshot or cluster. \n If this parameter isn't provided, all of the data is exported. Valid Values: \n \n \n \n A value that indicates whether the target version is applied to any source DB instances that have Indicates whether the target version is applied to any source DB instances that have A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine. Indicates whether upgrading to the target version requires upgrading the major version of the database engine. A value that indicates whether you can use Aurora parallel query with the target engine version. Indicates whether you can use Aurora parallel query with the target engine version. A value that indicates whether you can use Aurora global databases with the target engine version. Indicates whether you can use Aurora global databases with the target engine version. A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version. Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version. A value that indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only Indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class. Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.Iops parameter is required.aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
*
RestoreToTime parameter is provided.Iops parameter is required.aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
*
AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.license-included | bring-your-own-license | general-public-license
+ * license-included | bring-your-own-license | general-public-license
* gp2 | gp3 | io1 | standard
+ * gp2 | gp3 | io1 | standard
* io1 or gp3, you must also include a value for the
* Iops parameter.
+ *
* arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
*
*
AvailabilityZone parameter.gp2 | gp3 | io1 | standard
+ * gp2 | gp3 | io1 | standard
* io1 or gp3,
* you must also include a value for the Iops parameter.
*
*
system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n immediate can't be undone.\n
",
+ "smithy.api#documentation": "immediate - Apply the maintenance action immediately.next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.immediate can't be undone.\n
",
"smithy.api#required": {}
}
}
@@ -2343,13 +2343,13 @@
"Force": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
- "smithy.api#documentation": "immediate - Apply the maintenance action immediately.next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.MaxIdleConnectionsPercent, then you must also include a value for this parameter.max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.MaxIdleConnectionsPercent, then you must also include a value for this parameter.10 for RDS for Microsoft SQL Server, and 100 for all other engines\n
"
}
},
"MaxIdleConnectionsPercent": {
"target": "com.amazonaws.rds#IntegerOptional",
"traits": {
- "smithy.api#documentation": "max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.MaxConnectionsPercent.MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.MaxConnectionsPercent.max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.MaxConnectionsPercent.MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.\n
"
}
},
"ConnectionBorrowTimeout": {
"target": "com.amazonaws.rds#IntegerOptional",
"traits": {
- "smithy.api#documentation": "MaxConnectionsPercent.0.120\n \n
"
}
},
"SessionPinningFilters": {
@@ -3146,7 +3146,7 @@
"CopyTags": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
- "smithy.api#documentation": "\n
\n ManageMasterUserPassword is turned on.\n
"
+ "smithy.api#documentation": "\n
\n ManageMasterUserPassword is turned on.\n
"
}
},
"DBSecurityGroups": {
@@ -5073,7 +5073,7 @@
}
],
"traits": {
- "smithy.api#documentation": "CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.CreateDBInstance\n operation.1150-65535\n 1150-65535\n DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.\n
"
+ "smithy.api#documentation": "DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of the source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.\n
"
}
},
"PubliclyAccessible": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
- "smithy.api#documentation": "\n
\n \n
\n mydbsubnetgroup\n \n
\n \n
\n mydbsubnetgroup\n gp2 | gp3 | io1 | standard\n io1 or gp3, you must also include a value for the\n Iops parameter.io1 if the Iops parameter\n is specified, otherwise gp2\n io1 or gp3, you must also include a value for the\n Iops parameter.gp2 | gp3 | io1 | standard\n io1 if the Iops parameter\n is specified. Otherwise, gp2.MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.0, 1, 5, 10, 15, 30, 60\n 0. The default is 0.MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.0, 1, 5, 10, 15, 30, 60\n 0\n arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:\n
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.SourceDBInstanceIdentifier - The DB instance identifier for the\n encrypted DB instance to be replicated. This identifier must be in the Amazon\n Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are\n creating an encrypted read replica from a DB instance in the us-west-2\n Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.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.SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:\n
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.SourceDBInstanceIdentifier - The DB instance identifier for the\n encrypted DB instance to be replicated. This identifier must be in the Amazon\n Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are\n creating an encrypted read replica from a DB instance in the us-west-2\n Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.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.SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.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.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.\n
\n \n
\n \n
\n 7\n 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)731\n 7 days94, Amazon RDS returns an error.\n
\n AWSRDSCustom.\n
\n AWSRDSCustom.\n
\n IPV4\n DUAL\n DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).\n
\n IPV4\n DUAL\n DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.true if the cluster member is the primary instance for the DB cluster and false otherwise.\n
"
+ "smithy.api#documentation": "available\n copying\n creating\n \n
"
}
},
"Port": {
"target": "com.amazonaws.rds#Integer",
"traits": {
"smithy.api#default": 0,
- "smithy.api#documentation": "available\n copying\n creating\n \n
"
+ "smithy.api#documentation": "active - Automated backups for current instances.retained - Automated backups for deleted instances.creating - Automated backups that are waiting for the first automated snapshot to be available.\n
"
}
},
"Port": {
@@ -8811,13 +8811,13 @@
"VpcId": {
"target": "com.amazonaws.rds#String",
"traits": {
- "smithy.api#documentation": "active - Automated backups for current instances.retained - Automated backups for deleted instances.creating - Automated backups that are waiting for the first automated snapshot to be available.\n
"
+ "smithy.api#documentation": "ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.\n
"
}
}
},
"traits": {
- "smithy.api#documentation": "ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.true.true.FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.DeleteDBInstance are not deleted.deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.\n
\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.deleting until the DB snapshot is created. \n This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.\n
\n PromoteReadReplicaDBCluster operation to promote the DB cluster so that it's no longer a read replica. \n After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.FinalDBSnapshotIdentifier parameter.failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.FinalDBSnapshotIdentifier parameter.failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.engine, service,\n or customer.\n
"
}
},
"Filters": {
@@ -12872,14 +12872,14 @@
"target": "com.amazonaws.rds#Boolean",
"traits": {
"smithy.api#default": false,
- "smithy.api#documentation": "customer\n engine\n service\n ModifyDBClusterSnapshotAttribute API action.ModifyDBClusterSnapshotAttribute API action.\n
"
+ "smithy.api#documentation": "aurora-mysql\n aurora-postgresql\n custom-oracle-ee\n mariadb\n mysql\n oracle-ee\n oracle-ee-cdb\n oracle-se2\n oracle-se2-cdb\n postgres\n sqlserver-ee\n sqlserver-se\n sqlserver-ex\n sqlserver-web\n \n
"
}
},
"EngineVersion": {
"target": "com.amazonaws.rds#String",
"traits": {
- "smithy.api#documentation": "aurora-mysql\n aurora-postgresql\n custom-oracle-ee\n mariadb\n mysql\n oracle-ee\n oracle-ee-cdb\n oracle-se2\n oracle-se2-cdb\n postgres\n sqlserver-ee\n sqlserver-se\n sqlserver-ex\n sqlserver-web\n 5.1.49\n 5.1.49\n \n
"
+ "smithy.api#documentation": "\n
"
}
},
"Filters": {
@@ -13272,25 +13272,25 @@
"target": "com.amazonaws.rds#Boolean",
"traits": {
"smithy.api#default": false,
- "smithy.api#documentation": "CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.ListSupportedCharacterSets\n to true, RDS Custom returns no results.CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.ListSupportedTimezones\n to true, RDS Custom returns no results.TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.ModifyDBSnapshotAttribute API action.ModifyDBSnapshotAttribute API action.db-proxy.db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n db-proxy.db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n \n
"
+ "smithy.api#documentation": "database - Export all the data from a specified database.database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.\n
"
}
},
"SnapshotTime": {
"target": "com.amazonaws.rds#TStamp",
"traits": {
- "smithy.api#documentation": "database - Export all the data from a specified database.database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.DescribeExportTasks action.DescribeExportTasks operation.\n
",
+ "smithy.api#documentation": "\n
",
"smithy.api#required": {}
}
},
@@ -17500,13 +17500,13 @@
"target": "com.amazonaws.rds#Boolean",
"traits": {
"smithy.api#default": false,
- "smithy.api#documentation": "db-proxy. If this value isn't specified, all events are returned.db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n db-proxy. If this value isn't specified, all events are returned.db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n Parameters parameter.Parameters parameter.mysql\n mysql\n \n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).\n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).\n
"
+ "smithy.api#documentation": "MasterUserPassword \n is specified.\n
"
}
},
"MasterUserSecretKmsKeyId": {
@@ -23790,7 +23790,7 @@
"StorageType": {
"target": "com.amazonaws.rds#String",
"traits": {
- "smithy.api#documentation": "MasterUserPassword \n is specified.aurora, aurora-iopt1\n aurora\n aurora, aurora-iopt1\n aurora\n Iops parameter is required.aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)Iops parameter is required.aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)DBSubnetGroupName is specified.DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:\n
\n DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:\n
\n DBSubnetGroupName is specified.DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:\n
\n DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:\n
\n \n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).\n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).RestoreToTime parameter is provided.RestoreToTime parameter is provided.Iops parameter is required.aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)Iops parameter is required.aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)DBSubnetGroupName is specified.DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:\n
\n DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:\n
\n DBSubnetGroupName is specified.DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:\n
\n DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:\n
\n \n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).\n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.license-included | bring-your-own-license | general-public-license\n license-included | bring-your-own-license | general-public-license\n gp2 | gp3 | io1 | standard\n io1 or gp3, you must also include a value for the\n Iops parameter.io1 if the Iops parameter\n is specified, otherwise gp2\n gp2 | gp3 | io1 | standard\n io1 or gp3, you must also include a value for the\n Iops parameter.io1 if the Iops parameter\n is specified, otherwise gp2\n arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n \n
\n arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n \n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).\n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).AvailabilityZone parameter.AvailabilityZone parameter.gp2 | gp3 | io1 | standard\n io1 or gp3, \n you must also include a value for the Iops parameter.io1 \n if the Iops parameter is specified; \n otherwise gp2\n gp2 | gp3 | io1 | standard\n io1 or gp3, \n you must also include a value for the Iops parameter.io1 \n if the Iops parameter is specified; \n otherwise gp2\n \n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).\n
\n IPV4\n DUAL\n DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).\n
"
+ "smithy.api#documentation": "MasterUserPassword \n is specified.\n
"
}
},
"MasterUserSecretKmsKeyId": {
@@ -25542,7 +25542,7 @@
"UseDefaultProcessorFeatures": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
- "smithy.api#documentation": "MasterUserPassword \n is specified.serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).serverless DB engine mode.serverless DB engine mode.\n
"
+ "smithy.api#documentation": "database - Export all the data from a specified database.database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.\n
"
}
}
},
@@ -27628,14 +27628,14 @@
"target": "com.amazonaws.rds#Boolean",
"traits": {
"smithy.api#default": false,
- "smithy.api#documentation": "database - Export all the data from a specified database.database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.AutoMinorVersionUpgrade set to true.AutoMinorVersionUpgrade set to true.ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.