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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/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",
  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 contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Returns:

  • (String)


7844
7845
7846
7847
7848
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7844

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 Aurora Replica in the DB cluster. For example, mydbcluster-replica1.

Returns:

  • (String)


7844
7845
7846
7847
7848
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7844

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