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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb

Overview

Note:

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

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

Represents the input to FailoverDBCluster.

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)


3252
3253
3254
3255
3256
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3252

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

#target_db_instance_identifierString

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

You must specify the instance identifier for an Amazon DocumentDB replica in the DB cluster. For example, mydbcluster-replica1.

Returns:

  • (String)


3252
3253
3254
3255
3256
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3252

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