import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { FailoverDBClusterMessage, FailoverDBClusterResult } from "../models/models_1"; import type { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link FailoverDBClusterCommand}. */ export interface FailoverDBClusterCommandInput extends FailoverDBClusterMessage { } /** * @public * * The output of {@link FailoverDBClusterCommand}. */ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult, __MetadataBearer { } declare const FailoverDBClusterCommand_base: { new (input: FailoverDBClusterCommandInput): import("@smithy/core/client").CommandImpl; new (input: FailoverDBClusterCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Forces a failover for a DB cluster.

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.

To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RDSClient, FailoverDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import * // const { RDSClient, FailoverDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import * // import type { RDSClientConfig } from "@aws-sdk/client-rds"; * const config = {}; // type is RDSClientConfig * const client = new RDSClient(config); * const input = { // FailoverDBClusterMessage * DBClusterIdentifier: "STRING_VALUE", // required * TargetDBInstanceIdentifier: "STRING_VALUE", * }; * const command = new FailoverDBClusterCommand(input); * const response = await client.send(command); * // { // FailoverDBClusterResult * // DBCluster: { // DBCluster * // AllocatedStorage: Number("int"), * // AvailabilityZones: [ // AvailabilityZones * // "STRING_VALUE", * // ], * // BackupRetentionPeriod: Number("int"), * // CharacterSetName: "STRING_VALUE", * // DatabaseName: "STRING_VALUE", * // DBClusterIdentifier: "STRING_VALUE", * // DBClusterParameterGroup: "STRING_VALUE", * // DBSubnetGroup: "STRING_VALUE", * // Status: "STRING_VALUE", * // PercentProgress: "STRING_VALUE", * // EarliestRestorableTime: new Date("TIMESTAMP"), * // Endpoint: "STRING_VALUE", * // ReaderEndpoint: "STRING_VALUE", * // CustomEndpoints: [ // StringList * // "STRING_VALUE", * // ], * // MultiAZ: true || false, * // Engine: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // LatestRestorableTime: new Date("TIMESTAMP"), * // Port: Number("int"), * // MasterUsername: "STRING_VALUE", * // DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships * // { // DBClusterOptionGroupStatus * // DBClusterOptionGroupName: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // PreferredBackupWindow: "STRING_VALUE", * // PreferredMaintenanceWindow: "STRING_VALUE", * // UpgradeRolloutOrder: "first" || "second" || "last", * // ReplicationSourceIdentifier: "STRING_VALUE", * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList * // "STRING_VALUE", * // ], * // StatusInfos: [ // DBClusterStatusInfoList * // { // DBClusterStatusInfo * // StatusType: "STRING_VALUE", * // Normal: true || false, * // Status: "STRING_VALUE", * // Message: "STRING_VALUE", * // }, * // ], * // DBClusterMembers: [ // DBClusterMemberList * // { // DBClusterMember * // DBInstanceIdentifier: "STRING_VALUE", * // IsClusterWriter: true || false, * // DBClusterParameterGroupStatus: "STRING_VALUE", * // PromotionTier: Number("int"), * // }, * // ], * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList * // { // VpcSecurityGroupMembership * // VpcSecurityGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // HostedZoneId: "STRING_VALUE", * // StorageEncrypted: true || false, * // StorageEncryptionType: "none" || "sse-kms" || "sse-rds", * // KmsKeyId: "STRING_VALUE", * // DbClusterResourceId: "STRING_VALUE", * // DBClusterArn: "STRING_VALUE", * // AssociatedRoles: [ // DBClusterRoles * // { // DBClusterRole * // RoleArn: "STRING_VALUE", * // Status: "STRING_VALUE", * // FeatureName: "STRING_VALUE", * // }, * // ], * // IAMDatabaseAuthenticationEnabled: true || false, * // CloneGroupId: "STRING_VALUE", * // ClusterCreateTime: new Date("TIMESTAMP"), * // EarliestBacktrackTime: new Date("TIMESTAMP"), * // BacktrackWindow: Number("long"), * // BacktrackConsumedChangeRecords: Number("long"), * // EnabledCloudwatchLogsExports: [ // LogTypeList * // "STRING_VALUE", * // ], * // Capacity: Number("int"), * // PendingModifiedValues: { // ClusterPendingModifiedValues * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports * // LogTypesToEnable: [ * // "STRING_VALUE", * // ], * // LogTypesToDisable: [ * // "STRING_VALUE", * // ], * // }, * // DBClusterIdentifier: "STRING_VALUE", * // MasterUserPassword: "STRING_VALUE", * // IAMDatabaseAuthenticationEnabled: true || false, * // EngineVersion: "STRING_VALUE", * // BackupRetentionPeriod: Number("int"), * // StorageType: "STRING_VALUE", * // AllocatedStorage: Number("int"), * // RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration * // InterconnectSubnetId: "STRING_VALUE", * // TransitGatewayMulticastDomainId: "STRING_VALUE", * // ReplicaMode: "open-read-only" || "mounted", * // }, * // Iops: Number("int"), * // CertificateDetails: { // CertificateDetails * // CAIdentifier: "STRING_VALUE", * // ValidTill: new Date("TIMESTAMP"), * // }, * // }, * // EngineMode: "STRING_VALUE", * // ScalingConfigurationInfo: { // ScalingConfigurationInfo * // MinCapacity: Number("int"), * // MaxCapacity: Number("int"), * // AutoPause: true || false, * // SecondsUntilAutoPause: Number("int"), * // TimeoutAction: "STRING_VALUE", * // SecondsBeforeTimeout: Number("int"), * // }, * // RdsCustomClusterConfiguration: { * // InterconnectSubnetId: "STRING_VALUE", * // TransitGatewayMulticastDomainId: "STRING_VALUE", * // ReplicaMode: "open-read-only" || "mounted", * // }, * // DBClusterInstanceClass: "STRING_VALUE", * // StorageType: "STRING_VALUE", * // Iops: Number("int"), * // StorageThroughput: Number("int"), * // IOOptimizedNextAllowedModificationTime: new Date("TIMESTAMP"), * // PubliclyAccessible: true || false, * // AutoMinorVersionUpgrade: true || false, * // DeletionProtection: true || false, * // HttpEndpointEnabled: true || false, * // ActivityStreamMode: "sync" || "async", * // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping", * // ActivityStreamKmsKeyId: "STRING_VALUE", * // ActivityStreamKinesisStreamName: "STRING_VALUE", * // CopyTagsToSnapshot: true || false, * // CrossAccountClone: true || false, * // DomainMemberships: [ // DomainMembershipList * // { // DomainMembership * // Domain: "STRING_VALUE", * // Status: "STRING_VALUE", * // FQDN: "STRING_VALUE", * // IAMRoleName: "STRING_VALUE", * // OU: "STRING_VALUE", * // AuthSecretArn: "STRING_VALUE", * // DnsIps: [ * // "STRING_VALUE", * // ], * // }, * // ], * // TagList: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // GlobalClusterIdentifier: "STRING_VALUE", * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", * // GlobalWriteForwardingRequested: true || false, * // NetworkType: "STRING_VALUE", * // AutomaticRestartTime: new Date("TIMESTAMP"), * // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo * // MinCapacity: Number("double"), * // MaxCapacity: Number("double"), * // SecondsUntilAutoPause: Number("int"), * // }, * // ServerlessV2PlatformVersion: "STRING_VALUE", * // MonitoringInterval: Number("int"), * // MonitoringRoleArn: "STRING_VALUE", * // DatabaseInsightsMode: "standard" || "advanced", * // PerformanceInsightsEnabled: true || false, * // PerformanceInsightsKMSKeyId: "STRING_VALUE", * // PerformanceInsightsRetentionPeriod: Number("int"), * // DBSystemId: "STRING_VALUE", * // MasterUserSecret: { // MasterUserSecret * // SecretArn: "STRING_VALUE", * // SecretStatus: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // }, * // LocalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "requested", * // AwsBackupRecoveryPointArn: "STRING_VALUE", * // LimitlessDatabase: { // LimitlessDatabase * // Status: "active" || "not-in-use" || "enabled" || "disabled" || "enabling" || "disabling" || "modifying-max-capacity" || "error", * // MinRequiredACU: Number("double"), * // }, * // ClusterScalabilityType: "standard" || "limitless", * // CertificateDetails: { * // CAIdentifier: "STRING_VALUE", * // ValidTill: new Date("TIMESTAMP"), * // }, * // EngineLifecycleSupport: "STRING_VALUE", * // VPCNetworkingEnabled: true || false, * // InternetAccessGatewayEnabled: true || false, * // }, * // }; * * ``` * * @param FailoverDBClusterCommandInput - {@link FailoverDBClusterCommandInput} * @returns {@link FailoverDBClusterCommandOutput} * @see {@link FailoverDBClusterCommandInput} for command's `input` shape. * @see {@link FailoverDBClusterCommandOutput} for command's `response` shape. * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape. * * @throws {@link DBClusterNotFoundFault} (client fault) *

DBClusterIdentifier doesn't refer to an existing DB cluster.

* * @throws {@link InvalidDBClusterStateFault} (client fault) *

The requested operation can't be performed while the cluster is in this state.

* * @throws {@link InvalidDBInstanceStateFault} (client fault) *

The DB instance isn't in a valid state.

* * @throws {@link RDSServiceException} *

Base exception class for all service exceptions from RDS service.

* * * @example To perform a failover for a DB cluster * ```javascript * // This example performs a failover for the specified DB cluster to the specified DB instance. * const input = { * DBClusterIdentifier: "myaurorainstance-cluster", * TargetDBInstanceIdentifier: "myaurorareplica" * }; * const command = new FailoverDBClusterCommand(input); * const response = await client.send(command); * /* response is * { * DBCluster: { /* empty *\/ } * } * *\/ * ``` * * @public */ export declare class FailoverDBClusterCommand extends FailoverDBClusterCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: FailoverDBClusterMessage; output: FailoverDBClusterResult; }; sdk: { input: FailoverDBClusterCommandInput; output: FailoverDBClusterCommandOutput; }; }; }