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

Inherits:
Struct
  • Object
show all
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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifierString

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

^

Returns:

  • (String)

13840
13841
13842
13843
13844
13845
# File 'lib/aws-sdk-rds/types.rb', line 13840

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

#target_db_instance_identifierString

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

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example `mydbcluster-replica1`.

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

Returns:

  • (String)

13840
13841
13842
13843
13844
13845
# File 'lib/aws-sdk-rds/types.rb', line 13840

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