AWS SDK for C++  1.8.182
AWS SDK for C++
Public Member Functions | List of all members
Aws::RDS::Model::FailoverState Class Reference

#include <FailoverState.h>

Public Member Functions

 FailoverState ()
 
 FailoverState (const Aws::Utils::Xml::XmlNode &xmlNode)
 
FailoverStateoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const FailoverStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const FailoverStatus &value)
 
void SetStatus (FailoverStatus &&value)
 
FailoverStateWithStatus (const FailoverStatus &value)
 
FailoverStateWithStatus (FailoverStatus &&value)
 
const Aws::StringGetFromDbClusterArn () const
 
bool FromDbClusterArnHasBeenSet () const
 
void SetFromDbClusterArn (const Aws::String &value)
 
void SetFromDbClusterArn (Aws::String &&value)
 
void SetFromDbClusterArn (const char *value)
 
FailoverStateWithFromDbClusterArn (const Aws::String &value)
 
FailoverStateWithFromDbClusterArn (Aws::String &&value)
 
FailoverStateWithFromDbClusterArn (const char *value)
 
const Aws::StringGetToDbClusterArn () const
 
bool ToDbClusterArnHasBeenSet () const
 
void SetToDbClusterArn (const Aws::String &value)
 
void SetToDbClusterArn (Aws::String &&value)
 
void SetToDbClusterArn (const char *value)
 
FailoverStateWithToDbClusterArn (const Aws::String &value)
 
FailoverStateWithToDbClusterArn (Aws::String &&value)
 
FailoverStateWithToDbClusterArn (const char *value)
 

Detailed Description

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 Also:

AWS API Reference

Definition at line 35 of file FailoverState.h.

Constructor & Destructor Documentation

◆ FailoverState() [1/2]

Aws::RDS::Model::FailoverState::FailoverState ( )

◆ FailoverState() [2/2]

Aws::RDS::Model::FailoverState::FailoverState ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ FromDbClusterArnHasBeenSet()

bool Aws::RDS::Model::FailoverState::FromDbClusterArnHasBeenSet ( ) const
inline

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

Definition at line 153 of file FailoverState.h.

◆ GetFromDbClusterArn()

const Aws::String& Aws::RDS::Model::FailoverState::GetFromDbClusterArn ( ) const
inline

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

Definition at line 147 of file FailoverState.h.

◆ GetStatus()

const FailoverStatus& Aws::RDS::Model::FailoverState::GetStatus ( ) const
inline

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

  • pending &#x96; 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 &#x96; 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 &#x96; 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.

Definition at line 60 of file FailoverState.h.

◆ GetToDbClusterArn()

const Aws::String& Aws::RDS::Model::FailoverState::GetToDbClusterArn ( ) const
inline

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

Definition at line 196 of file FailoverState.h.

◆ operator=()

FailoverState& Aws::RDS::Model::FailoverState::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::RDS::Model::FailoverState::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::RDS::Model::FailoverState::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ SetFromDbClusterArn() [1/3]

void Aws::RDS::Model::FailoverState::SetFromDbClusterArn ( Aws::String &&  value)
inline

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

Definition at line 165 of file FailoverState.h.

◆ SetFromDbClusterArn() [2/3]

void Aws::RDS::Model::FailoverState::SetFromDbClusterArn ( const Aws::String value)
inline

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

Definition at line 159 of file FailoverState.h.

◆ SetFromDbClusterArn() [3/3]

void Aws::RDS::Model::FailoverState::SetFromDbClusterArn ( const char *  value)
inline

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

Definition at line 171 of file FailoverState.h.

◆ SetStatus() [1/2]

void Aws::RDS::Model::FailoverState::SetStatus ( const FailoverStatus value)
inline

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

  • pending &#x96; 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 &#x96; 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 &#x96; 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.

Definition at line 92 of file FailoverState.h.

◆ SetStatus() [2/2]

void Aws::RDS::Model::FailoverState::SetStatus ( FailoverStatus &&  value)
inline

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

  • pending &#x96; 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 &#x96; 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 &#x96; 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.

Definition at line 108 of file FailoverState.h.

◆ SetToDbClusterArn() [1/3]

void Aws::RDS::Model::FailoverState::SetToDbClusterArn ( Aws::String &&  value)
inline

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

Definition at line 214 of file FailoverState.h.

◆ SetToDbClusterArn() [2/3]

void Aws::RDS::Model::FailoverState::SetToDbClusterArn ( const Aws::String value)
inline

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

Definition at line 208 of file FailoverState.h.

◆ SetToDbClusterArn() [3/3]

void Aws::RDS::Model::FailoverState::SetToDbClusterArn ( const char *  value)
inline

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

Definition at line 220 of file FailoverState.h.

◆ StatusHasBeenSet()

bool Aws::RDS::Model::FailoverState::StatusHasBeenSet ( ) const
inline

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

  • pending &#x96; 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 &#x96; 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 &#x96; 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.

Definition at line 76 of file FailoverState.h.

◆ ToDbClusterArnHasBeenSet()

bool Aws::RDS::Model::FailoverState::ToDbClusterArnHasBeenSet ( ) const
inline

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

Definition at line 202 of file FailoverState.h.

◆ WithFromDbClusterArn() [1/3]

FailoverState& Aws::RDS::Model::FailoverState::WithFromDbClusterArn ( Aws::String &&  value)
inline

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

Definition at line 183 of file FailoverState.h.

◆ WithFromDbClusterArn() [2/3]

FailoverState& Aws::RDS::Model::FailoverState::WithFromDbClusterArn ( const Aws::String value)
inline

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

Definition at line 177 of file FailoverState.h.

◆ WithFromDbClusterArn() [3/3]

FailoverState& Aws::RDS::Model::FailoverState::WithFromDbClusterArn ( const char *  value)
inline

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

Definition at line 189 of file FailoverState.h.

◆ WithStatus() [1/2]

FailoverState& Aws::RDS::Model::FailoverState::WithStatus ( const FailoverStatus value)
inline

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

  • pending &#x96; 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 &#x96; 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 &#x96; 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.

Definition at line 124 of file FailoverState.h.

◆ WithStatus() [2/2]

FailoverState& Aws::RDS::Model::FailoverState::WithStatus ( FailoverStatus &&  value)
inline

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

  • pending &#x96; 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 &#x96; 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 &#x96; 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.

Definition at line 140 of file FailoverState.h.

◆ WithToDbClusterArn() [1/3]

FailoverState& Aws::RDS::Model::FailoverState::WithToDbClusterArn ( Aws::String &&  value)
inline

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

Definition at line 232 of file FailoverState.h.

◆ WithToDbClusterArn() [2/3]

FailoverState& Aws::RDS::Model::FailoverState::WithToDbClusterArn ( const Aws::String value)
inline

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

Definition at line 226 of file FailoverState.h.

◆ WithToDbClusterArn() [3/3]

FailoverState& Aws::RDS::Model::FailoverState::WithToDbClusterArn ( const char *  value)
inline

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

Definition at line 238 of file FailoverState.h.


The documentation for this class was generated from the following file: