@aws-sdk/client-rds 3.301.0 → 3.303.0

package/dist-es/models/models_1.js

@@ -1,42 +1,37 @@
 import { RDSServiceException as __BaseException } from "./RDSServiceException";
-export var TargetRole;
-(function (TargetRole) {
-    TargetRole["READ_ONLY"] = "READ_ONLY";
-    TargetRole["READ_WRITE"] = "READ_WRITE";
-    TargetRole["UNKNOWN"] = "UNKNOWN";
-})(TargetRole || (TargetRole = {}));
-export var TargetHealthReason;
-(function (TargetHealthReason) {
-    TargetHealthReason["AUTH_FAILURE"] = "AUTH_FAILURE";
-    TargetHealthReason["CONNECTION_FAILED"] = "CONNECTION_FAILED";
-    TargetHealthReason["INVALID_REPLICATION_STATE"] = "INVALID_REPLICATION_STATE";
-    TargetHealthReason["PENDING_PROXY_CAPACITY"] = "PENDING_PROXY_CAPACITY";
-    TargetHealthReason["UNREACHABLE"] = "UNREACHABLE";
-})(TargetHealthReason || (TargetHealthReason = {}));
-export var TargetState;
-(function (TargetState) {
-    TargetState["available"] = "AVAILABLE";
-    TargetState["registering"] = "REGISTERING";
-    TargetState["unavailable"] = "UNAVAILABLE";
-})(TargetState || (TargetState = {}));
-export var TargetType;
-(function (TargetType) {
-    TargetType["RDS_INSTANCE"] = "RDS_INSTANCE";
-    TargetType["RDS_SERVERLESS_ENDPOINT"] = "RDS_SERVERLESS_ENDPOINT";
-    TargetType["TRACKED_CLUSTER"] = "TRACKED_CLUSTER";
-})(TargetType || (TargetType = {}));
-export var SourceType;
-(function (SourceType) {
-    SourceType["blue_green_deployment"] = "blue-green-deployment";
-    SourceType["custom_engine_version"] = "custom-engine-version";
-    SourceType["db_cluster"] = "db-cluster";
-    SourceType["db_cluster_snapshot"] = "db-cluster-snapshot";
-    SourceType["db_instance"] = "db-instance";
-    SourceType["db_parameter_group"] = "db-parameter-group";
-    SourceType["db_proxy"] = "db-proxy";
-    SourceType["db_security_group"] = "db-security-group";
-    SourceType["db_snapshot"] = "db-snapshot";
-})(SourceType || (SourceType = {}));
+export const TargetRole = {
+    READ_ONLY: "READ_ONLY",
+    READ_WRITE: "READ_WRITE",
+    UNKNOWN: "UNKNOWN",
+};
+export const TargetHealthReason = {
+    AUTH_FAILURE: "AUTH_FAILURE",
+    CONNECTION_FAILED: "CONNECTION_FAILED",
+    INVALID_REPLICATION_STATE: "INVALID_REPLICATION_STATE",
+    PENDING_PROXY_CAPACITY: "PENDING_PROXY_CAPACITY",
+    UNREACHABLE: "UNREACHABLE",
+};
+export const TargetState = {
+    available: "AVAILABLE",
+    registering: "REGISTERING",
+    unavailable: "UNAVAILABLE",
+};
+export const TargetType = {
+    RDS_INSTANCE: "RDS_INSTANCE",
+    RDS_SERVERLESS_ENDPOINT: "RDS_SERVERLESS_ENDPOINT",
+    TRACKED_CLUSTER: "TRACKED_CLUSTER",
+};
+export const SourceType = {
+    blue_green_deployment: "blue-green-deployment",
+    custom_engine_version: "custom-engine-version",
+    db_cluster: "db-cluster",
+    db_cluster_snapshot: "db-cluster-snapshot",
+    db_instance: "db-instance",
+    db_parameter_group: "db-parameter-group",
+    db_proxy: "db-proxy",
+    db_security_group: "db-security-group",
+    db_snapshot: "db-snapshot",
+};
 export class ReservedDBInstanceNotFoundFault extends __BaseException {
     constructor(opts) {
         super({
@@ -73,11 +68,10 @@ export class DBLogFileNotFoundFault extends __BaseException {
         Object.setPrototypeOf(this, DBLogFileNotFoundFault.prototype);
     }
 }
-export var AuditPolicyState;
-(function (AuditPolicyState) {
-    AuditPolicyState["LOCKED_POLICY"] = "locked";
-    AuditPolicyState["UNLOCKED_POLICY"] = "unlocked";
-})(AuditPolicyState || (AuditPolicyState = {}));
+export const AuditPolicyState = {
+    LOCKED_POLICY: "locked",
+    UNLOCKED_POLICY: "unlocked",
+};
 export class InvalidDBClusterCapacityFault extends __BaseException {
     constructor(opts) {
         super({
@@ -90,12 +84,11 @@ export class InvalidDBClusterCapacityFault extends __BaseException {
         Object.setPrototypeOf(this, InvalidDBClusterCapacityFault.prototype);
     }
 }
-export var CustomEngineVersionStatus;
-(function (CustomEngineVersionStatus) {
-    CustomEngineVersionStatus["available"] = "available";
-    CustomEngineVersionStatus["inactive"] = "inactive";
-    CustomEngineVersionStatus["inactive_except_restore"] = "inactive-except-restore";
-})(CustomEngineVersionStatus || (CustomEngineVersionStatus = {}));
+export const CustomEngineVersionStatus = {
+    available: "available",
+    inactive: "inactive",
+    inactive_except_restore: "inactive-except-restore",
+};
 export class SharedSnapshotQuotaExceededFault extends __BaseException {
     constructor(opts) {
         super({

package/dist-es/protocols/Aws_query.js

@@ -2655,6 +2655,9 @@ const deserializeAws_queryCreateDBInstanceReadReplicaCommandError = async (outpu
     };
     const errorCode = loadQueryErrorCode(output, parsedOutput.body);
     switch (errorCode) {
+        case "DBClusterNotFoundFault":
+        case "com.amazonaws.rds#DBClusterNotFoundFault":
+            throw await deserializeAws_queryDBClusterNotFoundFaultResponse(parsedOutput, context);
         case "DBInstanceAlreadyExists":
         case "com.amazonaws.rds#DBInstanceAlreadyExistsFault":
             throw await deserializeAws_queryDBInstanceAlreadyExistsFaultResponse(parsedOutput, context);
@@ -2685,6 +2688,9 @@ const deserializeAws_queryCreateDBInstanceReadReplicaCommandError = async (outpu
         case "InsufficientDBInstanceCapacity":
         case "com.amazonaws.rds#InsufficientDBInstanceCapacityFault":
             throw await deserializeAws_queryInsufficientDBInstanceCapacityFaultResponse(parsedOutput, context);
+        case "InvalidDBClusterStateFault":
+        case "com.amazonaws.rds#InvalidDBClusterStateFault":
+            throw await deserializeAws_queryInvalidDBClusterStateFaultResponse(parsedOutput, context);
         case "InvalidDBInstanceState":
         case "com.amazonaws.rds#InvalidDBInstanceStateFault":
             throw await deserializeAws_queryInvalidDBInstanceStateFaultResponse(parsedOutput, context);
@@ -9695,6 +9701,9 @@ const serializeAws_queryCreateDBInstanceReadReplicaMessage = (input, context) =>
     if (input.AllocatedStorage != null) {
         entries["AllocatedStorage"] = input.AllocatedStorage;
     }
+    if (input.SourceDBClusterIdentifier != null) {
+        entries["SourceDBClusterIdentifier"] = input.SourceDBClusterIdentifier;
+    }
     return entries;
 };
 const serializeAws_queryCreateDBParameterGroupMessage = (input, context) => {
@@ -15255,6 +15264,9 @@ const deserializeAws_queryDBInstance = (output, context) => {
     if (output["CertificateDetails"] !== undefined) {
         contents.CertificateDetails = deserializeAws_queryCertificateDetails(output["CertificateDetails"], context);
     }
+    if (output["ReadReplicaSourceDBClusterIdentifier"] !== undefined) {
+        contents.ReadReplicaSourceDBClusterIdentifier = __expectString(output["ReadReplicaSourceDBClusterIdentifier"]);
+    }
     return contents;
 };
 const deserializeAws_queryDBInstanceAlreadyExistsFault = (output, context) => {

package/dist-types/RDS.d.ts

@@ -396,13 +396,14 @@ export declare class RDS extends RDSClient {
      *             request creates a writer and two reader DB instances for you, each in a different
      *             Availability Zone.</p>
      *          <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon
-     *             Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
+     *             Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or
      *             PostgreSQL DB instance. For more information about Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">What is Amazon Aurora?</a> in the <i>Amazon Aurora User
-     *                     Guide</i>.</p>
+     *             Guide</i>.</p>
      *          <p>You can also use the <code>ReplicationSourceIdentifier</code> parameter to create a
-     *             Multi-AZ DB cluster read replica with an RDS for PostgreSQL DB instance as the source.
-     *             For more information about Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">Multi-AZ DB cluster deployments</a> in the <i>Amazon
-     *                     RDS User Guide</i>.</p>
+     *             Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the
+     *             source. For more information about Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">Multi-AZ DB
+     *                 cluster deployments</a> in the <i>Amazon RDS User
+     *             Guide</i>.</p>
      */
     createDBCluster(args: CreateDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterCommandOutput>;
     createDBCluster(args: CreateDBClusterCommandInput, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void;
@@ -483,16 +484,17 @@ export declare class RDS extends RDSClient {
     /**
      * @public
      * <p>Creates a new DB instance that acts as a read replica for an existing source DB
-     *             instance. You can create a read replica for a DB instance running MySQL, MariaDB,
-     *             Oracle, PostgreSQL, or SQL Server. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working with Read
-     *                 Replicas</a> in the <i>Amazon RDS User Guide</i>.</p>
+     *             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
+     *             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
+     *                 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>
      *          <p>Amazon Aurora doesn't support this operation. Call the <code>CreateDBInstance</code>
      *             operation to create a DB instance for an Aurora DB cluster.</p>
-     *          <p>All read replica DB instances are created with backups disabled. All other DB
-     *             instance attributes (including DB security groups and DB parameter groups) are inherited
-     *             from the source DB instance, except as specified.</p>
+     *          <p>All read replica DB instances are created with backups disabled. All other attributes
+     *             (including DB security groups and DB parameter groups) are inherited from the source DB
+     *             instance or cluster, except as specified.</p>
      *          <important>
-     *             <p>Your source DB instance must have backup retention enabled.</p>
+     *             <p>Your source DB instance or cluster must have backup retention enabled.</p>
      *          </important>
      */
     createDBInstanceReadReplica(args: CreateDBInstanceReadReplicaCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBInstanceReadReplicaCommandOutput>;
@@ -671,6 +673,8 @@ export declare class RDS extends RDSClient {
      * <p>The DeleteDBCluster action deletes a previously provisioned DB cluster.
      *           When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered.
      *           Manual DB cluster snapshots of the specified DB cluster are not deleted.</p>
+     *          <p>If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are
+     *             terminated and read replicas are promoted to standalone instances.</p>
      *          <p>For more information on Amazon Aurora, see
      *           <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
      *               What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>

package/dist-types/commands/CreateDBClusterCommand.d.ts

@@ -25,13 +25,14 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  *             request creates a writer and two reader DB instances for you, each in a different
  *             Availability Zone.</p>
  *          <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon
- *             Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
+ *             Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or
  *             PostgreSQL DB instance. For more information about Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">What is Amazon Aurora?</a> in the <i>Amazon Aurora User
- *                     Guide</i>.</p>
+ *             Guide</i>.</p>
  *          <p>You can also use the <code>ReplicationSourceIdentifier</code> parameter to create a
- *             Multi-AZ DB cluster read replica with an RDS for PostgreSQL DB instance as the source.
- *             For more information about Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">Multi-AZ DB cluster deployments</a> in the <i>Amazon
- *                     RDS User Guide</i>.</p>
+ *             Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the
+ *             source. For more information about Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">Multi-AZ DB
+ *                 cluster deployments</a> in the <i>Amazon RDS User
+ *             Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts

@@ -20,16 +20,17 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
 /**
  * @public
  * <p>Creates a new DB instance that acts as a read replica for an existing source DB
- *             instance. You can create a read replica for a DB instance running MySQL, MariaDB,
- *             Oracle, PostgreSQL, or SQL Server. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working with Read
- *                 Replicas</a> in the <i>Amazon RDS User Guide</i>.</p>
+ *             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
+ *             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
+ *                 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>
  *          <p>Amazon Aurora doesn't support this operation. Call the <code>CreateDBInstance</code>
  *             operation to create a DB instance for an Aurora DB cluster.</p>
- *          <p>All read replica DB instances are created with backups disabled. All other DB
- *             instance attributes (including DB security groups and DB parameter groups) are inherited
- *             from the source DB instance, except as specified.</p>
+ *          <p>All read replica DB instances are created with backups disabled. All other attributes
+ *             (including DB security groups and DB parameter groups) are inherited from the source DB
+ *             instance or cluster, except as specified.</p>
  *          <important>
- *             <p>Your source DB instance must have backup retention enabled.</p>
+ *             <p>Your source DB instance or cluster must have backup retention enabled.</p>
  *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -39,7 +40,7 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
  * const client = new RDSClient(config);
  * const input = { // CreateDBInstanceReadReplicaMessage
  *   DBInstanceIdentifier: "STRING_VALUE", // required
- *   SourceDBInstanceIdentifier: "STRING_VALUE", // required
+ *   SourceDBInstanceIdentifier: "STRING_VALUE",
  *   DBInstanceClass: "STRING_VALUE",
  *   AvailabilityZone: "STRING_VALUE",
  *   Port: Number("int"),
@@ -89,6 +90,7 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
  *   StorageThroughput: Number("int"),
  *   EnableCustomerOwnedIp: true || false,
  *   AllocatedStorage: Number("int"),
+ *   SourceDBClusterIdentifier: "STRING_VALUE",
  * };
  * const command = new CreateDBInstanceReadReplicaCommand(input);
  * const response = await client.send(command);
@@ -100,6 +102,10 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
  * @see {@link CreateDBInstanceReadReplicaCommandOutput} for command's `response` shape.
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
+ * @throws {@link DBClusterNotFoundFault} (client fault)
+ *  <p>
+ *             <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
+ *
  * @throws {@link DBInstanceAlreadyExistsFault} (client fault)
  *  <p>The user already has a DB instance with the given identifier.</p>
  *
@@ -139,6 +145,9 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
  *  <p>The specified DB instance class isn't available in the specified Availability
  *             Zone.</p>
  *
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
+ *  <p>The requested operation can't be performed while the cluster is in this state.</p>
+ *
  * @throws {@link InvalidDBInstanceStateFault} (client fault)
  *  <p>The DB instance isn't in a valid state.</p>
  *

package/dist-types/commands/DeleteDBClusterCommand.d.ts

@@ -22,6 +22,8 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
  * <p>The DeleteDBCluster action deletes a previously provisioned DB cluster.
  *           When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered.
  *           Manual DB cluster snapshots of the specified DB cluster are not deleted.</p>
+ *          <p>If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are
+ *             terminated and read replicas are promoted to standalone instances.</p>
  *          <p>For more information on Amazon Aurora, see
  *           <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
  *               What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>