Class: Aws::RDS::Types::FailoverState

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

Overview

Contains the state of scheduled or in-process operations on a global cluster (Aurora global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Aurora global database.

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 Aurora DB cluster that is currently being demoted, and which is associated with this state.

Returns:

  • (String) 


15711
15712
15713
15714
15715
15716
15717
15718
 
# File 'lib/aws-sdk-rds/types.rb', line 15711

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) 


15711
15712
15713
15714
15715
15716
15717
15718
 
# File 'lib/aws-sdk-rds/types.rb', line 15711

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 DB cluster and the specified secondary DB cluster are being verified before the operation starts.

  • failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.

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

  • switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.

Returns:

  • (String) 


15711
15712
15713
15714
15715
15716
15717
15718
 
# File 'lib/aws-sdk-rds/types.rb', line 15711

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 Aurora DB cluster that is currently being promoted, and which is associated with this state.

Returns:

  • (String) 


15711
15712
15713
15714
15715
15716
15717
15718
 
# File 'lib/aws-sdk-rds/types.rb', line 15711

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