@aws-sdk/client-rds 3.968.0 → 3.970.0

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

@@ -27,14 +27,7 @@ declare const SwitchoverBlueGreenDeploymentCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Switches over a blue/green deployment.</p>
- *          <p>Before you switch over, production traffic is routed to the databases in the blue environment.
- *             After you switch over, production traffic is routed to the databases in the green environment.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html">Using Amazon RDS
- *                 Blue/Green Deployments for database updates</a> in the <i>Amazon RDS User
- *                 Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html">Using Amazon RDS
- *                 Blue/Green Deployments for database updates</a> in the <i>Amazon Aurora
- *                 User Guide</i>.</p>
+ * <p>Switches over a blue/green deployment.</p> <p>Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html">Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html">Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon Aurora User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -90,17 +83,151 @@ declare const SwitchoverBlueGreenDeploymentCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link BlueGreenDeploymentNotFoundFault} (client fault)
- *  <p>
- *             <code>BlueGreenDeploymentIdentifier</code> doesn't refer to an existing blue/green deployment.</p>
+ *  <p> <code>BlueGreenDeploymentIdentifier</code> doesn't refer to an existing blue/green deployment.</p>
  *
  * @throws {@link InvalidBlueGreenDeploymentStateFault} (client fault)
- *  <p>The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
- *             the green environment.</p>
+ *  <p>The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.</p>
  *
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
  *
+ * @example To switch a blue/green deployment for an RDS DB instance
+ * ```javascript
+ * // The following example promotes the specified green environment as the new production environment.
+ * const input = {
+ *   BlueGreenDeploymentIdentifier: "bgd-wi89nwzglccsfake",
+ *   SwitchoverTimeout: 300
+ * };
+ * const command = new SwitchoverBlueGreenDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   BlueGreenDeployment: {
+ *     BlueGreenDeploymentIdentifier: "bgd-v53303651eexfake",
+ *     BlueGreenDeploymentName: "bgd-cli-test-instance",
+ *     CreateTime: "2022-02-25T22:33:22.225Z",
+ *     Source: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
+ *     Status: "SWITCHOVER_IN_PROGRESS",
+ *     SwitchoverDetails: [
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-k5fv7u"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ggsh8m"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-o2vwm0"
+ *       }
+ *     ],
+ *     Target: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e",
+ *     Tasks: [
+ *       {
+ *         Name: "CREATING_READ_REPLICA_OF_SOURCE",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "DB_ENGINE_VERSION_UPGRADE",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "CONFIGURE_BACKUPS",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "CREATING_TOPOLOGY_OF_SOURCE",
+ *         Status: "COMPLETED"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * ```
+ *
+ * @example To promote a blue/green deployment for an Aurora MySQL DB cluster
+ * ```javascript
+ * // The following example promotes the specified green environment as the new production environment.
+ * const input = {
+ *   BlueGreenDeploymentIdentifier: "bgd-wi89nwzglccsfake",
+ *   SwitchoverTimeout: 300
+ * };
+ * const command = new SwitchoverBlueGreenDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   BlueGreenDeployment: {
+ *     BlueGreenDeploymentIdentifier: "bgd-wi89nwzglccsfake",
+ *     BlueGreenDeploymentName: "my-blue-green-deployment",
+ *     CreateTime: "2022-02-25T22:38:49.522Z",
+ *     Source: "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
+ *     Status: "SWITCHOVER_IN_PROGRESS",
+ *     SwitchoverDetails: [
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-bvxc73"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-7wc4ie"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-p4xxkz"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-np1ikl"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-miszlf"
+ *       }
+ *     ],
+ *     Target: "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6",
+ *     Tasks: [
+ *       {
+ *         Name: "CREATING_READ_REPLICA_OF_SOURCE",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "DB_ENGINE_VERSION_UPGRADE",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "CREATE_DB_INSTANCES_FOR_CLUSTER",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "CREATE_CUSTOM_ENDPOINTS",
+ *         Status: "COMPLETED"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class SwitchoverBlueGreenDeploymentCommand extends SwitchoverBlueGreenDeploymentCommand_base {

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

@@ -27,17 +27,7 @@ declare const SwitchoverGlobalClusterCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster.
- *        Switchover operations were previously called "managed planned failovers."</p>
- *          <p>Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster
- *        to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary
- *        at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database
- *        is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about
- *        switching over an Aurora global database, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover">Performing switchovers for Amazon Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p>
- *          <note>
- *             <p>This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original
- *        primary after a global database failover.</p>
- *          </note>
+ * <p>Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."</p> <p>Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover">Performing switchovers for Amazon Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -100,8 +90,7 @@ declare const SwitchoverGlobalClusterCommand_base: {
  * @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>
+ *  <p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
  *
  * @throws {@link GlobalClusterNotFoundFault} (client fault)
  *  <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>

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

@@ -27,8 +27,7 @@ declare const SwitchoverReadReplicaCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new
- *             primary database. Issue this command in the Region that hosts the current standby database.</p>
+ * <p>Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -302,8 +301,7 @@ declare const SwitchoverReadReplicaCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBInstanceNotFoundFault} (client fault)
- *  <p>
- *             <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
+ *  <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
  *
  * @throws {@link InvalidDBInstanceStateFault} (client fault)
  *  <p>The DB instance isn't in a valid state.</p>

package/dist-types/index.d.ts

@@ -1,57 +1,5 @@
 /**
- * <fullname>Amazon Relational Database Service</fullname>
- *          <p></p>
- *          <p>Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and
- *           scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational
- *           database and manages common database administration tasks, freeing up developers to focus on what makes their applications
- *           and businesses unique.</p>
- *          <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
- *           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
- *           application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for
- *           the resources you use.</p>
- *          <p>This interface reference for Amazon RDS contains documentation for a programming or command line interface
- *           you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might
- *           require techniques such as polling or callback functions to determine when a command has been applied. In this
- *           reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot,
- *           or during the maintenance window. The reference structure is as follows, and we list following some related topics
- *           from the user guide.</p>
- *          <p>
- *             <b>Amazon RDS API Reference</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>For the alphabetical list of API actions, see
- *         <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html">API Actions</a>.</p>
- *             </li>
- *             <li>
- *                <p>For the alphabetical list of data types, see
- *         <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html">Data Types</a>.</p>
- *             </li>
- *             <li>
- *                <p>For a list of common query parameters, see
- *         <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html">Common Parameters</a>.</p>
- *             </li>
- *             <li>
- *                <p>For descriptions of the error codes, see
- *         <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
- *             </li>
- *          </ul>
- *          <p>
- *             <b>Amazon RDS User Guide</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>For a summary of the Amazon RDS interfaces, see
- *         <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces">Available RDS Interfaces</a>.</p>
- *             </li>
- *             <li>
- *                <p>For more information about how to use the Query API, see
- *         <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html">Using the Query API</a>.</p>
- *             </li>
- *          </ul>
+ * <fullname>Amazon Relational Database Service</fullname> <p/> <p>Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.</p> <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, 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 application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.</p> <p>This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.</p> <p> <b>Amazon RDS API Reference</b> </p> <ul> <li> <p>For the alphabetical list of API actions, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html">API Actions</a>.</p> </li> <li> <p>For the alphabetical list of data types, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html">Data Types</a>.</p> </li> <li> <p>For a list of common query parameters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html">Common Parameters</a>.</p> </li> <li> <p>For descriptions of the error codes, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html">Common Errors</a>.</p> </li> </ul> <p> <b>Amazon RDS User Guide</b> </p> <ul> <li> <p>For a summary of the Amazon RDS interfaces, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces">Available RDS Interfaces</a>.</p> </li> <li> <p>For more information about how to use the Query API, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html">Using the Query API</a>.</p> </li> </ul>
  *
  * @packageDocumentation
  */