AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::OpsWorks::Model::AutoScalingThresholds Class Reference

#include <AutoScalingThresholds.h>

Public Member Functions

 AutoScalingThresholds ()
 
 AutoScalingThresholds (Aws::Utils::Json::JsonView jsonValue)
 
AutoScalingThresholdsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetInstanceCount () const
 
bool InstanceCountHasBeenSet () const
 
void SetInstanceCount (int value)
 
AutoScalingThresholdsWithInstanceCount (int value)
 
int GetThresholdsWaitTime () const
 
bool ThresholdsWaitTimeHasBeenSet () const
 
void SetThresholdsWaitTime (int value)
 
AutoScalingThresholdsWithThresholdsWaitTime (int value)
 
int GetIgnoreMetricsTime () const
 
bool IgnoreMetricsTimeHasBeenSet () const
 
void SetIgnoreMetricsTime (int value)
 
AutoScalingThresholdsWithIgnoreMetricsTime (int value)
 
double GetCpuThreshold () const
 
bool CpuThresholdHasBeenSet () const
 
void SetCpuThreshold (double value)
 
AutoScalingThresholdsWithCpuThreshold (double value)
 
double GetMemoryThreshold () const
 
bool MemoryThresholdHasBeenSet () const
 
void SetMemoryThreshold (double value)
 
AutoScalingThresholdsWithMemoryThreshold (double value)
 
double GetLoadThreshold () const
 
bool LoadThresholdHasBeenSet () const
 
void SetLoadThreshold (double value)
 
AutoScalingThresholdsWithLoadThreshold (double value)
 
const Aws::Vector< Aws::String > & GetAlarms () const
 
bool AlarmsHasBeenSet () const
 
void SetAlarms (const Aws::Vector< Aws::String > &value)
 
void SetAlarms (Aws::Vector< Aws::String > &&value)
 
AutoScalingThresholdsWithAlarms (const Aws::Vector< Aws::String > &value)
 
AutoScalingThresholdsWithAlarms (Aws::Vector< Aws::String > &&value)
 
AutoScalingThresholdsAddAlarms (const Aws::String &value)
 
AutoScalingThresholdsAddAlarms (Aws::String &&value)
 
AutoScalingThresholdsAddAlarms (const char *value)
 

Detailed Description

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances.

See Also:

AWS API Reference

Definition at line 34 of file AutoScalingThresholds.h.

Constructor & Destructor Documentation

◆ AutoScalingThresholds() [1/2]

Aws::OpsWorks::Model::AutoScalingThresholds::AutoScalingThresholds ( )

◆ AutoScalingThresholds() [2/2]

Aws::OpsWorks::Model::AutoScalingThresholds::AutoScalingThresholds ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAlarms() [1/3]

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::AddAlarms ( const Aws::String value)
inline

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Definition at line 307 of file AutoScalingThresholds.h.

◆ AddAlarms() [2/3]

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::AddAlarms ( Aws::String &&  value)
inline

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Definition at line 319 of file AutoScalingThresholds.h.

◆ AddAlarms() [3/3]

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::AddAlarms ( const char *  value)
inline

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Definition at line 331 of file AutoScalingThresholds.h.

◆ AlarmsHasBeenSet()

bool Aws::OpsWorks::Model::AutoScalingThresholds::AlarmsHasBeenSet ( ) const
inline

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Definition at line 247 of file AutoScalingThresholds.h.

◆ CpuThresholdHasBeenSet()

bool Aws::OpsWorks::Model::AutoScalingThresholds::CpuThresholdHasBeenSet ( ) const
inline

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

Definition at line 152 of file AutoScalingThresholds.h.

◆ GetAlarms()

const Aws::Vector<Aws::String>& Aws::OpsWorks::Model::AutoScalingThresholds::GetAlarms ( ) const
inline

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Definition at line 235 of file AutoScalingThresholds.h.

◆ GetCpuThreshold()

double Aws::OpsWorks::Model::AutoScalingThresholds::GetCpuThreshold ( ) const
inline

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

Definition at line 146 of file AutoScalingThresholds.h.

◆ GetIgnoreMetricsTime()

int Aws::OpsWorks::Model::AutoScalingThresholds::GetIgnoreMetricsTime ( ) const
inline

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

Definition at line 103 of file AutoScalingThresholds.h.

◆ GetInstanceCount()

int Aws::OpsWorks::Model::AutoScalingThresholds::GetInstanceCount ( ) const
inline

The number of instances to add or remove when the load exceeds a threshold.

Definition at line 47 of file AutoScalingThresholds.h.

◆ GetLoadThreshold()

double Aws::OpsWorks::Model::AutoScalingThresholds::GetLoadThreshold ( ) const
inline

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

Definition at line 198 of file AutoScalingThresholds.h.

◆ GetMemoryThreshold()

double Aws::OpsWorks::Model::AutoScalingThresholds::GetMemoryThreshold ( ) const
inline

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

Definition at line 171 of file AutoScalingThresholds.h.

◆ GetThresholdsWaitTime()

int Aws::OpsWorks::Model::AutoScalingThresholds::GetThresholdsWaitTime ( ) const
inline

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

Definition at line 72 of file AutoScalingThresholds.h.

◆ IgnoreMetricsTimeHasBeenSet()

bool Aws::OpsWorks::Model::AutoScalingThresholds::IgnoreMetricsTimeHasBeenSet ( ) const
inline

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

Definition at line 115 of file AutoScalingThresholds.h.

◆ InstanceCountHasBeenSet()

bool Aws::OpsWorks::Model::AutoScalingThresholds::InstanceCountHasBeenSet ( ) const
inline

The number of instances to add or remove when the load exceeds a threshold.

Definition at line 53 of file AutoScalingThresholds.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::OpsWorks::Model::AutoScalingThresholds::Jsonize ( ) const

◆ LoadThresholdHasBeenSet()

bool Aws::OpsWorks::Model::AutoScalingThresholds::LoadThresholdHasBeenSet ( ) const
inline

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

Definition at line 206 of file AutoScalingThresholds.h.

◆ MemoryThresholdHasBeenSet()

bool Aws::OpsWorks::Model::AutoScalingThresholds::MemoryThresholdHasBeenSet ( ) const
inline

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

Definition at line 177 of file AutoScalingThresholds.h.

◆ operator=()

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAlarms() [1/2]

void Aws::OpsWorks::Model::AutoScalingThresholds::SetAlarms ( const Aws::Vector< Aws::String > &  value)
inline

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Definition at line 259 of file AutoScalingThresholds.h.

◆ SetAlarms() [2/2]

void Aws::OpsWorks::Model::AutoScalingThresholds::SetAlarms ( Aws::Vector< Aws::String > &&  value)
inline

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Definition at line 271 of file AutoScalingThresholds.h.

◆ SetCpuThreshold()

void Aws::OpsWorks::Model::AutoScalingThresholds::SetCpuThreshold ( double  value)
inline

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

Definition at line 158 of file AutoScalingThresholds.h.

◆ SetIgnoreMetricsTime()

void Aws::OpsWorks::Model::AutoScalingThresholds::SetIgnoreMetricsTime ( int  value)
inline

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

Definition at line 127 of file AutoScalingThresholds.h.

◆ SetInstanceCount()

void Aws::OpsWorks::Model::AutoScalingThresholds::SetInstanceCount ( int  value)
inline

The number of instances to add or remove when the load exceeds a threshold.

Definition at line 59 of file AutoScalingThresholds.h.

◆ SetLoadThreshold()

void Aws::OpsWorks::Model::AutoScalingThresholds::SetLoadThreshold ( double  value)
inline

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

Definition at line 214 of file AutoScalingThresholds.h.

◆ SetMemoryThreshold()

void Aws::OpsWorks::Model::AutoScalingThresholds::SetMemoryThreshold ( double  value)
inline

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

Definition at line 183 of file AutoScalingThresholds.h.

◆ SetThresholdsWaitTime()

void Aws::OpsWorks::Model::AutoScalingThresholds::SetThresholdsWaitTime ( int  value)
inline

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

Definition at line 84 of file AutoScalingThresholds.h.

◆ ThresholdsWaitTimeHasBeenSet()

bool Aws::OpsWorks::Model::AutoScalingThresholds::ThresholdsWaitTimeHasBeenSet ( ) const
inline

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

Definition at line 78 of file AutoScalingThresholds.h.

◆ WithAlarms() [1/2]

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::WithAlarms ( const Aws::Vector< Aws::String > &  value)
inline

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Definition at line 283 of file AutoScalingThresholds.h.

◆ WithAlarms() [2/2]

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::WithAlarms ( Aws::Vector< Aws::String > &&  value)
inline

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Definition at line 295 of file AutoScalingThresholds.h.

◆ WithCpuThreshold()

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::WithCpuThreshold ( double  value)
inline

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

Definition at line 164 of file AutoScalingThresholds.h.

◆ WithIgnoreMetricsTime()

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::WithIgnoreMetricsTime ( int  value)
inline

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

Definition at line 139 of file AutoScalingThresholds.h.

◆ WithInstanceCount()

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::WithInstanceCount ( int  value)
inline

The number of instances to add or remove when the load exceeds a threshold.

Definition at line 65 of file AutoScalingThresholds.h.

◆ WithLoadThreshold()

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::WithLoadThreshold ( double  value)
inline

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

Definition at line 222 of file AutoScalingThresholds.h.

◆ WithMemoryThreshold()

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::WithMemoryThreshold ( double  value)
inline

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

Definition at line 189 of file AutoScalingThresholds.h.

◆ WithThresholdsWaitTime()

AutoScalingThresholds& Aws::OpsWorks::Model::AutoScalingThresholds::WithThresholdsWaitTime ( int  value)
inline

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

Definition at line 90 of file AutoScalingThresholds.h.


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