Class: Aws::DocDB::Types::FailoverDBClusterMessage

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::FailoverDBClusterMessage

Includes:

Structure

Defined in:

lib/aws-sdk-docdb/types.rb

Overview

Represents the input to FailoverDBCluster.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_cluster_identifier ⇒ String

  A 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 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-docdb/types.rb', line 3680

class FailoverDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :target_db_instance_identifier)
  SENSITIVE = []
  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 Amazon DocumentDB replica in the cluster. For example, ‘mydbcluster-replica1`.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3680

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