AWS SDK for C++  1.9.69
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticLoadBalancing::Model::InstanceState Class Reference

#include <InstanceState.h>

Public Member Functions

 InstanceState ()
 
 InstanceState (const Aws::Utils::Xml::XmlNode &xmlNode)
 
InstanceStateoperator= (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 Aws::StringGetInstanceId () const
 
bool InstanceIdHasBeenSet () const
 
void SetInstanceId (const Aws::String &value)
 
void SetInstanceId (Aws::String &&value)
 
void SetInstanceId (const char *value)
 
InstanceStateWithInstanceId (const Aws::String &value)
 
InstanceStateWithInstanceId (Aws::String &&value)
 
InstanceStateWithInstanceId (const char *value)
 
const Aws::StringGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const Aws::String &value)
 
void SetState (Aws::String &&value)
 
void SetState (const char *value)
 
InstanceStateWithState (const Aws::String &value)
 
InstanceStateWithState (Aws::String &&value)
 
InstanceStateWithState (const char *value)
 
const Aws::StringGetReasonCode () const
 
bool ReasonCodeHasBeenSet () const
 
void SetReasonCode (const Aws::String &value)
 
void SetReasonCode (Aws::String &&value)
 
void SetReasonCode (const char *value)
 
InstanceStateWithReasonCode (const Aws::String &value)
 
InstanceStateWithReasonCode (Aws::String &&value)
 
InstanceStateWithReasonCode (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
InstanceStateWithDescription (const Aws::String &value)
 
InstanceStateWithDescription (Aws::String &&value)
 
InstanceStateWithDescription (const char *value)
 

Detailed Description

Information about the state of an EC2 instance.

See Also:

AWS API Reference

Definition at line 31 of file InstanceState.h.

Constructor & Destructor Documentation

◆ InstanceState() [1/2]

Aws::ElasticLoadBalancing::Model::InstanceState::InstanceState ( )

◆ InstanceState() [2/2]

Aws::ElasticLoadBalancing::Model::InstanceState::InstanceState ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ DescriptionHasBeenSet()

bool Aws::ElasticLoadBalancing::Model::InstanceState::DescriptionHasBeenSet ( ) const
inline

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

Definition at line 233 of file InstanceState.h.

◆ GetDescription()

const Aws::String& Aws::ElasticLoadBalancing::Model::InstanceState::GetDescription ( ) const
inline

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

Definition at line 214 of file InstanceState.h.

◆ GetInstanceId()

const Aws::String& Aws::ElasticLoadBalancing::Model::InstanceState::GetInstanceId ( ) const
inline

The ID of the instance.

Definition at line 45 of file InstanceState.h.

◆ GetReasonCode()

const Aws::String& Aws::ElasticLoadBalancing::Model::InstanceState::GetReasonCode ( ) const
inline

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Definition at line 138 of file InstanceState.h.

◆ GetState()

const Aws::String& Aws::ElasticLoadBalancing::Model::InstanceState::GetState ( ) const
inline

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Definition at line 87 of file InstanceState.h.

◆ InstanceIdHasBeenSet()

bool Aws::ElasticLoadBalancing::Model::InstanceState::InstanceIdHasBeenSet ( ) const
inline

The ID of the instance.

Definition at line 50 of file InstanceState.h.

◆ operator=()

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::ElasticLoadBalancing::Model::InstanceState::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

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

◆ ReasonCodeHasBeenSet()

bool Aws::ElasticLoadBalancing::Model::InstanceState::ReasonCodeHasBeenSet ( ) const
inline

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Definition at line 146 of file InstanceState.h.

◆ SetDescription() [1/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetDescription ( Aws::String &&  value)
inline

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

Definition at line 271 of file InstanceState.h.

◆ SetDescription() [2/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetDescription ( const Aws::String value)
inline

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

Definition at line 252 of file InstanceState.h.

◆ SetDescription() [3/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetDescription ( const char *  value)
inline

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

Definition at line 290 of file InstanceState.h.

◆ SetInstanceId() [1/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetInstanceId ( Aws::String &&  value)
inline

The ID of the instance.

Definition at line 60 of file InstanceState.h.

◆ SetInstanceId() [2/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetInstanceId ( const Aws::String value)
inline

The ID of the instance.

Definition at line 55 of file InstanceState.h.

◆ SetInstanceId() [3/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetInstanceId ( const char *  value)
inline

The ID of the instance.

Definition at line 65 of file InstanceState.h.

◆ SetReasonCode() [1/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetReasonCode ( Aws::String &&  value)
inline

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Definition at line 162 of file InstanceState.h.

◆ SetReasonCode() [2/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetReasonCode ( const Aws::String value)
inline

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Definition at line 154 of file InstanceState.h.

◆ SetReasonCode() [3/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetReasonCode ( const char *  value)
inline

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Definition at line 170 of file InstanceState.h.

◆ SetState() [1/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetState ( Aws::String &&  value)
inline

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Definition at line 105 of file InstanceState.h.

◆ SetState() [2/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetState ( const Aws::String value)
inline

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Definition at line 99 of file InstanceState.h.

◆ SetState() [3/3]

void Aws::ElasticLoadBalancing::Model::InstanceState::SetState ( const char *  value)
inline

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Definition at line 111 of file InstanceState.h.

◆ StateHasBeenSet()

bool Aws::ElasticLoadBalancing::Model::InstanceState::StateHasBeenSet ( ) const
inline

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Definition at line 93 of file InstanceState.h.

◆ WithDescription() [1/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithDescription ( Aws::String &&  value)
inline

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

Definition at line 328 of file InstanceState.h.

◆ WithDescription() [2/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithDescription ( const Aws::String value)
inline

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

Definition at line 309 of file InstanceState.h.

◆ WithDescription() [3/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithDescription ( const char *  value)
inline

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

Definition at line 347 of file InstanceState.h.

◆ WithInstanceId() [1/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithInstanceId ( Aws::String &&  value)
inline

The ID of the instance.

Definition at line 75 of file InstanceState.h.

◆ WithInstanceId() [2/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithInstanceId ( const Aws::String value)
inline

The ID of the instance.

Definition at line 70 of file InstanceState.h.

◆ WithInstanceId() [3/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithInstanceId ( const char *  value)
inline

The ID of the instance.

Definition at line 80 of file InstanceState.h.

◆ WithReasonCode() [1/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithReasonCode ( Aws::String &&  value)
inline

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Definition at line 186 of file InstanceState.h.

◆ WithReasonCode() [2/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithReasonCode ( const Aws::String value)
inline

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Definition at line 178 of file InstanceState.h.

◆ WithReasonCode() [3/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithReasonCode ( const char *  value)
inline

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Definition at line 194 of file InstanceState.h.

◆ WithState() [1/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithState ( Aws::String &&  value)
inline

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Definition at line 123 of file InstanceState.h.

◆ WithState() [2/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithState ( const Aws::String value)
inline

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Definition at line 117 of file InstanceState.h.

◆ WithState() [3/3]

InstanceState& Aws::ElasticLoadBalancing::Model::InstanceState::WithState ( const char *  value)
inline

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Definition at line 129 of file InstanceState.h.


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