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

#include <RefreshPreferences.h>

Public Member Functions

 RefreshPreferences ()
 
 RefreshPreferences (const Aws::Utils::Xml::XmlNode &xmlNode)
 
RefreshPreferencesoperator= (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 GetMinHealthyPercentage () const
 
bool MinHealthyPercentageHasBeenSet () const
 
void SetMinHealthyPercentage (int value)
 
RefreshPreferencesWithMinHealthyPercentage (int value)
 
int GetInstanceWarmup () const
 
bool InstanceWarmupHasBeenSet () const
 
void SetInstanceWarmup (int value)
 
RefreshPreferencesWithInstanceWarmup (int value)
 
const Aws::Vector< int > & GetCheckpointPercentages () const
 
bool CheckpointPercentagesHasBeenSet () const
 
void SetCheckpointPercentages (const Aws::Vector< int > &value)
 
void SetCheckpointPercentages (Aws::Vector< int > &&value)
 
RefreshPreferencesWithCheckpointPercentages (const Aws::Vector< int > &value)
 
RefreshPreferencesWithCheckpointPercentages (Aws::Vector< int > &&value)
 
RefreshPreferencesAddCheckpointPercentages (int value)
 
int GetCheckpointDelay () const
 
bool CheckpointDelayHasBeenSet () const
 
void SetCheckpointDelay (int value)
 
RefreshPreferencesWithCheckpointDelay (int value)
 
bool GetSkipMatching () const
 
bool SkipMatchingHasBeenSet () const
 
void SetSkipMatching (bool value)
 
RefreshPreferencesWithSkipMatching (bool value)
 

Detailed Description

Describes the preferences for an instance refresh.

See Also:


AWS API Reference

Definition at line 32 of file RefreshPreferences.h.

Constructor & Destructor Documentation

◆ RefreshPreferences() [1/2]

Aws::AutoScaling::Model::RefreshPreferences::RefreshPreferences ( )

◆ RefreshPreferences() [2/2]

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

Member Function Documentation

◆ AddCheckpointPercentages()

RefreshPreferences& Aws::AutoScaling::Model::RefreshPreferences::AddCheckpointPercentages ( int  value)
inline

Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Definition at line 189 of file RefreshPreferences.h.

◆ CheckpointDelayHasBeenSet()

bool Aws::AutoScaling::Model::RefreshPreferences::CheckpointDelayHasBeenSet ( ) const
inline

The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour).

Definition at line 208 of file RefreshPreferences.h.

◆ CheckpointPercentagesHasBeenSet()

bool Aws::AutoScaling::Model::RefreshPreferences::CheckpointPercentagesHasBeenSet ( ) const
inline

Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Definition at line 139 of file RefreshPreferences.h.

◆ GetCheckpointDelay()

int Aws::AutoScaling::Model::RefreshPreferences::GetCheckpointDelay ( ) const
inline

The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour).

Definition at line 199 of file RefreshPreferences.h.

◆ GetCheckpointPercentages()

const Aws::Vector<int>& Aws::AutoScaling::Model::RefreshPreferences::GetCheckpointPercentages ( ) const
inline

Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Definition at line 129 of file RefreshPreferences.h.

◆ GetInstanceWarmup()

int Aws::AutoScaling::Model::RefreshPreferences::GetInstanceWarmup ( ) const
inline

The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.

Definition at line 94 of file RefreshPreferences.h.

◆ GetMinHealthyPercentage()

int Aws::AutoScaling::Model::RefreshPreferences::GetMinHealthyPercentage ( ) const
inline

The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.

Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.

Definition at line 52 of file RefreshPreferences.h.

◆ GetSkipMatching()

bool Aws::AutoScaling::Model::RefreshPreferences::GetSkipMatching ( ) const
inline

A boolean value that indicates whether skip matching is enabled. If true, then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same configuration that is already set on the group. The default is false.

Definition at line 236 of file RefreshPreferences.h.

◆ InstanceWarmupHasBeenSet()

bool Aws::AutoScaling::Model::RefreshPreferences::InstanceWarmupHasBeenSet ( ) const
inline

The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.

Definition at line 102 of file RefreshPreferences.h.

◆ MinHealthyPercentageHasBeenSet()

bool Aws::AutoScaling::Model::RefreshPreferences::MinHealthyPercentageHasBeenSet ( ) const
inline

The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.

Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.

Definition at line 63 of file RefreshPreferences.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ SetCheckpointDelay()

void Aws::AutoScaling::Model::RefreshPreferences::SetCheckpointDelay ( int  value)
inline

The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour).

Definition at line 217 of file RefreshPreferences.h.

◆ SetCheckpointPercentages() [1/2]

void Aws::AutoScaling::Model::RefreshPreferences::SetCheckpointPercentages ( Aws::Vector< int > &&  value)
inline

Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Definition at line 159 of file RefreshPreferences.h.

◆ SetCheckpointPercentages() [2/2]

void Aws::AutoScaling::Model::RefreshPreferences::SetCheckpointPercentages ( const Aws::Vector< int > &  value)
inline

Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Definition at line 149 of file RefreshPreferences.h.

◆ SetInstanceWarmup()

void Aws::AutoScaling::Model::RefreshPreferences::SetInstanceWarmup ( int  value)
inline

The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.

Definition at line 110 of file RefreshPreferences.h.

◆ SetMinHealthyPercentage()

void Aws::AutoScaling::Model::RefreshPreferences::SetMinHealthyPercentage ( int  value)
inline

The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.

Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.

Definition at line 74 of file RefreshPreferences.h.

◆ SetSkipMatching()

void Aws::AutoScaling::Model::RefreshPreferences::SetSkipMatching ( bool  value)
inline

A boolean value that indicates whether skip matching is enabled. If true, then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same configuration that is already set on the group. The default is false.

Definition at line 254 of file RefreshPreferences.h.

◆ SkipMatchingHasBeenSet()

bool Aws::AutoScaling::Model::RefreshPreferences::SkipMatchingHasBeenSet ( ) const
inline

A boolean value that indicates whether skip matching is enabled. If true, then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same configuration that is already set on the group. The default is false.

Definition at line 245 of file RefreshPreferences.h.

◆ WithCheckpointDelay()

RefreshPreferences& Aws::AutoScaling::Model::RefreshPreferences::WithCheckpointDelay ( int  value)
inline

The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour).

Definition at line 226 of file RefreshPreferences.h.

◆ WithCheckpointPercentages() [1/2]

RefreshPreferences& Aws::AutoScaling::Model::RefreshPreferences::WithCheckpointPercentages ( Aws::Vector< int > &&  value)
inline

Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Definition at line 179 of file RefreshPreferences.h.

◆ WithCheckpointPercentages() [2/2]

RefreshPreferences& Aws::AutoScaling::Model::RefreshPreferences::WithCheckpointPercentages ( const Aws::Vector< int > &  value)
inline

Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Definition at line 169 of file RefreshPreferences.h.

◆ WithInstanceWarmup()

RefreshPreferences& Aws::AutoScaling::Model::RefreshPreferences::WithInstanceWarmup ( int  value)
inline

The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.

Definition at line 118 of file RefreshPreferences.h.

◆ WithMinHealthyPercentage()

RefreshPreferences& Aws::AutoScaling::Model::RefreshPreferences::WithMinHealthyPercentage ( int  value)
inline

The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.

Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.

Definition at line 85 of file RefreshPreferences.h.

◆ WithSkipMatching()

RefreshPreferences& Aws::AutoScaling::Model::RefreshPreferences::WithSkipMatching ( bool  value)
inline

A boolean value that indicates whether skip matching is enabled. If true, then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same configuration that is already set on the group. The default is false.

Definition at line 263 of file RefreshPreferences.h.


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