Class: Aws::DocDB::Types::FailoverGlobalClusterMessage

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_data_loss ⇒ Boolean

Specifies whether to allow data loss for this global cluster operation. Allowing data loss triggers a global failover operation.

If you don’t specify ‘AllowDataLoss`, the global cluster operation defaults to a switchover.

Constraints:

  • Can’t be specified together with the ‘Switchover` parameter.

^

Returns:

  • (Boolean) 


3839
3840
3841
3842
3843
3844
3845
3846
 
# File 'lib/aws-sdk-docdb/types.rb', line 3839

class FailoverGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :target_db_cluster_identifier,
  :allow_data_loss,
  :switchover)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_identifier ⇒ String

The identifier of the Amazon DocumentDB global cluster to apply this operation. The identifier is the unique key assigned by the user when the cluster is created. In other words, it’s the name of the global cluster.

Constraints:

  • Must match the identifier of an existing global cluster.

  • Minimum length of 1. Maximum length of 255.

Pattern: ‘[A-Za-z]*`

Returns:

  • (String) 


3839
3840
3841
3842
3843
3844
3845
3846
 
# File 'lib/aws-sdk-docdb/types.rb', line 3839

class FailoverGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :target_db_cluster_identifier,
  :allow_data_loss,
  :switchover)
  SENSITIVE = []
  include Aws::Structure
end

#switchover ⇒ Boolean

Specifies whether to switch over this global database cluster.

Constraints:

  • Can’t be specified together with the ‘AllowDataLoss` parameter.

^

Returns:

  • (Boolean) 


3839
3840
3841
3842
3843
3844
3845
3846
 
# File 'lib/aws-sdk-docdb/types.rb', line 3839

class FailoverGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :target_db_cluster_identifier,
  :allow_data_loss,
  :switchover)
  SENSITIVE = []
  include Aws::Structure
end

#target_db_cluster_identifier ⇒ String

The identifier of the secondary Amazon DocumentDB cluster that you want to promote to the primary for the global cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.

Constraints:

  • Must match the identifier of an existing secondary cluster.

  • Minimum length of 1. Maximum length of 255.

Pattern: ‘[A-Za-z]*`

Returns:

  • (String) 


3839
3840
3841
3842
3843
3844
3845
3846
 
# File 'lib/aws-sdk-docdb/types.rb', line 3839

class FailoverGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :target_db_cluster_identifier,
  :allow_data_loss,
  :switchover)
  SENSITIVE = []
  include Aws::Structure
end