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

#include <ManagedScaling.h>

Public Member Functions

 ManagedScaling ()
 
 ManagedScaling (Aws::Utils::Json::JsonView jsonValue)
 
ManagedScalingoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ManagedScalingStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ManagedScalingStatus &value)
 
void SetStatus (ManagedScalingStatus &&value)
 
ManagedScalingWithStatus (const ManagedScalingStatus &value)
 
ManagedScalingWithStatus (ManagedScalingStatus &&value)
 
int GetTargetCapacity () const
 
bool TargetCapacityHasBeenSet () const
 
void SetTargetCapacity (int value)
 
ManagedScalingWithTargetCapacity (int value)
 
int GetMinimumScalingStepSize () const
 
bool MinimumScalingStepSizeHasBeenSet () const
 
void SetMinimumScalingStepSize (int value)
 
ManagedScalingWithMinimumScalingStepSize (int value)
 
int GetMaximumScalingStepSize () const
 
bool MaximumScalingStepSizeHasBeenSet () const
 
void SetMaximumScalingStepSize (int value)
 
ManagedScalingWithMaximumScalingStepSize (int value)
 
int GetInstanceWarmupPeriod () const
 
bool InstanceWarmupPeriodHasBeenSet () const
 
void SetInstanceWarmupPeriod (int value)
 
ManagedScalingWithInstanceWarmupPeriod (int value)
 

Detailed Description

The managed scaling settings for the Auto Scaling group capacity provider.

When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS-managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.

If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.

See Also:

AWS API Reference

Definition at line 40 of file ManagedScaling.h.

Constructor & Destructor Documentation

◆ ManagedScaling() [1/2]

Aws::ECS::Model::ManagedScaling::ManagedScaling ( )

◆ ManagedScaling() [2/2]

Aws::ECS::Model::ManagedScaling::ManagedScaling ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetInstanceWarmupPeriod()

int Aws::ECS::Model::ManagedScaling::GetInstanceWarmupPeriod ( ) const
inline

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

Definition at line 176 of file ManagedScaling.h.

◆ GetMaximumScalingStepSize()

int Aws::ECS::Model::ManagedScaling::GetMaximumScalingStepSize ( ) const
inline

The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000 is used.

Definition at line 147 of file ManagedScaling.h.

◆ GetMinimumScalingStepSize()

int Aws::ECS::Model::ManagedScaling::GetMinimumScalingStepSize ( ) const
inline

The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1 is used.

Definition at line 118 of file ManagedScaling.h.

◆ GetStatus()

const ManagedScalingStatus& Aws::ECS::Model::ManagedScaling::GetStatus ( ) const
inline

Whether or not to enable managed scaling for the capacity provider.

Definition at line 52 of file ManagedScaling.h.

◆ GetTargetCapacity()

int Aws::ECS::Model::ManagedScaling::GetTargetCapacity ( ) const
inline

The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.

Definition at line 86 of file ManagedScaling.h.

◆ InstanceWarmupPeriodHasBeenSet()

bool Aws::ECS::Model::ManagedScaling::InstanceWarmupPeriodHasBeenSet ( ) const
inline

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

Definition at line 183 of file ManagedScaling.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::ManagedScaling::Jsonize ( ) const

◆ MaximumScalingStepSizeHasBeenSet()

bool Aws::ECS::Model::ManagedScaling::MaximumScalingStepSizeHasBeenSet ( ) const
inline

The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000 is used.

Definition at line 154 of file ManagedScaling.h.

◆ MinimumScalingStepSizeHasBeenSet()

bool Aws::ECS::Model::ManagedScaling::MinimumScalingStepSizeHasBeenSet ( ) const
inline

The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1 is used.

Definition at line 125 of file ManagedScaling.h.

◆ operator=()

ManagedScaling& Aws::ECS::Model::ManagedScaling::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetInstanceWarmupPeriod()

void Aws::ECS::Model::ManagedScaling::SetInstanceWarmupPeriod ( int  value)
inline

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

Definition at line 190 of file ManagedScaling.h.

◆ SetMaximumScalingStepSize()

void Aws::ECS::Model::ManagedScaling::SetMaximumScalingStepSize ( int  value)
inline

The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000 is used.

Definition at line 161 of file ManagedScaling.h.

◆ SetMinimumScalingStepSize()

void Aws::ECS::Model::ManagedScaling::SetMinimumScalingStepSize ( int  value)
inline

The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1 is used.

Definition at line 132 of file ManagedScaling.h.

◆ SetStatus() [1/2]

void Aws::ECS::Model::ManagedScaling::SetStatus ( const ManagedScalingStatus value)
inline

Whether or not to enable managed scaling for the capacity provider.

Definition at line 62 of file ManagedScaling.h.

◆ SetStatus() [2/2]

void Aws::ECS::Model::ManagedScaling::SetStatus ( ManagedScalingStatus &&  value)
inline

Whether or not to enable managed scaling for the capacity provider.

Definition at line 67 of file ManagedScaling.h.

◆ SetTargetCapacity()

void Aws::ECS::Model::ManagedScaling::SetTargetCapacity ( int  value)
inline

The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.

Definition at line 102 of file ManagedScaling.h.

◆ StatusHasBeenSet()

bool Aws::ECS::Model::ManagedScaling::StatusHasBeenSet ( ) const
inline

Whether or not to enable managed scaling for the capacity provider.

Definition at line 57 of file ManagedScaling.h.

◆ TargetCapacityHasBeenSet()

bool Aws::ECS::Model::ManagedScaling::TargetCapacityHasBeenSet ( ) const
inline

The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.

Definition at line 94 of file ManagedScaling.h.

◆ WithInstanceWarmupPeriod()

ManagedScaling& Aws::ECS::Model::ManagedScaling::WithInstanceWarmupPeriod ( int  value)
inline

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

Definition at line 197 of file ManagedScaling.h.

◆ WithMaximumScalingStepSize()

ManagedScaling& Aws::ECS::Model::ManagedScaling::WithMaximumScalingStepSize ( int  value)
inline

The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000 is used.

Definition at line 168 of file ManagedScaling.h.

◆ WithMinimumScalingStepSize()

ManagedScaling& Aws::ECS::Model::ManagedScaling::WithMinimumScalingStepSize ( int  value)
inline

The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1 is used.

Definition at line 139 of file ManagedScaling.h.

◆ WithStatus() [1/2]

ManagedScaling& Aws::ECS::Model::ManagedScaling::WithStatus ( const ManagedScalingStatus value)
inline

Whether or not to enable managed scaling for the capacity provider.

Definition at line 72 of file ManagedScaling.h.

◆ WithStatus() [2/2]

ManagedScaling& Aws::ECS::Model::ManagedScaling::WithStatus ( ManagedScalingStatus &&  value)
inline

Whether or not to enable managed scaling for the capacity provider.

Definition at line 77 of file ManagedScaling.h.

◆ WithTargetCapacity()

ManagedScaling& Aws::ECS::Model::ManagedScaling::WithTargetCapacity ( int  value)
inline

The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.

Definition at line 110 of file ManagedScaling.h.


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