libZSservicesZSamazonka-rdsZSamazonka-rds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RDS.Types.FailoverState

Description

 
Synopsis

Documentation

data FailoverState Source #

Contains the state of scheduled or in-process failover operations on an Aurora global database (GlobalCluster). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database.

See: newFailoverState smart constructor.

Constructors

FailoverState' 

Fields

  • status :: Maybe FailoverStatus

    The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

    • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
    • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
    • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
  • toDbClusterArn :: Maybe Text

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

  • fromDbClusterArn :: Maybe Text

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

Instances

Instances details
Eq FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Read FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Show FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Generic FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Associated Types

type Rep FailoverState :: Type -> Type #

NFData FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Methods

rnf :: FailoverState -> () #

Hashable FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

FromXML FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

type Rep FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

type Rep FailoverState = D1 ('MetaData "FailoverState" "Amazonka.RDS.Types.FailoverState" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "FailoverState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailoverStatus)) :*: (S1 ('MetaSel ('Just "toDbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fromDbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newFailoverState :: FailoverState Source #

Create a value of FailoverState with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:FailoverState', failoverState_status - The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

  • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
  • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
  • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

$sel:toDbClusterArn:FailoverState', failoverState_toDbClusterArn - The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

$sel:fromDbClusterArn:FailoverState', failoverState_fromDbClusterArn - The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

failoverState_status :: Lens' FailoverState (Maybe FailoverStatus) Source #

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

  • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
  • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
  • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

failoverState_toDbClusterArn :: Lens' FailoverState (Maybe Text) Source #

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

failoverState_fromDbClusterArn :: Lens' FailoverState (Maybe Text) Source #

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