@aws-sdk/client-rds 3.458.0 → 3.460.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/README.md +1 -1
  2. package/dist-types/RDS.d.ts +1 -1
  3. package/dist-types/RDSClient.d.ts +1 -1
  4. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +1 -1
  5. package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +1 -1
  6. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +1 -1
  7. package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +1 -1
  8. package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +1 -1
  9. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +1 -1
  10. package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +1 -1
  11. package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +2 -2
  12. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +1 -1
  13. package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +4 -4
  14. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +3 -3
  15. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +3 -3
  16. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +2 -2
  17. package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +1 -1
  18. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +1 -1
  19. package/dist-types/commands/StartDBClusterCommand.d.ts +2 -2
  20. package/dist-types/commands/StartDBInstanceCommand.d.ts +1 -1
  21. package/dist-types/commands/StartExportTaskCommand.d.ts +1 -1
  22. package/dist-types/commands/StopActivityStreamCommand.d.ts +1 -1
  23. package/dist-types/commands/StopDBClusterCommand.d.ts +1 -1
  24. package/dist-types/index.d.ts +1 -1
  25. package/dist-types/models/models_0.d.ts +207 -135
  26. package/dist-types/models/models_1.d.ts +175 -58
  27. package/package.json +13 -13
package/README.md CHANGED
@@ -14,7 +14,7 @@ scale a relational database in the cloud. It provides cost-efficient, resizeable
14
14
  database and manages common database administration tasks, freeing up developers to focus on what makes their applications
15
15
  and businesses unique.</p>
16
16
  <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
17
- Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
17
+ Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
18
18
  you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS
19
19
  automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS
20
20
  is flexible: you can scale your DB instance's compute resources and storage capacity to meet your
@@ -1075,7 +1075,7 @@ export interface RDS {
1075
1075
  * database and manages common database administration tasks, freeing up developers to focus on what makes their applications
1076
1076
  * and businesses unique.</p>
1077
1077
  * <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
1078
- * Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
1078
+ * Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
1079
1079
  * you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS
1080
1080
  * automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS
1081
1081
  * is flexible: you can scale your DB instance's compute resources and storage capacity to meet your
@@ -311,7 +311,7 @@ export interface RDSClientResolvedConfig extends RDSClientResolvedConfigType {
311
311
  * database and manages common database administration tasks, freeing up developers to focus on what makes their applications
312
312
  * and businesses unique.</p>
313
313
  * <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
314
- * Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
314
+ * Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
315
315
  * you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS
316
316
  * automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS
317
317
  * is flexible: you can scale your DB instance's compute resources and storage capacity to meet your
@@ -25,7 +25,7 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
25
25
  * @public
26
26
  * <p>Creates a new DB instance that acts as a read replica for an existing source DB
27
27
  * instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running
28
- * MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
28
+ * Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
29
29
  * Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working
30
30
  * with read replicas</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica">Migrating from a Multi-AZ DB cluster to a DB instance using a read replica</a> in the <i>Amazon RDS User Guide</i>.</p>
31
31
  * <p>Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the <code>CreateDBInstance</code>
@@ -23,7 +23,7 @@ export interface DescribeOptionGroupOptionsCommandOutput extends OptionGroupOpti
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Describes all available options.</p>
26
+ * <p>Describes all available options for the specified engine.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
@@ -23,7 +23,7 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput extends Orderab
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.</p>
26
+ * <p>Describes the orderable DB instance options for a specified DB engine.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
@@ -39,7 +39,7 @@ export interface ModifyCurrentDBClusterCapacityCommandOutput extends DBClusterCa
39
39
  * Autoscaling for Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p>
40
40
  * </important>
41
41
  * <note>
42
- * <p>This action only applies to Aurora Serverless v1 DB clusters.</p>
42
+ * <p>This operation only applies to Aurora Serverless v1 DB clusters.</p>
43
43
  * </note>
44
44
  * @example
45
45
  * Use a bare-bones client and the command you need to make an API call.
@@ -26,7 +26,7 @@ export interface ModifyDBClusterEndpointCommandOutput extends DBClusterEndpoint,
26
26
  * @public
27
27
  * <p>Modifies the properties of an endpoint in an Amazon Aurora DB cluster.</p>
28
28
  * <note>
29
- * <p>This action only applies to Aurora DB clusters.</p>
29
+ * <p>This operation only applies to Aurora DB clusters.</p>
30
30
  * </note>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -30,7 +30,7 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
30
30
  * <important>
31
31
  * <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
32
32
  * before creating your first DB cluster that uses that DB cluster parameter group as the default parameter
33
- * group. This allows Amazon RDS to fully complete the create action before the parameter
33
+ * group. This allows Amazon RDS to fully complete the create operation before the parameter
34
34
  * group is used as the default for a new DB cluster. This is especially important for parameters
35
35
  * that are critical when creating the default database for a DB cluster, such as the character set
36
36
  * for the default database defined by the <code>character_set_database</code> parameter. You can use the
@@ -29,7 +29,7 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
29
29
  * <important>
30
30
  * <p>After you modify a DB parameter group, you should wait at least 5 minutes
31
31
  * before creating your first DB instance that uses that DB parameter group as the default parameter
32
- * group. This allows Amazon RDS to fully complete the modify action before the parameter
32
+ * group. This allows Amazon RDS to fully complete the modify operation before the parameter
33
33
  * group is used as the default for a new DB instance. This is especially important for parameters
34
34
  * that are critical when creating the default database for a DB instance, such as the character set
35
35
  * for the default database defined by the <code>character_set_database</code> parameter. You can use the
@@ -27,8 +27,8 @@ export interface ModifyDBSnapshotCommandOutput extends ModifyDBSnapshotResult, _
27
27
  * or unencrypted, but not shared or public.
28
28
  *
29
29
  * </p>
30
- * <p>Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command
31
- * doesn't apply to RDS Custom.</p>
30
+ * <p>Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation
31
+ * doesn't apply to RDS Custom or RDS for Db2.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,7 +27,7 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl
27
27
  * standalone cluster with read-write capability instead of being read-only and receiving data from a
28
28
  * primary cluster in a different Region.</p>
29
29
  * <note>
30
- * <p>This action only applies to Aurora DB clusters.</p>
30
+ * <p>This operation only applies to Aurora DB clusters.</p>
31
31
  * </note>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
@@ -28,18 +28,18 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro
28
28
  * created using the Percona XtraBackup utility as described in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3"> Migrating Data from MySQL by Using an Amazon S3 Bucket</a> in the
29
29
  * <i>Amazon Aurora User Guide</i>.</p>
30
30
  * <note>
31
- * <p>This action only restores the DB cluster, not the DB instances for that DB
32
- * cluster. You must invoke the <code>CreateDBInstance</code> action to create DB
31
+ * <p>This operation only restores the DB cluster, not the DB instances for that DB
32
+ * cluster. You must invoke the <code>CreateDBInstance</code> operation to create DB
33
33
  * instances for the restored DB cluster, specifying the identifier of the restored DB
34
34
  * cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after
35
- * the <code>RestoreDBClusterFromS3</code> action has completed and the DB
35
+ * the <code>RestoreDBClusterFromS3</code> operation has completed and the DB
36
36
  * cluster is available.</p>
37
37
  * </note>
38
38
  * <p>For more information on Amazon Aurora, see
39
39
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
40
40
  * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
41
41
  * <note>
42
- * <p>This action only applies to Aurora DB clusters. The source DB engine must be MySQL.</p>
42
+ * <p>This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.</p>
43
43
  * </note>
44
44
  * @example
45
45
  * Use a bare-bones client and the command you need to make an API call.
@@ -28,11 +28,11 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
28
28
  * configuration. If you don't specify a security group, the new DB cluster is
29
29
  * associated with the default security group.</p>
30
30
  * <note>
31
- * <p>This action only restores the DB cluster, not the DB instances for that DB
32
- * cluster. You must invoke the <code>CreateDBInstance</code> action to create DB
31
+ * <p>This operation only restores the DB cluster, not the DB instances for that DB
32
+ * cluster. You must invoke the <code>CreateDBInstance</code> operation to create DB
33
33
  * instances for the restored DB cluster, specifying the identifier of the restored DB
34
34
  * cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after
35
- * the <code>RestoreDBClusterFromSnapshot</code> action has completed and the DB
35
+ * the <code>RestoreDBClusterFromSnapshot</code> operation has completed and the DB
36
36
  * cluster is available.</p>
37
37
  * </note>
38
38
  * <p>For more information on Amazon Aurora DB clusters, see
@@ -29,11 +29,11 @@ export interface RestoreDBClusterToPointInTimeCommandOutput extends RestoreDBClu
29
29
  * source DB cluster with the same configuration as the original DB cluster, except that
30
30
  * the new DB cluster is created with the default DB security group.</p>
31
31
  * <note>
32
- * <p>For Aurora, this action only restores the DB cluster, not the DB instances for that DB
33
- * cluster. You must invoke the <code>CreateDBInstance</code> action to create DB
32
+ * <p>For Aurora, this operation only restores the DB cluster, not the DB instances for that DB
33
+ * cluster. You must invoke the <code>CreateDBInstance</code> operation to create DB
34
34
  * instances for the restored DB cluster, specifying the identifier of the restored DB
35
35
  * cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after
36
- * the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB
36
+ * the <code>RestoreDBClusterToPointInTime</code> operation has completed and the DB
37
37
  * cluster is available.</p>
38
38
  * </note>
39
39
  * <p>For more information on Amazon Aurora DB clusters, see
@@ -28,9 +28,9 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput extends RestoreDBI
28
28
  * instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group
29
29
  * associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.</p>
30
30
  * <p>If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance
31
- * before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you
31
+ * before you call the <code>RestoreDBInstanceFromDBSnapshot</code> operation. RDS doesn't allow two DB instances with the same name. After you
32
32
  * have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as
33
- * the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original
33
+ * the <code>DBInstanceIdentifier</code> in the call to the <code>RestoreDBInstanceFromDBSnapshot</code> operation. The result is that you replace the original
34
34
  * DB instance with the DB instance created from the snapshot.</p>
35
35
  * <p>If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code>
36
36
  * must be the ARN of the shared DB snapshot.</p>
@@ -31,7 +31,7 @@ export interface RestoreDBInstanceFromS3CommandOutput extends RestoreDBInstanceF
31
31
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html">Importing Data into an Amazon RDS MySQL DB Instance</a>
32
32
  * in the <i>Amazon RDS User Guide.</i>
33
33
  * </p>
34
- * <p>This command doesn't apply to RDS Custom.</p>
34
+ * <p>This operation doesn't apply to RDS Custom.</p>
35
35
  * @example
36
36
  * Use a bare-bones client and the command you need to make an API call.
37
37
  * ```javascript
@@ -31,7 +31,7 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput extends RestoreDBIn
31
31
  * option group that is associated with mirroring; in this case, the instance becomes a
32
32
  * mirrored deployment and not a single-AZ deployment.</p>
33
33
  * <note>
34
- * <p>This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <code>RestoreDBClusterToPointInTime</code>.</p>
34
+ * <p>This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <code>RestoreDBClusterToPointInTime</code>.</p>
35
35
  * </note>
36
36
  * @example
37
37
  * Use a bare-bones client and the command you need to make an API call.
@@ -24,12 +24,12 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met
24
24
  /**
25
25
  * @public
26
26
  * <p>Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster
27
- * CLI command, or the StopDBCluster action.</p>
27
+ * CLI command, or the <code>StopDBCluster</code> operation.</p>
28
28
  * <p>For more information, see
29
29
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html">
30
30
  * Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
31
31
  * <note>
32
- * <p>This action only applies to Aurora DB clusters.</p>
32
+ * <p>This operation only applies to Aurora DB clusters.</p>
33
33
  * </note>
34
34
  * @example
35
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,7 +23,7 @@ export interface StartDBInstanceCommandOutput extends StartDBInstanceResult, __M
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>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.</p>
26
+ * <p>Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the <code>StopDBInstance</code> operation.</p>
27
27
  * <p>For more information, see
28
28
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html">
29
29
  * Starting an Amazon RDS DB instance That Was Previously Stopped</a> in the
@@ -26,7 +26,7 @@ export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBear
26
26
  * @public
27
27
  * <p>Starts an export of DB snapshot or DB cluster data to Amazon S3.
28
28
  * The provided IAM role must have access to the S3 bucket.</p>
29
- * <p>You can't export snapshot data from RDS Custom DB instances.</p>
29
+ * <p>You can't export snapshot data from Db2 or RDS Custom DB instances.</p>
30
30
  * <p>You can't export cluster data from Multi-AZ DB clusters.</p>
31
31
  * <p>For more information on exporting DB snapshot data, see
32
32
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html">Exporting DB snapshot
@@ -24,7 +24,7 @@ export interface StopActivityStreamCommandOutput extends StopActivityStreamRespo
24
24
  /**
25
25
  * @public
26
26
  * <p>Stops a database activity stream that was started using the Amazon Web Services console,
27
- * the <code>start-activity-stream</code> CLI command, or the <code>StartActivityStream</code> action.</p>
27
+ * the <code>start-activity-stream</code> CLI command, or the <code>StartActivityStream</code> operation.</p>
28
28
  * <p>For more information, see
29
29
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html">
30
30
  * Monitoring Amazon Aurora with Database Activity Streams</a>
@@ -30,7 +30,7 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad
30
30
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html">
31
31
  * Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
32
32
  * <note>
33
- * <p>This action only applies to Aurora DB clusters.</p>
33
+ * <p>This operation only applies to Aurora DB clusters.</p>
34
34
  * </note>
35
35
  * @example
36
36
  * Use a bare-bones client and the command you need to make an API call.
@@ -6,7 +6,7 @@
6
6
  * database and manages common database administration tasks, freeing up developers to focus on what makes their applications
7
7
  * and businesses unique.</p>
8
8
  * <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
9
- * Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
9
+ * Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
10
10
  * you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS
11
11
  * automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS
12
12
  * is flexible: you can scale your DB instance's compute resources and storage capacity to meet your