You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::FailoverDBClusterMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing FailoverDBClusterMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  db_cluster_identifier: "String",
  target_db_instance_identifier: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifierString

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

^

Returns:

  • (String)

    A DB cluster identifier to force a failover for.

#target_db_instance_identifierString

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1.

Returns:

  • (String)

    The name of the instance to promote to the primary instance.