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

#include <InstanceRefresh.h>

Public Member Functions

 InstanceRefresh ()
 
 InstanceRefresh (const Aws::Utils::Xml::XmlNode &xmlNode)
 
InstanceRefreshoperator= (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::StringGetInstanceRefreshId () const
 
bool InstanceRefreshIdHasBeenSet () const
 
void SetInstanceRefreshId (const Aws::String &value)
 
void SetInstanceRefreshId (Aws::String &&value)
 
void SetInstanceRefreshId (const char *value)
 
InstanceRefreshWithInstanceRefreshId (const Aws::String &value)
 
InstanceRefreshWithInstanceRefreshId (Aws::String &&value)
 
InstanceRefreshWithInstanceRefreshId (const char *value)
 
const Aws::StringGetAutoScalingGroupName () const
 
bool AutoScalingGroupNameHasBeenSet () const
 
void SetAutoScalingGroupName (const Aws::String &value)
 
void SetAutoScalingGroupName (Aws::String &&value)
 
void SetAutoScalingGroupName (const char *value)
 
InstanceRefreshWithAutoScalingGroupName (const Aws::String &value)
 
InstanceRefreshWithAutoScalingGroupName (Aws::String &&value)
 
InstanceRefreshWithAutoScalingGroupName (const char *value)
 
const InstanceRefreshStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const InstanceRefreshStatus &value)
 
void SetStatus (InstanceRefreshStatus &&value)
 
InstanceRefreshWithStatus (const InstanceRefreshStatus &value)
 
InstanceRefreshWithStatus (InstanceRefreshStatus &&value)
 
const Aws::StringGetStatusReason () const
 
bool StatusReasonHasBeenSet () const
 
void SetStatusReason (const Aws::String &value)
 
void SetStatusReason (Aws::String &&value)
 
void SetStatusReason (const char *value)
 
InstanceRefreshWithStatusReason (const Aws::String &value)
 
InstanceRefreshWithStatusReason (Aws::String &&value)
 
InstanceRefreshWithStatusReason (const char *value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
InstanceRefreshWithStartTime (const Aws::Utils::DateTime &value)
 
InstanceRefreshWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
InstanceRefreshWithEndTime (const Aws::Utils::DateTime &value)
 
InstanceRefreshWithEndTime (Aws::Utils::DateTime &&value)
 
int GetPercentageComplete () const
 
bool PercentageCompleteHasBeenSet () const
 
void SetPercentageComplete (int value)
 
InstanceRefreshWithPercentageComplete (int value)
 
int GetInstancesToUpdate () const
 
bool InstancesToUpdateHasBeenSet () const
 
void SetInstancesToUpdate (int value)
 
InstanceRefreshWithInstancesToUpdate (int value)
 
const InstanceRefreshProgressDetailsGetProgressDetails () const
 
bool ProgressDetailsHasBeenSet () const
 
void SetProgressDetails (const InstanceRefreshProgressDetails &value)
 
void SetProgressDetails (InstanceRefreshProgressDetails &&value)
 
InstanceRefreshWithProgressDetails (const InstanceRefreshProgressDetails &value)
 
InstanceRefreshWithProgressDetails (InstanceRefreshProgressDetails &&value)
 

Detailed Description

Describes an instance refresh for an Auto Scaling group.

See Also:

AWS API Reference

Definition at line 35 of file InstanceRefresh.h.

Constructor & Destructor Documentation

◆ InstanceRefresh() [1/2]

Aws::AutoScaling::Model::InstanceRefresh::InstanceRefresh ( )

◆ InstanceRefresh() [2/2]

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

Member Function Documentation

◆ AutoScalingGroupNameHasBeenSet()

bool Aws::AutoScaling::Model::InstanceRefresh::AutoScalingGroupNameHasBeenSet ( ) const
inline

The name of the Auto Scaling group.

Definition at line 95 of file InstanceRefresh.h.

◆ EndTimeHasBeenSet()

bool Aws::AutoScaling::Model::InstanceRefresh::EndTimeHasBeenSet ( ) const
inline

The date and time at which the instance refresh ended.

Definition at line 299 of file InstanceRefresh.h.

◆ GetAutoScalingGroupName()

const Aws::String& Aws::AutoScaling::Model::InstanceRefresh::GetAutoScalingGroupName ( ) const
inline

The name of the Auto Scaling group.

Definition at line 90 of file InstanceRefresh.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::AutoScaling::Model::InstanceRefresh::GetEndTime ( ) const
inline

The date and time at which the instance refresh ended.

Definition at line 294 of file InstanceRefresh.h.

◆ GetInstanceRefreshId()

const Aws::String& Aws::AutoScaling::Model::InstanceRefresh::GetInstanceRefreshId ( ) const
inline

The instance refresh ID.

Definition at line 49 of file InstanceRefresh.h.

◆ GetInstancesToUpdate()

int Aws::AutoScaling::Model::InstanceRefresh::GetInstancesToUpdate ( ) const
inline

The number of instances remaining to update before the instance refresh is complete.

Definition at line 363 of file InstanceRefresh.h.

◆ GetPercentageComplete()

int Aws::AutoScaling::Model::InstanceRefresh::GetPercentageComplete ( ) const
inline

The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

Definition at line 329 of file InstanceRefresh.h.

◆ GetProgressDetails()

const InstanceRefreshProgressDetails& Aws::AutoScaling::Model::InstanceRefresh::GetProgressDetails ( ) const
inline

Additional progress details for an Auto Scaling group that has a warm pool.

Definition at line 388 of file InstanceRefresh.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::AutoScaling::Model::InstanceRefresh::GetStartTime ( ) const
inline

The date and time at which the instance refresh began.

Definition at line 263 of file InstanceRefresh.h.

◆ GetStatus()

const InstanceRefreshStatus& Aws::AutoScaling::Model::InstanceRefresh::GetStatus ( ) const
inline

The current status for the instance refresh operation:

  • Pending - The request was created, but the operation has not started.

  • InProgress - The operation is in progress.

  • Successful - The operation completed successfully.

  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

  • Cancelled - The operation is cancelled.

Definition at line 141 of file InstanceRefresh.h.

◆ GetStatusReason()

const Aws::String& Aws::AutoScaling::Model::InstanceRefresh::GetStatusReason ( ) const
inline

Provides more details about the current status of the instance refresh.

Definition at line 222 of file InstanceRefresh.h.

◆ InstanceRefreshIdHasBeenSet()

bool Aws::AutoScaling::Model::InstanceRefresh::InstanceRefreshIdHasBeenSet ( ) const
inline

The instance refresh ID.

Definition at line 54 of file InstanceRefresh.h.

◆ InstancesToUpdateHasBeenSet()

bool Aws::AutoScaling::Model::InstanceRefresh::InstancesToUpdateHasBeenSet ( ) const
inline

The number of instances remaining to update before the instance refresh is complete.

Definition at line 369 of file InstanceRefresh.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ PercentageCompleteHasBeenSet()

bool Aws::AutoScaling::Model::InstanceRefresh::PercentageCompleteHasBeenSet ( ) const
inline

The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

Definition at line 338 of file InstanceRefresh.h.

◆ ProgressDetailsHasBeenSet()

bool Aws::AutoScaling::Model::InstanceRefresh::ProgressDetailsHasBeenSet ( ) const
inline

Additional progress details for an Auto Scaling group that has a warm pool.

Definition at line 394 of file InstanceRefresh.h.

◆ SetAutoScalingGroupName() [1/3]

void Aws::AutoScaling::Model::InstanceRefresh::SetAutoScalingGroupName ( Aws::String &&  value)
inline

The name of the Auto Scaling group.

Definition at line 105 of file InstanceRefresh.h.

◆ SetAutoScalingGroupName() [2/3]

void Aws::AutoScaling::Model::InstanceRefresh::SetAutoScalingGroupName ( const Aws::String value)
inline

The name of the Auto Scaling group.

Definition at line 100 of file InstanceRefresh.h.

◆ SetAutoScalingGroupName() [3/3]

void Aws::AutoScaling::Model::InstanceRefresh::SetAutoScalingGroupName ( const char *  value)
inline

The name of the Auto Scaling group.

Definition at line 110 of file InstanceRefresh.h.

◆ SetEndTime() [1/2]

void Aws::AutoScaling::Model::InstanceRefresh::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The date and time at which the instance refresh ended.

Definition at line 309 of file InstanceRefresh.h.

◆ SetEndTime() [2/2]

void Aws::AutoScaling::Model::InstanceRefresh::SetEndTime ( const Aws::Utils::DateTime value)
inline

The date and time at which the instance refresh ended.

Definition at line 304 of file InstanceRefresh.h.

◆ SetInstanceRefreshId() [1/3]

void Aws::AutoScaling::Model::InstanceRefresh::SetInstanceRefreshId ( Aws::String &&  value)
inline

The instance refresh ID.

Definition at line 64 of file InstanceRefresh.h.

◆ SetInstanceRefreshId() [2/3]

void Aws::AutoScaling::Model::InstanceRefresh::SetInstanceRefreshId ( const Aws::String value)
inline

The instance refresh ID.

Definition at line 59 of file InstanceRefresh.h.

◆ SetInstanceRefreshId() [3/3]

void Aws::AutoScaling::Model::InstanceRefresh::SetInstanceRefreshId ( const char *  value)
inline

The instance refresh ID.

Definition at line 69 of file InstanceRefresh.h.

◆ SetInstancesToUpdate()

void Aws::AutoScaling::Model::InstanceRefresh::SetInstancesToUpdate ( int  value)
inline

The number of instances remaining to update before the instance refresh is complete.

Definition at line 375 of file InstanceRefresh.h.

◆ SetPercentageComplete()

void Aws::AutoScaling::Model::InstanceRefresh::SetPercentageComplete ( int  value)
inline

The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

Definition at line 347 of file InstanceRefresh.h.

◆ SetProgressDetails() [1/2]

void Aws::AutoScaling::Model::InstanceRefresh::SetProgressDetails ( const InstanceRefreshProgressDetails value)
inline

Additional progress details for an Auto Scaling group that has a warm pool.

Definition at line 400 of file InstanceRefresh.h.

◆ SetProgressDetails() [2/2]

void Aws::AutoScaling::Model::InstanceRefresh::SetProgressDetails ( InstanceRefreshProgressDetails &&  value)
inline

Additional progress details for an Auto Scaling group that has a warm pool.

Definition at line 406 of file InstanceRefresh.h.

◆ SetStartTime() [1/2]

void Aws::AutoScaling::Model::InstanceRefresh::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The date and time at which the instance refresh began.

Definition at line 278 of file InstanceRefresh.h.

◆ SetStartTime() [2/2]

void Aws::AutoScaling::Model::InstanceRefresh::SetStartTime ( const Aws::Utils::DateTime value)
inline

The date and time at which the instance refresh began.

Definition at line 273 of file InstanceRefresh.h.

◆ SetStatus() [1/2]

void Aws::AutoScaling::Model::InstanceRefresh::SetStatus ( const InstanceRefreshStatus value)
inline

The current status for the instance refresh operation:

  • Pending - The request was created, but the operation has not started.

  • InProgress - The operation is in progress.

  • Successful - The operation completed successfully.

  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

  • Cancelled - The operation is cancelled.

Definition at line 171 of file InstanceRefresh.h.

◆ SetStatus() [2/2]

void Aws::AutoScaling::Model::InstanceRefresh::SetStatus ( InstanceRefreshStatus &&  value)
inline

The current status for the instance refresh operation:

  • Pending - The request was created, but the operation has not started.

  • InProgress - The operation is in progress.

  • Successful - The operation completed successfully.

  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

  • Cancelled - The operation is cancelled.

Definition at line 186 of file InstanceRefresh.h.

◆ SetStatusReason() [1/3]

void Aws::AutoScaling::Model::InstanceRefresh::SetStatusReason ( Aws::String &&  value)
inline

Provides more details about the current status of the instance refresh.

Definition at line 237 of file InstanceRefresh.h.

◆ SetStatusReason() [2/3]

void Aws::AutoScaling::Model::InstanceRefresh::SetStatusReason ( const Aws::String value)
inline

Provides more details about the current status of the instance refresh.

Definition at line 232 of file InstanceRefresh.h.

◆ SetStatusReason() [3/3]

void Aws::AutoScaling::Model::InstanceRefresh::SetStatusReason ( const char *  value)
inline

Provides more details about the current status of the instance refresh.

Definition at line 242 of file InstanceRefresh.h.

◆ StartTimeHasBeenSet()

bool Aws::AutoScaling::Model::InstanceRefresh::StartTimeHasBeenSet ( ) const
inline

The date and time at which the instance refresh began.

Definition at line 268 of file InstanceRefresh.h.

◆ StatusHasBeenSet()

bool Aws::AutoScaling::Model::InstanceRefresh::StatusHasBeenSet ( ) const
inline

The current status for the instance refresh operation:

  • Pending - The request was created, but the operation has not started.

  • InProgress - The operation is in progress.

  • Successful - The operation completed successfully.

  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

  • Cancelled - The operation is cancelled.

Definition at line 156 of file InstanceRefresh.h.

◆ StatusReasonHasBeenSet()

bool Aws::AutoScaling::Model::InstanceRefresh::StatusReasonHasBeenSet ( ) const
inline

Provides more details about the current status of the instance refresh.

Definition at line 227 of file InstanceRefresh.h.

◆ WithAutoScalingGroupName() [1/3]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithAutoScalingGroupName ( Aws::String &&  value)
inline

The name of the Auto Scaling group.

Definition at line 120 of file InstanceRefresh.h.

◆ WithAutoScalingGroupName() [2/3]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithAutoScalingGroupName ( const Aws::String value)
inline

The name of the Auto Scaling group.

Definition at line 115 of file InstanceRefresh.h.

◆ WithAutoScalingGroupName() [3/3]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithAutoScalingGroupName ( const char *  value)
inline

The name of the Auto Scaling group.

Definition at line 125 of file InstanceRefresh.h.

◆ WithEndTime() [1/2]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The date and time at which the instance refresh ended.

Definition at line 319 of file InstanceRefresh.h.

◆ WithEndTime() [2/2]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithEndTime ( const Aws::Utils::DateTime value)
inline

The date and time at which the instance refresh ended.

Definition at line 314 of file InstanceRefresh.h.

◆ WithInstanceRefreshId() [1/3]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithInstanceRefreshId ( Aws::String &&  value)
inline

The instance refresh ID.

Definition at line 79 of file InstanceRefresh.h.

◆ WithInstanceRefreshId() [2/3]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithInstanceRefreshId ( const Aws::String value)
inline

The instance refresh ID.

Definition at line 74 of file InstanceRefresh.h.

◆ WithInstanceRefreshId() [3/3]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithInstanceRefreshId ( const char *  value)
inline

The instance refresh ID.

Definition at line 84 of file InstanceRefresh.h.

◆ WithInstancesToUpdate()

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithInstancesToUpdate ( int  value)
inline

The number of instances remaining to update before the instance refresh is complete.

Definition at line 381 of file InstanceRefresh.h.

◆ WithPercentageComplete()

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithPercentageComplete ( int  value)
inline

The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

Definition at line 356 of file InstanceRefresh.h.

◆ WithProgressDetails() [1/2]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithProgressDetails ( const InstanceRefreshProgressDetails value)
inline

Additional progress details for an Auto Scaling group that has a warm pool.

Definition at line 412 of file InstanceRefresh.h.

◆ WithProgressDetails() [2/2]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithProgressDetails ( InstanceRefreshProgressDetails &&  value)
inline

Additional progress details for an Auto Scaling group that has a warm pool.

Definition at line 418 of file InstanceRefresh.h.

◆ WithStartTime() [1/2]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The date and time at which the instance refresh began.

Definition at line 288 of file InstanceRefresh.h.

◆ WithStartTime() [2/2]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithStartTime ( const Aws::Utils::DateTime value)
inline

The date and time at which the instance refresh began.

Definition at line 283 of file InstanceRefresh.h.

◆ WithStatus() [1/2]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithStatus ( const InstanceRefreshStatus value)
inline

The current status for the instance refresh operation:

  • Pending - The request was created, but the operation has not started.

  • InProgress - The operation is in progress.

  • Successful - The operation completed successfully.

  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

  • Cancelled - The operation is cancelled.

Definition at line 201 of file InstanceRefresh.h.

◆ WithStatus() [2/2]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithStatus ( InstanceRefreshStatus &&  value)
inline

The current status for the instance refresh operation:

  • Pending - The request was created, but the operation has not started.

  • InProgress - The operation is in progress.

  • Successful - The operation completed successfully.

  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

  • Cancelled - The operation is cancelled.

Definition at line 216 of file InstanceRefresh.h.

◆ WithStatusReason() [1/3]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithStatusReason ( Aws::String &&  value)
inline

Provides more details about the current status of the instance refresh.

Definition at line 252 of file InstanceRefresh.h.

◆ WithStatusReason() [2/3]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithStatusReason ( const Aws::String value)
inline

Provides more details about the current status of the instance refresh.

Definition at line 247 of file InstanceRefresh.h.

◆ WithStatusReason() [3/3]

InstanceRefresh& Aws::AutoScaling::Model::InstanceRefresh::WithStatusReason ( const char *  value)
inline

Provides more details about the current status of the instance refresh.

Definition at line 257 of file InstanceRefresh.h.


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