Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, -Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools +Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your diff --git a/clients/client-rds/src/RDS.ts b/clients/client-rds/src/RDS.ts index 050d02458137..15d25f9030bc 100644 --- a/clients/client-rds/src/RDS.ts +++ b/clients/client-rds/src/RDS.ts @@ -3457,7 +3457,7 @@ export interface RDS { * database and manages common database administration tasks, freeing up developers to focus on what makes their applications * and businesses unique.
*Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, - * Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools + * Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools * you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS * automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS * is flexible: you can scale your DB instance's compute resources and storage capacity to meet your diff --git a/clients/client-rds/src/RDSClient.ts b/clients/client-rds/src/RDSClient.ts index e2299d00645e..46d2f7ff4223 100644 --- a/clients/client-rds/src/RDSClient.ts +++ b/clients/client-rds/src/RDSClient.ts @@ -1048,7 +1048,7 @@ export interface RDSClientResolvedConfig extends RDSClientResolvedConfigType {} * database and manages common database administration tasks, freeing up developers to focus on what makes their applications * and businesses unique.
*Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, - * Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools + * Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools * you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS * automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS * is flexible: you can scale your DB instance's compute resources and storage capacity to meet your diff --git a/clients/client-rds/src/commands/CreateDBInstanceReadReplicaCommand.ts b/clients/client-rds/src/commands/CreateDBInstanceReadReplicaCommand.ts index df6a65ab954f..cd99ab166a7f 100644 --- a/clients/client-rds/src/commands/CreateDBInstanceReadReplicaCommand.ts +++ b/clients/client-rds/src/commands/CreateDBInstanceReadReplicaCommand.ts @@ -40,7 +40,7 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan * @public *
Creates a new DB instance that acts as a read replica for an existing source DB * instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running - * MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a + * Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a * Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working * 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 CreateDBInstance
diff --git a/clients/client-rds/src/commands/DescribeOptionGroupOptionsCommand.ts b/clients/client-rds/src/commands/DescribeOptionGroupOptionsCommand.ts
index b36ffab762ac..80e6edb9df68 100644
--- a/clients/client-rds/src/commands/DescribeOptionGroupOptionsCommand.ts
+++ b/clients/client-rds/src/commands/DescribeOptionGroupOptionsCommand.ts
@@ -37,7 +37,7 @@ export interface DescribeOptionGroupOptionsCommandOutput extends OptionGroupOpti
/**
* @public
- *
Describes all available options.
+ *Describes all available options for the specified engine.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DescribeOrderableDBInstanceOptionsCommand.ts b/clients/client-rds/src/commands/DescribeOrderableDBInstanceOptionsCommand.ts index 6d69bf8f4a59..5d710679f6e2 100644 --- a/clients/client-rds/src/commands/DescribeOrderableDBInstanceOptionsCommand.ts +++ b/clients/client-rds/src/commands/DescribeOrderableDBInstanceOptionsCommand.ts @@ -42,7 +42,7 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput /** * @public - *Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
+ *Describes the orderable DB instance options for a specified DB engine.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/ModifyCurrentDBClusterCapacityCommand.ts b/clients/client-rds/src/commands/ModifyCurrentDBClusterCapacityCommand.ts index 99de5091c27b..19d1398e8669 100644 --- a/clients/client-rds/src/commands/ModifyCurrentDBClusterCapacityCommand.ts +++ b/clients/client-rds/src/commands/ModifyCurrentDBClusterCapacityCommand.ts @@ -56,7 +56,7 @@ export interface ModifyCurrentDBClusterCapacityCommandOutput extends DBClusterCa * Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide. * *This action only applies to Aurora Serverless v1 DB clusters.
+ *This operation only applies to Aurora Serverless v1 DB clusters.
*Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
*This action only applies to Aurora DB clusters.
+ *This operation only applies to Aurora DB clusters.
*After you create a DB cluster parameter group, you should wait at least 5 minutes
* before creating your first DB cluster that uses that DB cluster parameter group as the default parameter
- * group. This allows Amazon RDS to fully complete the create action before the parameter
+ * group. This allows Amazon RDS to fully complete the create operation before the parameter
* group is used as the default for a new DB cluster. This is especially important for parameters
* that are critical when creating the default database for a DB cluster, such as the character set
* for the default database defined by the After you modify a DB parameter group, you should wait at least 5 minutes
* before creating your first DB instance that uses that DB parameter group as the default parameter
- * group. This allows Amazon RDS to fully complete the modify action before the parameter
+ * group. This allows Amazon RDS to fully complete the modify operation before the parameter
* group is used as the default for a new DB instance. This is especially important for parameters
* that are critical when creating the default database for a DB instance, such as the character set
* for the default database defined by the Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command
- * doesn't apply to RDS Custom. Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation
+ * doesn't apply to RDS Custom or RDS for Db2.character_set_database parameter. You can use the
diff --git a/clients/client-rds/src/commands/ModifyDBParameterGroupCommand.ts b/clients/client-rds/src/commands/ModifyDBParameterGroupCommand.ts
index c06cc4f7960b..1cabb8e88ef3 100644
--- a/clients/client-rds/src/commands/ModifyDBParameterGroupCommand.ts
+++ b/clients/client-rds/src/commands/ModifyDBParameterGroupCommand.ts
@@ -43,7 +43,7 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
* character_set_database parameter. You can use the
diff --git a/clients/client-rds/src/commands/ModifyDBSnapshotCommand.ts b/clients/client-rds/src/commands/ModifyDBSnapshotCommand.ts
index 16c9136d1183..781c1da8fb7a 100644
--- a/clients/client-rds/src/commands/ModifyDBSnapshotCommand.ts
+++ b/clients/client-rds/src/commands/ModifyDBSnapshotCommand.ts
@@ -41,8 +41,8 @@ export interface ModifyDBSnapshotCommandOutput extends ModifyDBSnapshotResult, _
* or unencrypted, but not shared or public.
*
*
This action only applies to Aurora DB clusters.
+ *This operation only applies to Aurora DB clusters.
*This action only restores the DB cluster, not the DB instances for that DB
- * cluster. You must invoke the CreateDBInstance action to create DB
+ *
This operation only restores the DB cluster, not the DB instances for that DB
+ * cluster. You must invoke the CreateDBInstance operation to create DB
* instances for the restored DB cluster, specifying the identifier of the restored DB
* cluster in DBClusterIdentifier. You can create DB instances only after
- * the RestoreDBClusterFromS3 action has completed and the DB
+ * the RestoreDBClusterFromS3 operation has completed and the DB
* cluster is available.
For more information on Amazon Aurora, see * * What is Amazon Aurora? in the Amazon Aurora User Guide.
*This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
+ *This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
*This action only restores the DB cluster, not the DB instances for that DB
- * cluster. You must invoke the CreateDBInstance action to create DB
+ *
This operation only restores the DB cluster, not the DB instances for that DB
+ * cluster. You must invoke the CreateDBInstance operation to create DB
* instances for the restored DB cluster, specifying the identifier of the restored DB
* cluster in DBClusterIdentifier. You can create DB instances only after
- * the RestoreDBClusterFromSnapshot action has completed and the DB
+ * the RestoreDBClusterFromSnapshot operation has completed and the DB
* cluster is available.
For more information on Amazon Aurora DB clusters, see diff --git a/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts b/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts index b43a4ee6f041..2380087904b5 100644 --- a/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts +++ b/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts @@ -48,11 +48,11 @@ export interface RestoreDBClusterToPointInTimeCommandOutput * source DB cluster with the same configuration as the original DB cluster, except that * the new DB cluster is created with the default DB security group.
*For Aurora, this action only restores the DB cluster, not the DB instances for that DB
- * cluster. You must invoke the CreateDBInstance action to create DB
+ *
For Aurora, this operation only restores the DB cluster, not the DB instances for that DB
+ * cluster. You must invoke the CreateDBInstance operation to create DB
* instances for the restored DB cluster, specifying the identifier of the restored DB
* cluster in DBClusterIdentifier. You can create DB instances only after
- * the RestoreDBClusterToPointInTime action has completed and the DB
+ * the RestoreDBClusterToPointInTime operation has completed and the DB
* cluster is available.
For more information on Amazon Aurora DB clusters, see diff --git a/clients/client-rds/src/commands/RestoreDBInstanceFromDBSnapshotCommand.ts b/clients/client-rds/src/commands/RestoreDBInstanceFromDBSnapshotCommand.ts index ec3b5cd35dd8..5a45fe6f69cc 100644 --- a/clients/client-rds/src/commands/RestoreDBInstanceFromDBSnapshotCommand.ts +++ b/clients/client-rds/src/commands/RestoreDBInstanceFromDBSnapshotCommand.ts @@ -47,9 +47,9 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput * instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group * associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
*If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance
- * before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you
+ * before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances with the same name. After you
* have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as
- * the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original
+ * the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original
* DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
* must be the ARN of the shared DB snapshot.
This command doesn't apply to RDS Custom.
+ *This operation doesn't apply to RDS Custom.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/RestoreDBInstanceToPointInTimeCommand.ts b/clients/client-rds/src/commands/RestoreDBInstanceToPointInTimeCommand.ts index 842ee4c569fd..4ab27d9cb5fe 100644 --- a/clients/client-rds/src/commands/RestoreDBInstanceToPointInTimeCommand.ts +++ b/clients/client-rds/src/commands/RestoreDBInstanceToPointInTimeCommand.ts @@ -50,7 +50,7 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput * option group that is associated with mirroring; in this case, the instance becomes a * mirrored deployment and not a single-AZ deployment. *This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster - * CLI command, or the StopDBCluster action.
+ * CLI command, or theStopDBCluster operation.
* For more information, see * * Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
*This action only applies to Aurora DB clusters.
+ *This operation only applies to Aurora DB clusters.
*Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.
+ *Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation.
For more information, see * * Starting an Amazon RDS DB instance That Was Previously Stopped in the diff --git a/clients/client-rds/src/commands/StartExportTaskCommand.ts b/clients/client-rds/src/commands/StartExportTaskCommand.ts index b44dda4c5097..4be27d8cf365 100644 --- a/clients/client-rds/src/commands/StartExportTaskCommand.ts +++ b/clients/client-rds/src/commands/StartExportTaskCommand.ts @@ -40,7 +40,7 @@ export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBear * @public *
Starts an export of DB snapshot or DB cluster data to Amazon S3. * The provided IAM role must have access to the S3 bucket.
- *You can't export snapshot data from RDS Custom DB instances.
+ *You can't export snapshot data from Db2 or RDS Custom DB instances.
*You can't export cluster data from Multi-AZ DB clusters.
* *For more information, see * * Monitoring Amazon Aurora with Database Activity Streams diff --git a/clients/client-rds/src/commands/StopDBClusterCommand.ts b/clients/client-rds/src/commands/StopDBClusterCommand.ts index 2c9b2e5c319f..90a5d014f806 100644 --- a/clients/client-rds/src/commands/StopDBClusterCommand.ts +++ b/clients/client-rds/src/commands/StopDBClusterCommand.ts @@ -44,7 +44,7 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad * * Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
*This action only applies to Aurora DB clusters.
+ *This operation only applies to Aurora DB clusters.
*Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, - * Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools + * Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools * you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS * automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS * is flexible: you can scale your DB instance's compute resources and storage capacity to meet your diff --git a/clients/client-rds/src/models/models_0.ts b/clients/client-rds/src/models/models_0.ts index 9b1ff1732f95..3a261912c110 100644 --- a/clients/client-rds/src/models/models_0.ts +++ b/clients/client-rds/src/models/models_0.ts @@ -6797,133 +6797,148 @@ export interface CreateDBInstanceMessage { /** * @public *
The meaning of this parameter differs according to the database engine you use.
- *- * MySQL - *
- *The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
- *Constraints:
- *Must contain 1 to 64 letters or numbers.
- *Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
- *Can't be a word reserved by the specified database engine
- *- * MariaDB - *
- *The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
- *Constraints:
- *Must contain 1 to 64 letters or numbers.
- *Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
- *Can't be a word reserved by the specified database engine
- *- * PostgreSQL - *
- *The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres
- * is created in the DB instance.
Constraints:
- *Must contain 1 to 63 letters, numbers, or underscores.
- *Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
- *Can't be a word reserved by the specified database engine
- *- * Oracle - *
- *The Oracle System ID (SID) of the created DB instance. If you don't specify a value,
- * the default value is ORCL. You can't specify the
- * string null, or any other reserved word, for DBName.
Default: ORCL
- *
Constraints:
- *Can't be longer than 8 characters
- *- * Amazon RDS Custom for Oracle - *
- *The Oracle System ID (SID) of the created RDS Custom DB instance.
- * If you don't specify a value, the default value is ORCL for non-CDBs and
- * RDSCDB for CDBs.
Default: ORCL
- *
Constraints:
- *It must contain 1 to 8 alphanumeric characters.
- *It must contain a letter.
- *It can't be a word reserved by the database engine.
- *- * Amazon RDS Custom for SQL Server - *
- *Not applicable. Must be null.
- *- * SQL Server - *
- *Not applicable. Must be null.
- *- * Amazon Aurora MySQL - *
- *The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is - * created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created - * in the DB cluster.
- *Constraints:
- *It must contain 1 to 64 alphanumeric characters.
- *It can't be a word reserved by the database engine.
- *- * Amazon Aurora PostgreSQL - *
- *The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is
- * created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster,
- * a database named postgres is created in the DB cluster.
Constraints:
- *It must contain 1 to 63 alphanumeric characters.
- *It must begin with a letter. - * Subsequent characters can be letters, underscores, or digits - * (0 to 9).
- *It can't be a word reserved by the - * database engine.
- *The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is + * created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created + * in the DB cluster.
+ *Constraints:
+ *Must contain 1 to 64 alphanumeric characters.
+ *Can't be a word reserved by the database engine.
+ *The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is
+ * created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster,
+ * a database named postgres is created in the DB cluster.
Constraints:
+ *It must contain 1 to 63 alphanumeric characters.
+ *Must begin with a letter. Subsequent characters can be letters, underscores, or digits + * (0 to 9).
+ *Can't be a word reserved by the database engine.
+ *The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and
+ * RDSCDB for CDBs.
Default: ORCL
+ *
Constraints:
+ *Must contain 1 to 8 alphanumeric characters.
+ *Must contain a letter.
+ *Can't be a word reserved by the database engine.
+ *Not applicable. Must be null.
+ *The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
+ *Constraints:
+ *Must contain 1 to 64 letters or numbers.
+ *Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ *Can't be a word reserved by the specified database engine.
+ *The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
+ *Constraints:
+ *Must contain 1 to 64 letters or numbers.
+ *Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ *Can't be a word reserved by the specified database engine.
+ *The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
+ *Constraints:
+ *Must contain 1 to 64 letters or numbers.
+ *Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ *Can't be a word reserved by the specified database engine.
+ *The Oracle System ID (SID) of the created DB instance. If you don't specify a value,
+ * the default value is ORCL. You can't specify the
+ * string null, or any other reserved word, for DBName.
Default: ORCL
+ *
Constraints:
+ *Can't be longer than 8 characters.
+ *The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres
+ * is created in the DB instance.
Constraints:
+ *Must contain 1 to 63 letters, numbers, or underscores.
+ *Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ *Can't be a word reserved by the specified database engine.
+ *Not applicable. Must be null.
+ *Constraints to the amount of storage for each storage type are the following:
+ *General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 64000.
+ *Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.
+ *Constraints to the amount of storage for each storage type are the following:
@@ -7118,6 +7145,16 @@ export interface CreateDBInstanceMessage { * *
+ * db2-ae
+ *
+ * db2-se
+ *
* mariadb
*
Length Constraints:
*RDS for Db2 - Must contain from 8 to 255 characters.
+ *RDS for MariaDB - Must contain from 8 to 41 characters.
*Default:
*RDS for Db2 - 50000
+ *
RDS for MariaDB - 3306
*
See RDS Custom for SQL Server general requirements * in the Amazon RDS User Guide.
*For information, see Db2 on Amazon RDS versions in the + * Amazon RDS User Guide.
+ *For information, see MariaDB on Amazon RDS versions in the @@ -7509,6 +7558,10 @@ export interface CreateDBInstanceMessage { *
Valid Values:
*RDS for Db2 - bring-your-own-license
+ *
RDS for MariaDB - general-public-license
*
Constraints:
*For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 + *
For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 * of the storage amount for the DB instance.
*The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL - * Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
+ *The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL + * Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
*For more information, see * Kerberos Authentication in the Amazon RDS User Guide.
*This setting doesn't apply to the following DB instances:
@@ -7890,7 +7943,7 @@ export interface CreateDBInstanceMessage { /** * @public - *The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see + *
The list of log types to enable for exporting to CloudWatch Logs. For more information, see * * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
*This setting doesn't apply to the following DB instances:
@@ -7905,6 +7958,10 @@ export interface CreateDBInstanceMessage { *The following values are valid for each DB engine:
*RDS for Db2 - diag.log | notify.log
+ *
RDS for MariaDB - audit | error | general | slowquery
*
The location for storing automated backups and manual snapshots.
- *Valie Values:
+ *Valid Values:
*@@ -9477,7 +9534,7 @@ export interface CreateDBInstanceReadReplicaMessage { *
Constraints:
*Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB + *
Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB * instance.
*
- * mariadb
+ * db2-ae
+ *
+ * db2-se
*
Specifies the name of the engine that this option group should be associated with.
+ *The name of the engine to associate this option group with.
*Valid Values:
*
+ * db2-ae
+ *
+ * db2-se
+ *
* mariadb
*
+ * db2-ae
+ *
+ * db2-se
+ *
* mariadb
*
+ * db2-ae
+ *
+ * db2-se
+ *
* mariadb10.2
*
A required parameter. Options available for the given engine name are described.
+ *The name of the engine to describe options for.
*Valid Values:
*
+ * db2-ae
+ *
+ * db2-se
+ *
* mariadb
*
Filters the list of option groups to only include groups associated with a specific database engine.
+ *A filter to only include option groups associated with this database engine.
*Valid Values:
*
+ * db2-ae
+ *
+ * db2-se
+ *
* mariadb
*
The name of the engine to retrieve DB instance options for.
+ *The name of the engine to describe DB instance options for.
*Valid Values:
*
+ * db2-ae
+ *
+ * db2-se
+ *
* mariadb
*
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
+ *A filter to include only the available options for the specified engine version.
*/ EngineVersion?: string; /** * @public - *The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
+ *A filter to include only the available options for the specified DB instance class.
*/ DBInstanceClass?: string; /** * @public - *The license model filter value. Specify this parameter to show only the available offerings - * matching the specified license model.
+ *A filter to include only the available options for the specified license model.
*RDS Custom supports only the BYOL licensing model.
*/ LicenseModel?: string; /** * @public - *The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
- *Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
- *This setting doesn't apply to RDS Custom.
+ *The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.
+ *Omit this parameter to show the available options in the specified Amazon Web Services Region.
+ *This setting doesn't apply to RDS Custom DB instances.
*/ AvailabilityZoneGroup?: string; @@ -6847,7 +6896,7 @@ export interface ModifyDBInstanceMessage { /** * @public *The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
- *For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, + *
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, * the value supplied must be at least 10% greater than the current value. * Values that are not at least 10% greater than the existing value are rounded up * so that they are 10% greater than the current value.
@@ -6962,7 +7011,7 @@ export interface ModifyDBInstanceMessage { *PendingModifiedValues element of the operation response.
* Amazon RDS API operations never return the password, - * so this action provides a way to regain access to a primary instance user if the password is lost. + * so this operation provides a way to regain access to a primary instance user if the password is lost. * This includes restoring privileges that might have been accidentally revoked.
*This setting doesn't apply to the following DB instances:
@@ -6982,12 +7031,15 @@ export interface ModifyDBInstanceMessage { *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:
*RDS for Db2 - Must contain from 8 to 255 characters.
+ *RDS for MariaDB - Must contain from 8 to 41 characters.
*Valid Values:
*RDS for Db2 - bring-your-own-license
+ *
RDS for MariaDB - general-public-license
*
The Active Directory directory ID to move the DB instance to.
* Specify none to remove the instance from its current domain.
- * You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL
+ * You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL
* Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see * Kerberos Authentication in the Amazon RDS User Guide.
@@ -7443,6 +7499,10 @@ export interface ModifyDBInstanceMessage { * *RDS for Db2 - 50000
+ *
RDS for MariaDB - 3306
*
Contains the result of a successful invocation of the
- * ModifyDBParameterGroup or ResetDBParameterGroup action.
ModifyDBParameterGroup or ResetDBParameterGroup operation.
*/
export interface DBParameterGroupNameMessage {
/**
@@ -10706,17 +10766,17 @@ export interface RestoreDBClusterToPointInTimeResult {
export interface RestoreDBInstanceFromDBSnapshotMessage {
/**
* @public
- * Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
+ *The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
*Constraints:
*Must contain from 1 to 63 numbers, letters, or hyphens
+ *Must contain from 1 to 63 numbers, letters, 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.
*Example: my-snapshot-id
@@ -10730,7 +10790,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
*
Constraints:
*Must match the identifier of an existing DBSnapshot.
+ *Must match the identifier of an existing DB snapshot.
*Can't be specified when DBClusterSnapshotIdentifier is specified.
The DB subnet group name to use for the new instance.
- *Constraints: If supplied, must match the name of an existing DBSubnetGroup.
+ *The name of the DB subnet group to use for the new instance.
+ *Constraints:
+ *If supplied, must match the name of an existing DB subnet group.
+ *Example: mydbsubnetgroup
*
The database name for the restored DB instance.
- *This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS + *
The name of the database for the restored DB instance.
+ *This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS * Custom DB instances.
*/ DBName?: string; @@ -10842,6 +10907,16 @@ export interface RestoreDBInstanceFromDBSnapshotMessage { *
+ * db2-ae
+ *
+ * db2-se
+ *
* mariadb
*
Specify the Active Directory directory ID to restore the DB instance in. - * The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL - * Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
+ *The Active Directory directory ID to restore the DB instance in. + * The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL + * Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
*For more information, see * Kerberos Authentication in the Amazon RDS User Guide.
*This setting doesn't apply to RDS Custom.
@@ -11067,8 +11142,8 @@ export interface RestoreDBInstanceFromDBSnapshotMessage { /** * @public - *The list of logs that the restored DB instance is to export to CloudWatch Logs. The values - * in the list depend on the DB engine being used. For more information, see + *
The list of logs for the restored DB instance to export to CloudWatch Logs. The values + * in the list depend on the DB engine. For more information, see * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
*This setting doesn't apply to RDS Custom.
*/ @@ -11098,7 +11173,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage { *Constraints:
*If supplied, must match the name of an existing DBParameterGroup.
+ *If supplied, must match the name of an existing DB parameter group.
*Must be 1 to 255 letters, numbers, or hyphens.
@@ -11351,29 +11426,37 @@ export interface RestoreDBInstanceFromS3Message { /** * @public - *The password for the master user. - * The password can include any printable ASCII character except "/", """, or "@".
- *Constraints: Can't be specified if ManageMasterUserPassword is turned on.
- * MariaDB - *
- *Constraints: Must contain from 8 to 41 characters.
- *- * Microsoft SQL Server - *
- *Constraints: Must contain from 8 to 128 characters.
- *- * MySQL - *
- *Constraints: Must contain from 8 to 41 characters.
- *- * Oracle - *
- *Constraints: Must contain from 8 to 30 characters.
- *- * PostgreSQL - *
- *Constraints: Must contain from 8 to 128 characters.
+ *The password for the master user.
+ *Constraints:
+ *Can't be specified if ManageMasterUserPassword is turned on.
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 Db2 - Must contain from 8 to 128 characters.
+ *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 database name for the restored DB instance.
- *This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
- *This parameter doesn't apply to the following DB instances:
+ *RDS Custom
+ *RDS for Db2
+ *RDS for MariaDB
+ *RDS for MySQL
+ *
+ * db2-ae
+ *
+ * db2-se
+ *
* mariadb
*
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
- *Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
The location for storing automated backups and manual snapshots for the restored DB instance.
+ *Valid Values:
+ *
+ * outposts (Amazon Web Services Outposts)
+ * region (Amazon Web Services Region)
Default: region
+ *
For more information, see Working * with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
*/ diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 9031fe2d37e9..0e03aefec3a3 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -929,7 +929,7 @@ "name": "rds" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.
\nAmazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.
\nThis interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.
\n\n Amazon RDS API Reference\n
\nFor the alphabetical list of API actions, see \n API Actions.
\nFor the alphabetical list of data types, see \n Data Types.
\nFor a list of common query parameters, see \n Common Parameters.
\nFor descriptions of the error codes, see \n Common Errors.
\n\n Amazon RDS User Guide\n
\nFor a summary of the Amazon RDS interfaces, see \n Available RDS Interfaces.
\nFor more information about how to use the Query API, see \n Using the Query API.
\nAmazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.
\nAmazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.
\nThis interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.
\n\n Amazon RDS API Reference\n
\nFor the alphabetical list of API actions, see \n API Actions.
\nFor the alphabetical list of data types, see \n Data Types.
\nFor a list of common query parameters, see \n Common Parameters.
\nFor descriptions of the error codes, see \n Common Errors.
\n\n Amazon RDS User Guide\n
\nFor a summary of the Amazon RDS interfaces, see \n Available RDS Interfaces.
\nFor more information about how to use the Query API, see \n Using the Query API.
\nThe meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance. If you don't specify a value, \n the default value is ORCL. You can't specify the \n string null, or any other reserved word, for DBName.
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n Amazon RDS Custom for Oracle\n
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL for non-CDBs and\n RDSCDB for CDBs.
Default: ORCL\n
Constraints:
\nIt must contain 1 to 8 alphanumeric characters.
\nIt must contain a letter.
\nIt can't be a word reserved by the database engine.
\n\n Amazon RDS Custom for SQL Server\n
\nNot applicable. Must be null.
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe meaning of this parameter differs according to the database engine you use.
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nMust contain 1 to 64 alphanumeric characters.
\nCan't be a word reserved by the database engine.
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nCan't be a word reserved by the database engine.
\nThe Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and\n RDSCDB for CDBs.
Default: ORCL\n
Constraints:
\nMust contain 1 to 8 alphanumeric characters.
\nMust contain a letter.
\nCan't be a word reserved by the database engine.
\nNot applicable. Must be null.
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine.
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine.
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine.
\nThe Oracle System ID (SID) of the created DB instance. If you don't specify a value, \n the default value is ORCL. You can't specify the \n string null, or any other reserved word, for DBName.
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters.
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine.
\nNot applicable. Must be null.
\nThe amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nThis setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3):
\nEnterprise and Standard editions: Must be an integer from 20 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 100 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 20 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nThis setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 64000.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 64000.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\nConstraints to the amount of storage for each storage type are the following:
\nGeneral Purpose (SSD) storage (gp2, gp3):
\nEnterprise and Standard editions: Must be an integer from 20 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 100 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 20 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe database engine to use for this DB instance.
\nNot every database engine is available in every Amazon Web Services Region.
\nValid Values:
\n\n aurora-mysql (for Aurora MySQL DB instances)
\n aurora-postgresql (for Aurora PostgreSQL DB instances)
\n custom-oracle-ee (for RDS Custom for Oracle DB instances)
\n custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
\n custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to use for this DB instance.
\nNot every database engine is available in every Amazon Web Services Region.
\nValid Values:
\n\n aurora-mysql (for Aurora MySQL DB instances)
\n aurora-postgresql (for Aurora PostgreSQL DB instances)
\n custom-oracle-ee (for RDS Custom for Oracle DB instances)
\n custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
\n custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
\n custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The password for the master user.
\nThis setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.
\nConstraints:
\nCan't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.
\nLength Constraints:
\nRDS for MariaDB - Must contain from 8 to 41 characters.
\nRDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
\nRDS for MySQL - Must contain from 8 to 41 characters.
\nRDS for Oracle - Must contain from 8 to 30 characters.
\nRDS for PostgreSQL - Must contain from 8 to 128 characters.
\nThe password for the master user.
\nThis setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.
\nConstraints:
\nCan't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.
\nLength Constraints:
\nRDS for Db2 - Must contain from 8 to 255 characters.
\nRDS for MariaDB - Must contain from 8 to 41 characters.
\nRDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
\nRDS for MySQL - Must contain from 8 to 41 characters.
\nRDS for Oracle - Must contain from 8 to 30 characters.
\nRDS for PostgreSQL - Must contain from 8 to 128 characters.
\nThe port number on which the database accepts connections.
\nThis setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
\nValid Values: 1150-65535\n
Default:
\nRDS for MariaDB - 3306\n
RDS for Microsoft SQL Server - 1433\n
RDS for MySQL - 3306\n
RDS for Oracle - 1521\n
RDS for PostgreSQL - 5432\n
Constraints:
\nFor RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.
The port number on which the database accepts connections.
\nThis setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
\nValid Values: 1150-65535\n
Default:
\nRDS for Db2 - 50000\n
RDS for MariaDB - 3306\n
RDS for Microsoft SQL Server - 1433\n
RDS for MySQL - 3306\n
RDS for Oracle - 1521\n
RDS for PostgreSQL - 5432\n
Constraints:
\nFor RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.
The version number of the database engine to use.
\nThis setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB\n instance uses is managed by the DB cluster.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions\n operation.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.
\nFor information, see MariaDB on Amazon RDS versions in the \n Amazon RDS User Guide.
\nFor information, see Microsoft SQL Server versions on Amazon RDS in the \n Amazon RDS User Guide.
\nFor information, see MySQL on Amazon RDS versions in the \n Amazon RDS User Guide.
\nFor information, see Oracle Database Engine release notes in the \n Amazon RDS User Guide.
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.
\nThe version number of the database engine to use.
\nThis setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB\n instance uses is managed by the DB cluster.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions\n operation.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.
\nFor information, see Db2 on Amazon RDS versions in the \n Amazon RDS User Guide.
\nFor information, see MariaDB on Amazon RDS versions in the \n Amazon RDS User Guide.
\nFor information, see Microsoft SQL Server versions on Amazon RDS in the \n Amazon RDS User Guide.
\nFor information, see MySQL on Amazon RDS versions in the \n Amazon RDS User Guide.
\nFor information, see Oracle Database Engine release notes in the \n Amazon RDS User Guide.
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.
\nThe license model information for this DB instance.
\nThis setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
\nValid Values:
\nRDS for MariaDB - general-public-license\n
RDS for Microsoft SQL Server - license-included\n
RDS for MySQL - general-public-license\n
RDS for Oracle - bring-your-own-license | license-included\n
RDS for PostgreSQL - postgresql-license\n
The license model information for this DB instance.
\nThis setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
\nValid Values:
\nRDS for Db2 - bring-your-own-license\n
RDS for MariaDB - general-public-license\n
RDS for Microsoft SQL Server - license-included\n
RDS for MySQL - general-public-license\n
RDS for Oracle - bring-your-own-license | license-included\n
RDS for PostgreSQL - postgresql-license\n
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
\nConstraints:
\nFor RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 \n of the storage amount for the DB instance.
\nFor RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
\nThe amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
\nConstraints:
\nFor RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 \n of the storage amount for the DB instance.
\nFor RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
\nThe Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL \n Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (The domain is managed by the DB cluster.)
\nRDS Custom
\nThe Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (The domain is managed by the DB cluster.)
\nRDS Custom
\nThe list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
\nRDS Custom
\nThe following values are valid for each DB engine:
\nRDS for MariaDB - audit | error | general | slowquery\n
RDS for Microsoft SQL Server - agent | error\n
RDS for MySQL - audit | error | general | slowquery\n
RDS for Oracle - alert | audit | listener | trace | oemagent\n
RDS for PostgreSQL - postgresql | upgrade\n
The list of log types to enable for exporting to CloudWatch Logs. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
\nRDS Custom
\nThe following values are valid for each DB engine:
\nRDS for Db2 - diag.log | notify.log\n
RDS for MariaDB - audit | error | general | slowquery\n
RDS for Microsoft SQL Server - agent | error\n
RDS for MySQL - audit | error | general | slowquery\n
RDS for Oracle - alert | audit | listener | trace | oemagent\n
RDS for PostgreSQL - postgresql | upgrade\n
The location for storing automated backups and manual snapshots.
\nValie Values:
\n\n outposts (Amazon Web Services Outposts)
\n region (Amazon Web Services Region)
Default: region\n
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The location for storing automated backups and manual snapshots.
\nValid Values:
\n\n outposts (Amazon Web Services Outposts)
\n region (Amazon Web Services Region)
Default: region\n
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" } }, "NetworkType": { @@ -5201,7 +5201,7 @@ } ], "traits": { - "smithy.api#documentation": "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.
\nAmazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance\n operation.
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.
\nYour source DB instance or cluster must have backup retention enabled.
\nCreates 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 Db2, MariaDB, MySQL, 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.
\nAmazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance\n operation.
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.
\nYour source DB instance or cluster must have backup retention enabled.
\nThe identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL\n Server, which can have up to five.
\nConstraints:
\nMust be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.
\nCan't be specified if the SourceDBClusterIdentifier parameter is\n also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the\n Amazon RDS User Guide.
\nFor the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
\nThe specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.
\nIf the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.
\nIf the source DB instance is in a different Amazon Web Services Region from the read\n replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User\n Guide. This doesn't apply to SQL Server or RDS Custom, which\n don't support cross-Region replicas.
\nThe identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL\n Server, which can have up to five.
\nConstraints:
\nMust be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB\n instance.
\nCan't be specified if the SourceDBClusterIdentifier parameter is\n also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the\n Amazon RDS User Guide.
\nFor the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
\nThe specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.
\nIf the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.
\nIf the source DB instance is in a different Amazon Web Services Region from the read\n replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User\n Guide. This doesn't apply to SQL Server or RDS Custom, which\n don't support cross-Region replicas.
\nThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
\nTo list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
\nTo list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n db2-ae\n
\n db2-se\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Specifies the name of the engine that this option group should be associated with.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the engine to associate this option group with.
\nValid Values:
\n\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.
Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup operation.
The database engine to return version details for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to return version details for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the DB parameter group family.
\nValid Values:
\n\n aurora-mysql5.7\n
\n aurora-mysql8.0\n
\n aurora-postgresql10\n
\n aurora-postgresql11\n
\n aurora-postgresql12\n
\n aurora-postgresql13\n
\n aurora-postgresql14\n
\n custom-oracle-ee-19\n
\n mariadb10.2\n
\n mariadb10.3\n
\n mariadb10.4\n
\n mariadb10.5\n
\n mariadb10.6\n
\n mysql5.7\n
\n mysql8.0\n
\n oracle-ee-19\n
\n oracle-ee-cdb-19\n
\n oracle-ee-cdb-21\n
\n oracle-se2-19\n
\n oracle-se2-cdb-19\n
\n oracle-se2-cdb-21\n
\n postgres10\n
\n postgres11\n
\n postgres12\n
\n postgres13\n
\n postgres14\n
\n sqlserver-ee-11.0\n
\n sqlserver-ee-12.0\n
\n sqlserver-ee-13.0\n
\n sqlserver-ee-14.0\n
\n sqlserver-ee-15.0\n
\n sqlserver-ex-11.0\n
\n sqlserver-ex-12.0\n
\n sqlserver-ex-13.0\n
\n sqlserver-ex-14.0\n
\n sqlserver-ex-15.0\n
\n sqlserver-se-11.0\n
\n sqlserver-se-12.0\n
\n sqlserver-se-13.0\n
\n sqlserver-se-14.0\n
\n sqlserver-se-15.0\n
\n sqlserver-web-11.0\n
\n sqlserver-web-12.0\n
\n sqlserver-web-13.0\n
\n sqlserver-web-14.0\n
\n sqlserver-web-15.0\n
The name of the DB parameter group family.
\nValid Values:
\n\n aurora-mysql5.7\n
\n aurora-mysql8.0\n
\n aurora-postgresql10\n
\n aurora-postgresql11\n
\n aurora-postgresql12\n
\n aurora-postgresql13\n
\n aurora-postgresql14\n
\n custom-oracle-ee-19\n
\n db2-ae\n
\n db2-se\n
\n mariadb10.2\n
\n mariadb10.3\n
\n mariadb10.4\n
\n mariadb10.5\n
\n mariadb10.6\n
\n mysql5.7\n
\n mysql8.0\n
\n oracle-ee-19\n
\n oracle-ee-cdb-19\n
\n oracle-ee-cdb-21\n
\n oracle-se2-19\n
\n oracle-se2-cdb-19\n
\n oracle-se2-cdb-21\n
\n postgres10\n
\n postgres11\n
\n postgres12\n
\n postgres13\n
\n postgres14\n
\n sqlserver-ee-11.0\n
\n sqlserver-ee-12.0\n
\n sqlserver-ee-13.0\n
\n sqlserver-ee-14.0\n
\n sqlserver-ee-15.0\n
\n sqlserver-ex-11.0\n
\n sqlserver-ex-12.0\n
\n sqlserver-ex-13.0\n
\n sqlserver-ex-14.0\n
\n sqlserver-ex-15.0\n
\n sqlserver-se-11.0\n
\n sqlserver-se-12.0\n
\n sqlserver-se-13.0\n
\n sqlserver-se-14.0\n
\n sqlserver-se-15.0\n
\n sqlserver-web-11.0\n
\n sqlserver-web-12.0\n
\n sqlserver-web-13.0\n
\n sqlserver-web-14.0\n
\n sqlserver-web-15.0\n
Describes all available options.
", + "smithy.api#documentation": "Describes all available options for the specified engine.
", "smithy.api#examples": [ { "title": "To describe all available options", @@ -16288,7 +16288,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A required parameter. Options available for the given engine name are described.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the engine to describe options for.
\nValid Values:
\n\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Filters the list of option groups to only include groups associated with a specific database engine.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
A filter to only include option groups associated with this database engine.
\nValid Values:
\n\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
", + "smithy.api#documentation": "Describes the orderable DB instance options for a specified DB engine.
", "smithy.api#examples": [ { "title": "To describe orderable DB instance options", @@ -16482,32 +16482,32 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the engine to retrieve DB instance options for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the engine to describe DB instance options for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
" + "smithy.api#documentation": "A filter to include only the available options for the specified engine version.
" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
" + "smithy.api#documentation": "A filter to include only the available options for the specified DB instance class.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.
\nRDS Custom supports only the BYOL licensing model.
" + "smithy.api#documentation": "A filter to include only the available options for the specified license model.
\nRDS Custom supports only the BYOL licensing model.
" } }, "AvailabilityZoneGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
\nOmit this parameter to show the available offerings in the specified Amazon Web Services Region.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.
\nOmit this parameter to show the available options in the specified Amazon Web Services Region.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "Vpc": { @@ -19847,7 +19847,7 @@ } ], "traits": { - "smithy.api#documentation": "Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
\nAurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.
\nFor more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nIf you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This action only applies to Aurora Serverless v1 DB clusters.
\nSet the capacity of an Aurora Serverless v1 DB cluster to a specific value.
\nAurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.
\nFor more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.
\nIf you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This operation only applies to Aurora Serverless v1 DB clusters.
\nModifies the properties of an endpoint in an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nModifies the properties of an endpoint in an Amazon Aurora DB cluster.
\nThis operation only applies to Aurora DB clusters.
\nModifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", + "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create operation before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", "smithy.api#examples": [ { "title": "To modify parameters in a DB cluster parameter group", @@ -20740,7 +20740,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nFor RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.
\nFor the valid values for allocated storage for each engine,\n see CreateDBInstance.
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nFor RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.
\nFor the valid values for allocated storage for each engine,\n see CreateDBInstance.
The new password for the master user.
\nChanging this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.
Amazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.)
RDS Custom
\nDefault: Uses existing setting
\nConstraints:
\nCan't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\nLength Constraints:
\nRDS for MariaDB - Must contain from 8 to 41 characters.
\nRDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
\nRDS for MySQL - Must contain from 8 to 41 characters.
\nRDS for Oracle - Must contain from 8 to 30 characters.
\nRDS for PostgreSQL - Must contain from 8 to 128 characters.
\nThe new password for the master user.
\nChanging this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.
Amazon RDS API operations never return the password, \n so this operation provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.
\nThis setting doesn't apply to the following DB instances:
\nAmazon Aurora (The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.)
RDS Custom
\nDefault: Uses existing setting
\nConstraints:
\nCan't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.
\nLength Constraints:
\nRDS for Db2 - Must contain from 8 to 255 characters.
\nRDS for MariaDB - Must contain from 8 to 41 characters.
\nRDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
\nRDS for MySQL - Must contain from 8 to 41 characters.
\nRDS for Oracle - Must contain from 8 to 30 characters.
\nRDS for PostgreSQL - Must contain from 8 to 128 characters.
\nThe license model for the DB instance.
\nThis setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
\nValid Values:
\nRDS for MariaDB - general-public-license\n
RDS for Microsoft SQL Server - license-included\n
RDS for MySQL - general-public-license\n
RDS for Oracle - bring-your-own-license | license-included\n
RDS for PostgreSQL - postgresql-license\n
The license model for the DB instance.
\nThis setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
\nValid Values:
\nRDS for Db2 - bring-your-own-license\n
RDS for MariaDB - general-public-license\n
RDS for Microsoft SQL Server - license-included\n
RDS for MySQL - general-public-license\n
RDS for Oracle - bring-your-own-license | license-included\n
RDS for PostgreSQL - postgresql-license\n
The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" + "smithy.api#documentation": "The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "DomainFqdn": { @@ -20920,7 +20920,7 @@ "DBPortNumber": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the database accepts connections.
\nThe value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom DB instances.
\nValid Values: 1150-65535\n
Default:
\nAmazon Aurora - 3306\n
RDS for MariaDB - 3306\n
RDS for Microsoft SQL Server - 1433\n
RDS for MySQL - 3306\n
RDS for Oracle - 1521\n
RDS for PostgreSQL - 5432\n
Constraints:
\nFor RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.
The port number on which the database accepts connections.
\nThe value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom DB instances.
\nValid Values: 1150-65535\n
Default:
\nAmazon Aurora - 3306\n
RDS for Db2 - 50000\n
RDS for MariaDB - 3306\n
RDS for Microsoft SQL Server - 1433\n
RDS for MySQL - 3306\n
RDS for Oracle - 1521\n
RDS for PostgreSQL - 5432\n
Constraints:
\nFor RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.
Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify operation before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n
\nAmazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.
", + "smithy.api#documentation": "Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n
\nAmazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation\n doesn't apply to RDS Custom or RDS for Db2.
", "smithy.api#examples": [ { "title": "To modify a DB snapshot", @@ -23984,7 +23984,7 @@ } ], "traits": { - "smithy.api#documentation": "Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.
\nThis action only applies to Aurora DB clusters.
\nDetaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.
\nThis operation only applies to Aurora DB clusters.
\nCreates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters. The source DB engine must be MySQL.
\nCreates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.
\nThis operation only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance operation to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 operation has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nThis operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
\nCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
\nThe target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", + "smithy.api#documentation": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
\nThe target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.
\nThis operation only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance operation to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot operation has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", "smithy.api#examples": [ { "title": "To restore a DB cluster from a snapshot", @@ -25556,7 +25556,7 @@ } ], "traits": { - "smithy.api#documentation": "Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.
For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", + "smithy.api#documentation": "Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.
For Aurora, this operation only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance operation to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime operation has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n
", "smithy.api#examples": [ { "title": "To restore a DB cluster to a specified time", @@ -25884,7 +25884,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
\nIf you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.
\nIf you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
\nIf you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 numbers, letters, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 numbers, letters, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-snapshot-id\n
The identifier for the DB snapshot to restore from.
\nConstraints:
\nMust match the identifier of an existing DBSnapshot.
\nCan't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
The identifier for the DB snapshot to restore from.
\nConstraints:
\nMust match the identifier of an existing DB snapshot.
\nCan't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.
The DB subnet group name to use for the new instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
The name of the DB subnet group to use for the new instance.
\nConstraints:
\nIf supplied, must match the name of an existing DB subnet group.
\nExample: mydbsubnetgroup\n
The database name for the restored DB instance.
\nThis parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.
" + "smithy.api#documentation": "The name of the database for the restored DB instance.
\nThis parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS\n Custom DB instances.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
\nValid Values:
\n\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "DomainFqdn": { @@ -26085,7 +26085,7 @@ "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored 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 Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The list of logs for the restored DB instance to export to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "ProcessorFeatures": { @@ -26103,7 +26103,7 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DB parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nAmazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n
\nThis operation doesn't apply to RDS Custom.
" } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { @@ -26293,7 +26293,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Can't be specified if ManageMasterUserPassword is turned on.
\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
" + "smithy.api#documentation": "The password for the master user.
\nConstraints:
\nCan't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.
\nLength Constraints:
\nRDS for Db2 - Must contain from 8 to 128 characters.
\nRDS for MariaDB - Must contain from 8 to 41 characters.
\nRDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
\nRDS for MySQL - Must contain from 8 to 41 characters.
\nRDS for Oracle - Must contain from 8 to 30 characters.
\nRDS for PostgreSQL - Must contain from 8 to 128 characters.
\nRestores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.
\nThis command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.
\nThis operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
The database name for the restored DB instance.
\nThis parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
\nThe database name for the restored DB instance.
\nThis parameter doesn't apply to the following DB instances:
\nRDS Custom
\nRDS for Db2
\nRDS for MariaDB
\nRDS for MySQL
\nThe database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Default: The same as source
\nConstraints:
\nMust be compatible with the engine of the source.
\nThe database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nValid Values:
\n\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Default: The same as source
\nConstraints:
\nMust be compatible with the engine of the source.
\nSpecifies where automated backups and manual snapshots are stored for the restored DB instance.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The location for storing automated backups and manual snapshots for the restored DB instance.
\nValid Values:
\n\n outposts (Amazon Web Services Outposts)
\n region (Amazon Web Services Region)
Default: region\n
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" } }, "NetworkType": { @@ -27708,7 +27708,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.
\nFor more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nStarts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster operation.
For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
\nThis operation only applies to Aurora DB clusters.
\nStarts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.
\nFor more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation.
For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.
Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nYou can't export snapshot data from RDS Custom DB instances.
\nYou can't export cluster data from Multi-AZ DB clusters.
\nFor more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
\nFor more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.
", + "smithy.api#documentation": "Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nYou can't export snapshot data from Db2 or RDS Custom DB instances.
\nYou can't export cluster data from Multi-AZ DB clusters.
\nFor more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
\nFor more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.
", "smithy.api#examples": [ { "title": "To export a snapshot to Amazon S3", @@ -28105,7 +28105,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.
For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.
", + "smithy.api#documentation": "Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream operation.
For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.
", "smithy.api#examples": [ { "title": "To stop a database activity stream", @@ -28191,7 +28191,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.
\nFor more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nStops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.
\nFor more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
\nThis operation only applies to Aurora DB clusters.
\n