feat(client-rds): RDS for Oracle supports Oracle Data Guard switchover and read replica backups.

Author: awstools

clients/client-rds/src/RDS.ts

@@ -681,6 +681,11 @@ import {
   StopDBInstanceCommandInput,
   StopDBInstanceCommandOutput,
 } from "./commands/StopDBInstanceCommand";
+import {
+  SwitchoverReadReplicaCommand,
+  SwitchoverReadReplicaCommandInput,
+  SwitchoverReadReplicaCommandOutput,
+} from "./commands/SwitchoverReadReplicaCommand";
 import { RDSClient } from "./RDSClient";
 
 /**
@@ -5930,4 +5935,37 @@ export class RDS extends RDSClient {
       return this.send(command, optionsOrCb);
     }
   }
+
+  /**
+   * <p>Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new
+   *             primary database. Issue this command in the AWS Region that hosts the current standby database.</p>
+   */
+  public switchoverReadReplica(
+    args: SwitchoverReadReplicaCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<SwitchoverReadReplicaCommandOutput>;
+  public switchoverReadReplica(
+    args: SwitchoverReadReplicaCommandInput,
+    cb: (err: any, data?: SwitchoverReadReplicaCommandOutput) => void
+  ): void;
+  public switchoverReadReplica(
+    args: SwitchoverReadReplicaCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: SwitchoverReadReplicaCommandOutput) => void
+  ): void;
+  public switchoverReadReplica(
+    args: SwitchoverReadReplicaCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SwitchoverReadReplicaCommandOutput) => void),
+    cb?: (err: any, data?: SwitchoverReadReplicaCommandOutput) => void
+  ): Promise<SwitchoverReadReplicaCommandOutput> | void {
+    const command = new SwitchoverReadReplicaCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
 }

clients/client-rds/src/RDSClient.ts

@@ -489,6 +489,10 @@ import {
   StopDBInstanceAutomatedBackupsReplicationCommandOutput,
 } from "./commands/StopDBInstanceAutomatedBackupsReplicationCommand";
 import { StopDBInstanceCommandInput, StopDBInstanceCommandOutput } from "./commands/StopDBInstanceCommand";
+import {
+  SwitchoverReadReplicaCommandInput,
+  SwitchoverReadReplicaCommandOutput,
+} from "./commands/SwitchoverReadReplicaCommand";
 import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
 
 export type ServiceInputTypes =
@@ -627,7 +631,8 @@ export type ServiceInputTypes =
   | StopActivityStreamCommandInput
   | StopDBClusterCommandInput
   | StopDBInstanceAutomatedBackupsReplicationCommandInput
-  | StopDBInstanceCommandInput;
+  | StopDBInstanceCommandInput
+  | SwitchoverReadReplicaCommandInput;
 
 export type ServiceOutputTypes =
   | AddRoleToDBClusterCommandOutput
@@ -765,7 +770,8 @@ export type ServiceOutputTypes =
   | StopActivityStreamCommandOutput
   | StopDBClusterCommandOutput
   | StopDBInstanceAutomatedBackupsReplicationCommandOutput
-  | StopDBInstanceCommandOutput;
+  | StopDBInstanceCommandOutput
+  | SwitchoverReadReplicaCommandOutput;
 
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
   /**

clients/client-rds/src/commands/SwitchoverReadReplicaCommand.ts

@@ -0,0 +1,102 @@
+// smithy-typescript generated code
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+  SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import {
+  SwitchoverReadReplicaMessage,
+  SwitchoverReadReplicaMessageFilterSensitiveLog,
+  SwitchoverReadReplicaResult,
+  SwitchoverReadReplicaResultFilterSensitiveLog,
+} from "../models/models_1";
+import {
+  deserializeAws_querySwitchoverReadReplicaCommand,
+  serializeAws_querySwitchoverReadReplicaCommand,
+} from "../protocols/Aws_query";
+import { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient";
+
+export interface SwitchoverReadReplicaCommandInput extends SwitchoverReadReplicaMessage {}
+export interface SwitchoverReadReplicaCommandOutput extends SwitchoverReadReplicaResult, __MetadataBearer {}
+
+/**
+ * <p>Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new
+ *             primary database. Issue this command in the AWS 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
+ * import { RDSClient, SwitchoverReadReplicaCommand } from "@aws-sdk/client-rds"; // ES Modules import
+ * // const { RDSClient, SwitchoverReadReplicaCommand } = require("@aws-sdk/client-rds"); // CommonJS import
+ * const client = new RDSClient(config);
+ * const command = new SwitchoverReadReplicaCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link SwitchoverReadReplicaCommandInput} for command's `input` shape.
+ * @see {@link SwitchoverReadReplicaCommandOutput} for command's `response` shape.
+ * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
+ *
+ */
+export class SwitchoverReadReplicaCommand extends $Command<
+  SwitchoverReadReplicaCommandInput,
+  SwitchoverReadReplicaCommandOutput,
+  RDSClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  constructor(readonly input: SwitchoverReadReplicaCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: RDSClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<SwitchoverReadReplicaCommandInput, SwitchoverReadReplicaCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "RDSClient";
+    const commandName = "SwitchoverReadReplicaCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: SwitchoverReadReplicaMessageFilterSensitiveLog,
+      outputFilterSensitiveLog: SwitchoverReadReplicaResultFilterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: SwitchoverReadReplicaCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_querySwitchoverReadReplicaCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<SwitchoverReadReplicaCommandOutput> {
+    return deserializeAws_querySwitchoverReadReplicaCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}

clients/client-rds/src/commands/index.ts

@@ -135,3 +135,4 @@ export * from "./StopActivityStreamCommand";
 export * from "./StopDBClusterCommand";
 export * from "./StopDBInstanceAutomatedBackupsReplicationCommand";
 export * from "./StopDBInstanceCommand";
+export * from "./SwitchoverReadReplicaCommand";

clients/client-rds/src/models/models_0.ts

@@ -2218,6 +2218,16 @@ export interface DBSnapshot {
    */
   OriginalSnapshotCreateTime?: Date;
 
+  /**
+   * <p>The timestamp of the most recent transaction applied to the database that you're backing up.
+   *             Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance.
+   *             In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.</p>
+   *         <p>If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime
+   *             with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than
+   *             SnapshotDatabaseTime, then the replica lag is two hours. *** REVIEWERS 7/27: Switchover</p>
+   */
+  SnapshotDatabaseTime?: Date;
+
   /**
    * <p>Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.</p>
    */

clients/client-rds/src/models/models_1.ts

@@ -8434,6 +8434,31 @@ export interface StopDBInstanceAutomatedBackupsReplicationResult {
   DBInstanceAutomatedBackup?: DBInstanceAutomatedBackup;
 }
 
+export interface SwitchoverReadReplicaMessage {
+  /**
+   * <p>The DB instance identifier of the current standby database. This value is stored as a lowercase string.</p>
+   *         <p>Constraints:</p>
+   *         <ul>
+   *             <li>
+   *                <p>Must match the identifier of an existing Oracle read replica DB instance.</p>
+   *             </li>
+   *          </ul>
+   */
+  DBInstanceIdentifier: string | undefined;
+}
+
+export interface SwitchoverReadReplicaResult {
+  /**
+   * <p>Contains the details of an Amazon RDS DB instance.</p>
+   *         <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>,
+   *           <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>,
+   *           <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>,
+   *           <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>,
+   *           <code>StartDBInstance</code>, and <code>StopDBInstance</code>.</p>
+   */
+  DBInstance?: DBInstance;
+}
+
 /**
  * @internal
  */
@@ -9568,3 +9593,17 @@ export const StopDBInstanceAutomatedBackupsReplicationResultFilterSensitiveLog =
 ): any => ({
   ...obj,
 });
+
+/**
+ * @internal
+ */
+export const SwitchoverReadReplicaMessageFilterSensitiveLog = (obj: SwitchoverReadReplicaMessage): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const SwitchoverReadReplicaResultFilterSensitiveLog = (obj: SwitchoverReadReplicaResult): any => ({
+  ...obj,
+});