AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::EC2::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
 
int GetCode () const
 
bool CodeHasBeenSet () const
 
void SetCode (int value)
 
InstanceStateWithCode (int value)
 
const InstanceStateNameGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const InstanceStateName &value)
 
void SetName (InstanceStateName &&value)
 
InstanceStateWithName (const InstanceStateName &value)
 
InstanceStateWithName (InstanceStateName &&value)
 

Detailed Description

Describes the current state of an instance.

See Also:

AWS API Reference

Definition at line 31 of file InstanceState.h.

Constructor & Destructor Documentation

◆ InstanceState() [1/2]

Aws::EC2::Model::InstanceState::InstanceState ( )

◆ InstanceState() [2/2]

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

Member Function Documentation

◆ CodeHasBeenSet()

bool Aws::EC2::Model::InstanceState::CodeHasBeenSet ( ) const
inline

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

Definition at line 74 of file InstanceState.h.

◆ GetCode()

int Aws::EC2::Model::InstanceState::GetCode ( ) const
inline

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

Definition at line 57 of file InstanceState.h.

◆ GetName()

const InstanceStateName& Aws::EC2::Model::InstanceState::GetName ( ) const
inline

The current state of the instance.

Definition at line 114 of file InstanceState.h.

◆ NameHasBeenSet()

bool Aws::EC2::Model::InstanceState::NameHasBeenSet ( ) const
inline

The current state of the instance.

Definition at line 119 of file InstanceState.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ SetCode()

void Aws::EC2::Model::InstanceState::SetCode ( int  value)
inline

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

Definition at line 91 of file InstanceState.h.

◆ SetName() [1/2]

void Aws::EC2::Model::InstanceState::SetName ( const InstanceStateName value)
inline

The current state of the instance.

Definition at line 124 of file InstanceState.h.

◆ SetName() [2/2]

void Aws::EC2::Model::InstanceState::SetName ( InstanceStateName &&  value)
inline

The current state of the instance.

Definition at line 129 of file InstanceState.h.

◆ WithCode()

InstanceState& Aws::EC2::Model::InstanceState::WithCode ( int  value)
inline

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

Definition at line 108 of file InstanceState.h.

◆ WithName() [1/2]

InstanceState& Aws::EC2::Model::InstanceState::WithName ( const InstanceStateName value)
inline

The current state of the instance.

Definition at line 134 of file InstanceState.h.

◆ WithName() [2/2]

InstanceState& Aws::EC2::Model::InstanceState::WithName ( InstanceStateName &&  value)
inline

The current state of the instance.

Definition at line 139 of file InstanceState.h.


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