AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::AutoScaling::Model::Instance Class Reference

#include <Instance.h>

Public Member Functions

 Instance ()
 
 Instance (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Instanceoperator= (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)
 
InstanceWithInstanceId (const Aws::String &value)
 
InstanceWithInstanceId (Aws::String &&value)
 
InstanceWithInstanceId (const char *value)
 
const Aws::StringGetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const Aws::String &value)
 
void SetInstanceType (Aws::String &&value)
 
void SetInstanceType (const char *value)
 
InstanceWithInstanceType (const Aws::String &value)
 
InstanceWithInstanceType (Aws::String &&value)
 
InstanceWithInstanceType (const char *value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
InstanceWithAvailabilityZone (const Aws::String &value)
 
InstanceWithAvailabilityZone (Aws::String &&value)
 
InstanceWithAvailabilityZone (const char *value)
 
const LifecycleStateGetLifecycleState () const
 
bool LifecycleStateHasBeenSet () const
 
void SetLifecycleState (const LifecycleState &value)
 
void SetLifecycleState (LifecycleState &&value)
 
InstanceWithLifecycleState (const LifecycleState &value)
 
InstanceWithLifecycleState (LifecycleState &&value)
 
const Aws::StringGetHealthStatus () const
 
bool HealthStatusHasBeenSet () const
 
void SetHealthStatus (const Aws::String &value)
 
void SetHealthStatus (Aws::String &&value)
 
void SetHealthStatus (const char *value)
 
InstanceWithHealthStatus (const Aws::String &value)
 
InstanceWithHealthStatus (Aws::String &&value)
 
InstanceWithHealthStatus (const char *value)
 
const Aws::StringGetLaunchConfigurationName () const
 
bool LaunchConfigurationNameHasBeenSet () const
 
void SetLaunchConfigurationName (const Aws::String &value)
 
void SetLaunchConfigurationName (Aws::String &&value)
 
void SetLaunchConfigurationName (const char *value)
 
InstanceWithLaunchConfigurationName (const Aws::String &value)
 
InstanceWithLaunchConfigurationName (Aws::String &&value)
 
InstanceWithLaunchConfigurationName (const char *value)
 
const LaunchTemplateSpecificationGetLaunchTemplate () const
 
bool LaunchTemplateHasBeenSet () const
 
void SetLaunchTemplate (const LaunchTemplateSpecification &value)
 
void SetLaunchTemplate (LaunchTemplateSpecification &&value)
 
InstanceWithLaunchTemplate (const LaunchTemplateSpecification &value)
 
InstanceWithLaunchTemplate (LaunchTemplateSpecification &&value)
 
bool GetProtectedFromScaleIn () const
 
bool ProtectedFromScaleInHasBeenSet () const
 
void SetProtectedFromScaleIn (bool value)
 
InstanceWithProtectedFromScaleIn (bool value)
 
const Aws::StringGetWeightedCapacity () const
 
bool WeightedCapacityHasBeenSet () const
 
void SetWeightedCapacity (const Aws::String &value)
 
void SetWeightedCapacity (Aws::String &&value)
 
void SetWeightedCapacity (const char *value)
 
InstanceWithWeightedCapacity (const Aws::String &value)
 
InstanceWithWeightedCapacity (Aws::String &&value)
 
InstanceWithWeightedCapacity (const char *value)
 

Detailed Description

Describes an EC2 instance.

See Also:

AWS API Reference

Definition at line 33 of file Instance.h.

Constructor & Destructor Documentation

◆ Instance() [1/2]

Aws::AutoScaling::Model::Instance::Instance ( )

◆ Instance() [2/2]

Aws::AutoScaling::Model::Instance::Instance ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AvailabilityZoneHasBeenSet()

bool Aws::AutoScaling::Model::Instance::AvailabilityZoneHasBeenSet ( ) const
inline

The Availability Zone in which the instance is running.

Definition at line 134 of file Instance.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::AutoScaling::Model::Instance::GetAvailabilityZone ( ) const
inline

The Availability Zone in which the instance is running.

Definition at line 129 of file Instance.h.

◆ GetHealthStatus()

const Aws::String& Aws::AutoScaling::Model::Instance::GetHealthStatus ( ) const
inline

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

Definition at line 222 of file Instance.h.

◆ GetInstanceId()

const Aws::String& Aws::AutoScaling::Model::Instance::GetInstanceId ( ) const
inline

The ID of the instance.

Definition at line 47 of file Instance.h.

◆ GetInstanceType()

const Aws::String& Aws::AutoScaling::Model::Instance::GetInstanceType ( ) const
inline

The instance type of the EC2 instance.

Definition at line 88 of file Instance.h.

◆ GetLaunchConfigurationName()

const Aws::String& Aws::AutoScaling::Model::Instance::GetLaunchConfigurationName ( ) const
inline

The launch configuration associated with the instance.

Definition at line 284 of file Instance.h.

◆ GetLaunchTemplate()

const LaunchTemplateSpecification& Aws::AutoScaling::Model::Instance::GetLaunchTemplate ( ) const
inline

The launch template for the instance.

Definition at line 325 of file Instance.h.

◆ GetLifecycleState()

const LifecycleState& Aws::AutoScaling::Model::Instance::GetLifecycleState ( ) const
inline

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Definition at line 173 of file Instance.h.

◆ GetProtectedFromScaleIn()

bool Aws::AutoScaling::Model::Instance::GetProtectedFromScaleIn ( ) const
inline

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

Definition at line 357 of file Instance.h.

◆ GetWeightedCapacity()

const Aws::String& Aws::AutoScaling::Model::Instance::GetWeightedCapacity ( ) const
inline

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Definition at line 382 of file Instance.h.

◆ HealthStatusHasBeenSet()

bool Aws::AutoScaling::Model::Instance::HealthStatusHasBeenSet ( ) const
inline

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

Definition at line 230 of file Instance.h.

◆ InstanceIdHasBeenSet()

bool Aws::AutoScaling::Model::Instance::InstanceIdHasBeenSet ( ) const
inline

The ID of the instance.

Definition at line 52 of file Instance.h.

◆ InstanceTypeHasBeenSet()

bool Aws::AutoScaling::Model::Instance::InstanceTypeHasBeenSet ( ) const
inline

The instance type of the EC2 instance.

Definition at line 93 of file Instance.h.

◆ LaunchConfigurationNameHasBeenSet()

bool Aws::AutoScaling::Model::Instance::LaunchConfigurationNameHasBeenSet ( ) const
inline

The launch configuration associated with the instance.

Definition at line 289 of file Instance.h.

◆ LaunchTemplateHasBeenSet()

bool Aws::AutoScaling::Model::Instance::LaunchTemplateHasBeenSet ( ) const
inline

The launch template for the instance.

Definition at line 330 of file Instance.h.

◆ LifecycleStateHasBeenSet()

bool Aws::AutoScaling::Model::Instance::LifecycleStateHasBeenSet ( ) const
inline

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Definition at line 181 of file Instance.h.

◆ operator=()

Instance& Aws::AutoScaling::Model::Instance::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::AutoScaling::Model::Instance::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

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

◆ ProtectedFromScaleInHasBeenSet()

bool Aws::AutoScaling::Model::Instance::ProtectedFromScaleInHasBeenSet ( ) const
inline

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

Definition at line 363 of file Instance.h.

◆ SetAvailabilityZone() [1/3]

void Aws::AutoScaling::Model::Instance::SetAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone in which the instance is running.

Definition at line 144 of file Instance.h.

◆ SetAvailabilityZone() [2/3]

void Aws::AutoScaling::Model::Instance::SetAvailabilityZone ( const Aws::String value)
inline

The Availability Zone in which the instance is running.

Definition at line 139 of file Instance.h.

◆ SetAvailabilityZone() [3/3]

void Aws::AutoScaling::Model::Instance::SetAvailabilityZone ( const char *  value)
inline

The Availability Zone in which the instance is running.

Definition at line 149 of file Instance.h.

◆ SetHealthStatus() [1/3]

void Aws::AutoScaling::Model::Instance::SetHealthStatus ( Aws::String &&  value)
inline

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

Definition at line 246 of file Instance.h.

◆ SetHealthStatus() [2/3]

void Aws::AutoScaling::Model::Instance::SetHealthStatus ( const Aws::String value)
inline

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

Definition at line 238 of file Instance.h.

◆ SetHealthStatus() [3/3]

void Aws::AutoScaling::Model::Instance::SetHealthStatus ( const char *  value)
inline

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

Definition at line 254 of file Instance.h.

◆ SetInstanceId() [1/3]

void Aws::AutoScaling::Model::Instance::SetInstanceId ( Aws::String &&  value)
inline

The ID of the instance.

Definition at line 62 of file Instance.h.

◆ SetInstanceId() [2/3]

void Aws::AutoScaling::Model::Instance::SetInstanceId ( const Aws::String value)
inline

The ID of the instance.

Definition at line 57 of file Instance.h.

◆ SetInstanceId() [3/3]

void Aws::AutoScaling::Model::Instance::SetInstanceId ( const char *  value)
inline

The ID of the instance.

Definition at line 67 of file Instance.h.

◆ SetInstanceType() [1/3]

void Aws::AutoScaling::Model::Instance::SetInstanceType ( Aws::String &&  value)
inline

The instance type of the EC2 instance.

Definition at line 103 of file Instance.h.

◆ SetInstanceType() [2/3]

void Aws::AutoScaling::Model::Instance::SetInstanceType ( const Aws::String value)
inline

The instance type of the EC2 instance.

Definition at line 98 of file Instance.h.

◆ SetInstanceType() [3/3]

void Aws::AutoScaling::Model::Instance::SetInstanceType ( const char *  value)
inline

The instance type of the EC2 instance.

Definition at line 108 of file Instance.h.

◆ SetLaunchConfigurationName() [1/3]

void Aws::AutoScaling::Model::Instance::SetLaunchConfigurationName ( Aws::String &&  value)
inline

The launch configuration associated with the instance.

Definition at line 299 of file Instance.h.

◆ SetLaunchConfigurationName() [2/3]

void Aws::AutoScaling::Model::Instance::SetLaunchConfigurationName ( const Aws::String value)
inline

The launch configuration associated with the instance.

Definition at line 294 of file Instance.h.

◆ SetLaunchConfigurationName() [3/3]

void Aws::AutoScaling::Model::Instance::SetLaunchConfigurationName ( const char *  value)
inline

The launch configuration associated with the instance.

Definition at line 304 of file Instance.h.

◆ SetLaunchTemplate() [1/2]

void Aws::AutoScaling::Model::Instance::SetLaunchTemplate ( const LaunchTemplateSpecification value)
inline

The launch template for the instance.

Definition at line 335 of file Instance.h.

◆ SetLaunchTemplate() [2/2]

void Aws::AutoScaling::Model::Instance::SetLaunchTemplate ( LaunchTemplateSpecification &&  value)
inline

The launch template for the instance.

Definition at line 340 of file Instance.h.

◆ SetLifecycleState() [1/2]

void Aws::AutoScaling::Model::Instance::SetLifecycleState ( const LifecycleState value)
inline

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Definition at line 189 of file Instance.h.

◆ SetLifecycleState() [2/2]

void Aws::AutoScaling::Model::Instance::SetLifecycleState ( LifecycleState &&  value)
inline

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Definition at line 197 of file Instance.h.

◆ SetProtectedFromScaleIn()

void Aws::AutoScaling::Model::Instance::SetProtectedFromScaleIn ( bool  value)
inline

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

Definition at line 369 of file Instance.h.

◆ SetWeightedCapacity() [1/3]

void Aws::AutoScaling::Model::Instance::SetWeightedCapacity ( Aws::String &&  value)
inline

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Definition at line 400 of file Instance.h.

◆ SetWeightedCapacity() [2/3]

void Aws::AutoScaling::Model::Instance::SetWeightedCapacity ( const Aws::String value)
inline

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Definition at line 394 of file Instance.h.

◆ SetWeightedCapacity() [3/3]

void Aws::AutoScaling::Model::Instance::SetWeightedCapacity ( const char *  value)
inline

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Definition at line 406 of file Instance.h.

◆ WeightedCapacityHasBeenSet()

bool Aws::AutoScaling::Model::Instance::WeightedCapacityHasBeenSet ( ) const
inline

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Definition at line 388 of file Instance.h.

◆ WithAvailabilityZone() [1/3]

Instance& Aws::AutoScaling::Model::Instance::WithAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone in which the instance is running.

Definition at line 159 of file Instance.h.

◆ WithAvailabilityZone() [2/3]

Instance& Aws::AutoScaling::Model::Instance::WithAvailabilityZone ( const Aws::String value)
inline

The Availability Zone in which the instance is running.

Definition at line 154 of file Instance.h.

◆ WithAvailabilityZone() [3/3]

Instance& Aws::AutoScaling::Model::Instance::WithAvailabilityZone ( const char *  value)
inline

The Availability Zone in which the instance is running.

Definition at line 164 of file Instance.h.

◆ WithHealthStatus() [1/3]

Instance& Aws::AutoScaling::Model::Instance::WithHealthStatus ( Aws::String &&  value)
inline

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

Definition at line 270 of file Instance.h.

◆ WithHealthStatus() [2/3]

Instance& Aws::AutoScaling::Model::Instance::WithHealthStatus ( const Aws::String value)
inline

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

Definition at line 262 of file Instance.h.

◆ WithHealthStatus() [3/3]

Instance& Aws::AutoScaling::Model::Instance::WithHealthStatus ( const char *  value)
inline

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

Definition at line 278 of file Instance.h.

◆ WithInstanceId() [1/3]

Instance& Aws::AutoScaling::Model::Instance::WithInstanceId ( Aws::String &&  value)
inline

The ID of the instance.

Definition at line 77 of file Instance.h.

◆ WithInstanceId() [2/3]

Instance& Aws::AutoScaling::Model::Instance::WithInstanceId ( const Aws::String value)
inline

The ID of the instance.

Definition at line 72 of file Instance.h.

◆ WithInstanceId() [3/3]

Instance& Aws::AutoScaling::Model::Instance::WithInstanceId ( const char *  value)
inline

The ID of the instance.

Definition at line 82 of file Instance.h.

◆ WithInstanceType() [1/3]

Instance& Aws::AutoScaling::Model::Instance::WithInstanceType ( Aws::String &&  value)
inline

The instance type of the EC2 instance.

Definition at line 118 of file Instance.h.

◆ WithInstanceType() [2/3]

Instance& Aws::AutoScaling::Model::Instance::WithInstanceType ( const Aws::String value)
inline

The instance type of the EC2 instance.

Definition at line 113 of file Instance.h.

◆ WithInstanceType() [3/3]

Instance& Aws::AutoScaling::Model::Instance::WithInstanceType ( const char *  value)
inline

The instance type of the EC2 instance.

Definition at line 123 of file Instance.h.

◆ WithLaunchConfigurationName() [1/3]

Instance& Aws::AutoScaling::Model::Instance::WithLaunchConfigurationName ( Aws::String &&  value)
inline

The launch configuration associated with the instance.

Definition at line 314 of file Instance.h.

◆ WithLaunchConfigurationName() [2/3]

Instance& Aws::AutoScaling::Model::Instance::WithLaunchConfigurationName ( const Aws::String value)
inline

The launch configuration associated with the instance.

Definition at line 309 of file Instance.h.

◆ WithLaunchConfigurationName() [3/3]

Instance& Aws::AutoScaling::Model::Instance::WithLaunchConfigurationName ( const char *  value)
inline

The launch configuration associated with the instance.

Definition at line 319 of file Instance.h.

◆ WithLaunchTemplate() [1/2]

Instance& Aws::AutoScaling::Model::Instance::WithLaunchTemplate ( const LaunchTemplateSpecification value)
inline

The launch template for the instance.

Definition at line 345 of file Instance.h.

◆ WithLaunchTemplate() [2/2]

Instance& Aws::AutoScaling::Model::Instance::WithLaunchTemplate ( LaunchTemplateSpecification &&  value)
inline

The launch template for the instance.

Definition at line 350 of file Instance.h.

◆ WithLifecycleState() [1/2]

Instance& Aws::AutoScaling::Model::Instance::WithLifecycleState ( const LifecycleState value)
inline

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Definition at line 205 of file Instance.h.

◆ WithLifecycleState() [2/2]

Instance& Aws::AutoScaling::Model::Instance::WithLifecycleState ( LifecycleState &&  value)
inline

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Definition at line 213 of file Instance.h.

◆ WithProtectedFromScaleIn()

Instance& Aws::AutoScaling::Model::Instance::WithProtectedFromScaleIn ( bool  value)
inline

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

Definition at line 375 of file Instance.h.

◆ WithWeightedCapacity() [1/3]

Instance& Aws::AutoScaling::Model::Instance::WithWeightedCapacity ( Aws::String &&  value)
inline

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Definition at line 418 of file Instance.h.

◆ WithWeightedCapacity() [2/3]

Instance& Aws::AutoScaling::Model::Instance::WithWeightedCapacity ( const Aws::String value)
inline

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Definition at line 412 of file Instance.h.

◆ WithWeightedCapacity() [3/3]

Instance& Aws::AutoScaling::Model::Instance::WithWeightedCapacity ( const char *  value)
inline

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Definition at line 424 of file Instance.h.


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