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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::FailoverDBClusterMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass FailoverDBClusterMessage data as a hash:

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #db_cluster_identifier ⇒ String

  A DB cluster identifier to force a failover for.

• #target_db_instance_identifier ⇒ String

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

Instance Attribute Details

#db_cluster_identifier ⇒ String

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)

# File 'lib/aws-sdk-rds/types.rb', line 9294

class FailoverDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :target_db_instance_identifier)
  include Aws::Structure
end

#target_db_instance_identifier ⇒ String

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)

# File 'lib/aws-sdk-rds/types.rb', line 9294

class FailoverDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :target_db_instance_identifier)
  include Aws::Structure
end