Class: Aws::DocDB::Types::FailoverState

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

Overview

Contains the state of scheduled or in-process operations on an Amazon DocumentDB global cluster. This data type is empty unless a switchover or failover operation is scheduled or is in progress on the global cluster.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#from_db_cluster_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.

Returns:

  • (String) 


3975
3976
3977
3978
3979
3980
3981
3982
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3975

class FailoverState < Struct.new(
  :status,
  :from_db_cluster_arn,
  :to_db_cluster_arn,
  :is_data_loss_allowed)
  SENSITIVE = []
  include Aws::Structure
end

#is_data_loss_allowed ⇒ Boolean

Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

Returns:

  • (Boolean) 


3975
3976
3977
3978
3979
3980
3981
3982
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3975

class FailoverState < Struct.new(
  :status,
  :from_db_cluster_arn,
  :to_db_cluster_arn,
  :is_data_loss_allowed)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the global cluster. Possible values are as follows:

  • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

  • failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

  • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

Returns:

  • (String) 


3975
3976
3977
3978
3979
3980
3981
3982
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3975

class FailoverState < Struct.new(
  :status,
  :from_db_cluster_arn,
  :to_db_cluster_arn,
  :is_data_loss_allowed)
  SENSITIVE = []
  include Aws::Structure
end

#to_db_cluster_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being promoted, and which is associated with this state.

Returns:

  • (String) 


3975
3976
3977
3978
3979
3980
3981
3982
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3975

class FailoverState < Struct.new(
  :status,
  :from_db_cluster_arn,
  :to_db_cluster_arn,
  :is_data_loss_allowed)
  SENSITIVE = []
  include Aws::Structure
end