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

#include <ScalingPolicy.h>

Public Member Functions

 ScalingPolicy ()
 
 ScalingPolicy (const Aws::Utils::Xml::XmlNode &xmlNode)
 
ScalingPolicyoperator= (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::StringGetAutoScalingGroupName () const
 
bool AutoScalingGroupNameHasBeenSet () const
 
void SetAutoScalingGroupName (const Aws::String &value)
 
void SetAutoScalingGroupName (Aws::String &&value)
 
void SetAutoScalingGroupName (const char *value)
 
ScalingPolicyWithAutoScalingGroupName (const Aws::String &value)
 
ScalingPolicyWithAutoScalingGroupName (Aws::String &&value)
 
ScalingPolicyWithAutoScalingGroupName (const char *value)
 
const Aws::StringGetPolicyName () const
 
bool PolicyNameHasBeenSet () const
 
void SetPolicyName (const Aws::String &value)
 
void SetPolicyName (Aws::String &&value)
 
void SetPolicyName (const char *value)
 
ScalingPolicyWithPolicyName (const Aws::String &value)
 
ScalingPolicyWithPolicyName (Aws::String &&value)
 
ScalingPolicyWithPolicyName (const char *value)
 
const Aws::StringGetPolicyARN () const
 
bool PolicyARNHasBeenSet () const
 
void SetPolicyARN (const Aws::String &value)
 
void SetPolicyARN (Aws::String &&value)
 
void SetPolicyARN (const char *value)
 
ScalingPolicyWithPolicyARN (const Aws::String &value)
 
ScalingPolicyWithPolicyARN (Aws::String &&value)
 
ScalingPolicyWithPolicyARN (const char *value)
 
const Aws::StringGetPolicyType () const
 
bool PolicyTypeHasBeenSet () const
 
void SetPolicyType (const Aws::String &value)
 
void SetPolicyType (Aws::String &&value)
 
void SetPolicyType (const char *value)
 
ScalingPolicyWithPolicyType (const Aws::String &value)
 
ScalingPolicyWithPolicyType (Aws::String &&value)
 
ScalingPolicyWithPolicyType (const char *value)
 
const Aws::StringGetAdjustmentType () const
 
bool AdjustmentTypeHasBeenSet () const
 
void SetAdjustmentType (const Aws::String &value)
 
void SetAdjustmentType (Aws::String &&value)
 
void SetAdjustmentType (const char *value)
 
ScalingPolicyWithAdjustmentType (const Aws::String &value)
 
ScalingPolicyWithAdjustmentType (Aws::String &&value)
 
ScalingPolicyWithAdjustmentType (const char *value)
 
int GetMinAdjustmentStep () const
 
bool MinAdjustmentStepHasBeenSet () const
 
void SetMinAdjustmentStep (int value)
 
ScalingPolicyWithMinAdjustmentStep (int value)
 
int GetMinAdjustmentMagnitude () const
 
bool MinAdjustmentMagnitudeHasBeenSet () const
 
void SetMinAdjustmentMagnitude (int value)
 
ScalingPolicyWithMinAdjustmentMagnitude (int value)
 
int GetScalingAdjustment () const
 
bool ScalingAdjustmentHasBeenSet () const
 
void SetScalingAdjustment (int value)
 
ScalingPolicyWithScalingAdjustment (int value)
 
int GetCooldown () const
 
bool CooldownHasBeenSet () const
 
void SetCooldown (int value)
 
ScalingPolicyWithCooldown (int value)
 
const Aws::Vector< StepAdjustment > & GetStepAdjustments () const
 
bool StepAdjustmentsHasBeenSet () const
 
void SetStepAdjustments (const Aws::Vector< StepAdjustment > &value)
 
void SetStepAdjustments (Aws::Vector< StepAdjustment > &&value)
 
ScalingPolicyWithStepAdjustments (const Aws::Vector< StepAdjustment > &value)
 
ScalingPolicyWithStepAdjustments (Aws::Vector< StepAdjustment > &&value)
 
ScalingPolicyAddStepAdjustments (const StepAdjustment &value)
 
ScalingPolicyAddStepAdjustments (StepAdjustment &&value)
 
const Aws::StringGetMetricAggregationType () const
 
bool MetricAggregationTypeHasBeenSet () const
 
void SetMetricAggregationType (const Aws::String &value)
 
void SetMetricAggregationType (Aws::String &&value)
 
void SetMetricAggregationType (const char *value)
 
ScalingPolicyWithMetricAggregationType (const Aws::String &value)
 
ScalingPolicyWithMetricAggregationType (Aws::String &&value)
 
ScalingPolicyWithMetricAggregationType (const char *value)
 
int GetEstimatedInstanceWarmup () const
 
bool EstimatedInstanceWarmupHasBeenSet () const
 
void SetEstimatedInstanceWarmup (int value)
 
ScalingPolicyWithEstimatedInstanceWarmup (int value)
 
const Aws::Vector< Alarm > & GetAlarms () const
 
bool AlarmsHasBeenSet () const
 
void SetAlarms (const Aws::Vector< Alarm > &value)
 
void SetAlarms (Aws::Vector< Alarm > &&value)
 
ScalingPolicyWithAlarms (const Aws::Vector< Alarm > &value)
 
ScalingPolicyWithAlarms (Aws::Vector< Alarm > &&value)
 
ScalingPolicyAddAlarms (const Alarm &value)
 
ScalingPolicyAddAlarms (Alarm &&value)
 
const TargetTrackingConfigurationGetTargetTrackingConfiguration () const
 
bool TargetTrackingConfigurationHasBeenSet () const
 
void SetTargetTrackingConfiguration (const TargetTrackingConfiguration &value)
 
void SetTargetTrackingConfiguration (TargetTrackingConfiguration &&value)
 
ScalingPolicyWithTargetTrackingConfiguration (const TargetTrackingConfiguration &value)
 
ScalingPolicyWithTargetTrackingConfiguration (TargetTrackingConfiguration &&value)
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
ScalingPolicyWithEnabled (bool value)
 
const PredictiveScalingConfigurationGetPredictiveScalingConfiguration () const
 
bool PredictiveScalingConfigurationHasBeenSet () const
 
void SetPredictiveScalingConfiguration (const PredictiveScalingConfiguration &value)
 
void SetPredictiveScalingConfiguration (PredictiveScalingConfiguration &&value)
 
ScalingPolicyWithPredictiveScalingConfiguration (const PredictiveScalingConfiguration &value)
 
ScalingPolicyWithPredictiveScalingConfiguration (PredictiveScalingConfiguration &&value)
 

Detailed Description

Describes a scaling policy.

See Also:

AWS API Reference

Definition at line 36 of file ScalingPolicy.h.

Constructor & Destructor Documentation

◆ ScalingPolicy() [1/2]

Aws::AutoScaling::Model::ScalingPolicy::ScalingPolicy ( )

◆ ScalingPolicy() [2/2]

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

Member Function Documentation

◆ AddAlarms() [1/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::AddAlarms ( Alarm &&  value)
inline

The CloudWatch alarms related to the policy.

Definition at line 593 of file ScalingPolicy.h.

◆ AddAlarms() [2/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::AddAlarms ( const Alarm value)
inline

The CloudWatch alarms related to the policy.

Definition at line 588 of file ScalingPolicy.h.

◆ AddStepAdjustments() [1/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::AddStepAdjustments ( const StepAdjustment value)
inline

A set of adjustments that enable you to scale based on the size of the alarm breach.

Definition at line 472 of file ScalingPolicy.h.

◆ AddStepAdjustments() [2/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::AddStepAdjustments ( StepAdjustment &&  value)
inline

A set of adjustments that enable you to scale based on the size of the alarm breach.

Definition at line 478 of file ScalingPolicy.h.

◆ AdjustmentTypeHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::AdjustmentTypeHasBeenSet ( ) const
inline

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Definition at line 287 of file ScalingPolicy.h.

◆ AlarmsHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::AlarmsHasBeenSet ( ) const
inline

The CloudWatch alarms related to the policy.

Definition at line 563 of file ScalingPolicy.h.

◆ AutoScalingGroupNameHasBeenSet()

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

The name of the Auto Scaling group.

Definition at line 55 of file ScalingPolicy.h.

◆ CooldownHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::CooldownHasBeenSet ( ) const
inline

The duration of the policy's cooldown period, in seconds.

Definition at line 419 of file ScalingPolicy.h.

◆ EnabledHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::EnabledHasBeenSet ( ) const
inline

Indicates whether the policy is enabled (true) or disabled (false).

Definition at line 637 of file ScalingPolicy.h.

◆ EstimatedInstanceWarmupHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::EstimatedInstanceWarmupHasBeenSet ( ) const
inline

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Definition at line 540 of file ScalingPolicy.h.

◆ GetAdjustmentType()

const Aws::String& Aws::AutoScaling::Model::ScalingPolicy::GetAdjustmentType ( ) const
inline

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Definition at line 280 of file ScalingPolicy.h.

◆ GetAlarms()

const Aws::Vector<Alarm>& Aws::AutoScaling::Model::ScalingPolicy::GetAlarms ( ) const
inline

The CloudWatch alarms related to the policy.

Definition at line 558 of file ScalingPolicy.h.

◆ GetAutoScalingGroupName()

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

The name of the Auto Scaling group.

Definition at line 50 of file ScalingPolicy.h.

◆ GetCooldown()

int Aws::AutoScaling::Model::ScalingPolicy::GetCooldown ( ) const
inline

The duration of the policy's cooldown period, in seconds.

Definition at line 414 of file ScalingPolicy.h.

◆ GetEnabled()

bool Aws::AutoScaling::Model::ScalingPolicy::GetEnabled ( ) const
inline

Indicates whether the policy is enabled (true) or disabled (false).

Definition at line 631 of file ScalingPolicy.h.

◆ GetEstimatedInstanceWarmup()

int Aws::AutoScaling::Model::ScalingPolicy::GetEstimatedInstanceWarmup ( ) const
inline

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Definition at line 534 of file ScalingPolicy.h.

◆ GetMetricAggregationType()

const Aws::String& Aws::AutoScaling::Model::ScalingPolicy::GetMetricAggregationType ( ) const
inline

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Definition at line 485 of file ScalingPolicy.h.

◆ GetMinAdjustmentMagnitude()

int Aws::AutoScaling::Model::ScalingPolicy::GetMinAdjustmentMagnitude ( ) const
inline

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

Definition at line 361 of file ScalingPolicy.h.

◆ GetMinAdjustmentStep()

int Aws::AutoScaling::Model::ScalingPolicy::GetMinAdjustmentStep ( ) const
inline

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Definition at line 336 of file ScalingPolicy.h.

◆ GetPolicyARN()

const Aws::String& Aws::AutoScaling::Model::ScalingPolicy::GetPolicyARN ( ) const
inline

The Amazon Resource Name (ARN) of the policy.

Definition at line 132 of file ScalingPolicy.h.

◆ GetPolicyName()

const Aws::String& Aws::AutoScaling::Model::ScalingPolicy::GetPolicyName ( ) const
inline

The name of the scaling policy.

Definition at line 91 of file ScalingPolicy.h.

◆ GetPolicyType()

const Aws::String& Aws::AutoScaling::Model::ScalingPolicy::GetPolicyType ( ) const
inline

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

Definition at line 181 of file ScalingPolicy.h.

◆ GetPredictiveScalingConfiguration()

const PredictiveScalingConfiguration& Aws::AutoScaling::Model::ScalingPolicy::GetPredictiveScalingConfiguration ( ) const
inline

A predictive scaling policy.

Definition at line 655 of file ScalingPolicy.h.

◆ GetScalingAdjustment()

int Aws::AutoScaling::Model::ScalingPolicy::GetScalingAdjustment ( ) const
inline

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Definition at line 387 of file ScalingPolicy.h.

◆ GetStepAdjustments()

const Aws::Vector<StepAdjustment>& Aws::AutoScaling::Model::ScalingPolicy::GetStepAdjustments ( ) const
inline

A set of adjustments that enable you to scale based on the size of the alarm breach.

Definition at line 436 of file ScalingPolicy.h.

◆ GetTargetTrackingConfiguration()

const TargetTrackingConfiguration& Aws::AutoScaling::Model::ScalingPolicy::GetTargetTrackingConfiguration ( ) const
inline

A target tracking scaling policy.

Definition at line 599 of file ScalingPolicy.h.

◆ MetricAggregationTypeHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::MetricAggregationTypeHasBeenSet ( ) const
inline

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Definition at line 491 of file ScalingPolicy.h.

◆ MinAdjustmentMagnitudeHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::MinAdjustmentMagnitudeHasBeenSet ( ) const
inline

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

Definition at line 367 of file ScalingPolicy.h.

◆ MinAdjustmentStepHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::MinAdjustmentStepHasBeenSet ( ) const
inline

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Definition at line 342 of file ScalingPolicy.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ PolicyARNHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::PolicyARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the policy.

Definition at line 137 of file ScalingPolicy.h.

◆ PolicyNameHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::PolicyNameHasBeenSet ( ) const
inline

The name of the scaling policy.

Definition at line 96 of file ScalingPolicy.h.

◆ PolicyTypeHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::PolicyTypeHasBeenSet ( ) const
inline

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

Definition at line 194 of file ScalingPolicy.h.

◆ PredictiveScalingConfigurationHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::PredictiveScalingConfigurationHasBeenSet ( ) const
inline

A predictive scaling policy.

Definition at line 660 of file ScalingPolicy.h.

◆ ScalingAdjustmentHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::ScalingAdjustmentHasBeenSet ( ) const
inline

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Definition at line 394 of file ScalingPolicy.h.

◆ SetAdjustmentType() [1/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetAdjustmentType ( Aws::String &&  value)
inline

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Definition at line 301 of file ScalingPolicy.h.

◆ SetAdjustmentType() [2/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetAdjustmentType ( const Aws::String value)
inline

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Definition at line 294 of file ScalingPolicy.h.

◆ SetAdjustmentType() [3/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetAdjustmentType ( const char *  value)
inline

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Definition at line 308 of file ScalingPolicy.h.

◆ SetAlarms() [1/2]

void Aws::AutoScaling::Model::ScalingPolicy::SetAlarms ( Aws::Vector< Alarm > &&  value)
inline

The CloudWatch alarms related to the policy.

Definition at line 573 of file ScalingPolicy.h.

◆ SetAlarms() [2/2]

void Aws::AutoScaling::Model::ScalingPolicy::SetAlarms ( const Aws::Vector< Alarm > &  value)
inline

The CloudWatch alarms related to the policy.

Definition at line 568 of file ScalingPolicy.h.

◆ SetAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 65 of file ScalingPolicy.h.

◆ SetAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 60 of file ScalingPolicy.h.

◆ SetAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 70 of file ScalingPolicy.h.

◆ SetCooldown()

void Aws::AutoScaling::Model::ScalingPolicy::SetCooldown ( int  value)
inline

The duration of the policy's cooldown period, in seconds.

Definition at line 424 of file ScalingPolicy.h.

◆ SetEnabled()

void Aws::AutoScaling::Model::ScalingPolicy::SetEnabled ( bool  value)
inline

Indicates whether the policy is enabled (true) or disabled (false).

Definition at line 643 of file ScalingPolicy.h.

◆ SetEstimatedInstanceWarmup()

void Aws::AutoScaling::Model::ScalingPolicy::SetEstimatedInstanceWarmup ( int  value)
inline

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Definition at line 546 of file ScalingPolicy.h.

◆ SetMetricAggregationType() [1/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetMetricAggregationType ( Aws::String &&  value)
inline

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Definition at line 503 of file ScalingPolicy.h.

◆ SetMetricAggregationType() [2/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetMetricAggregationType ( const Aws::String value)
inline

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Definition at line 497 of file ScalingPolicy.h.

◆ SetMetricAggregationType() [3/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetMetricAggregationType ( const char *  value)
inline

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Definition at line 509 of file ScalingPolicy.h.

◆ SetMinAdjustmentMagnitude()

void Aws::AutoScaling::Model::ScalingPolicy::SetMinAdjustmentMagnitude ( int  value)
inline

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

Definition at line 373 of file ScalingPolicy.h.

◆ SetMinAdjustmentStep()

void Aws::AutoScaling::Model::ScalingPolicy::SetMinAdjustmentStep ( int  value)
inline

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Definition at line 348 of file ScalingPolicy.h.

◆ SetPolicyARN() [1/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetPolicyARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the policy.

Definition at line 147 of file ScalingPolicy.h.

◆ SetPolicyARN() [2/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetPolicyARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the policy.

Definition at line 142 of file ScalingPolicy.h.

◆ SetPolicyARN() [3/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetPolicyARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the policy.

Definition at line 152 of file ScalingPolicy.h.

◆ SetPolicyName() [1/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetPolicyName ( Aws::String &&  value)
inline

The name of the scaling policy.

Definition at line 106 of file ScalingPolicy.h.

◆ SetPolicyName() [2/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetPolicyName ( const Aws::String value)
inline

The name of the scaling policy.

Definition at line 101 of file ScalingPolicy.h.

◆ SetPolicyName() [3/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetPolicyName ( const char *  value)
inline

The name of the scaling policy.

Definition at line 111 of file ScalingPolicy.h.

◆ SetPolicyType() [1/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetPolicyType ( Aws::String &&  value)
inline

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

Definition at line 220 of file ScalingPolicy.h.

◆ SetPolicyType() [2/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetPolicyType ( const Aws::String value)
inline

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

Definition at line 207 of file ScalingPolicy.h.

◆ SetPolicyType() [3/3]

void Aws::AutoScaling::Model::ScalingPolicy::SetPolicyType ( const char *  value)
inline

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

Definition at line 233 of file ScalingPolicy.h.

◆ SetPredictiveScalingConfiguration() [1/2]

void Aws::AutoScaling::Model::ScalingPolicy::SetPredictiveScalingConfiguration ( const PredictiveScalingConfiguration value)
inline

A predictive scaling policy.

Definition at line 665 of file ScalingPolicy.h.

◆ SetPredictiveScalingConfiguration() [2/2]

void Aws::AutoScaling::Model::ScalingPolicy::SetPredictiveScalingConfiguration ( PredictiveScalingConfiguration &&  value)
inline

A predictive scaling policy.

Definition at line 670 of file ScalingPolicy.h.

◆ SetScalingAdjustment()

void Aws::AutoScaling::Model::ScalingPolicy::SetScalingAdjustment ( int  value)
inline

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Definition at line 401 of file ScalingPolicy.h.

◆ SetStepAdjustments() [1/2]

void Aws::AutoScaling::Model::ScalingPolicy::SetStepAdjustments ( Aws::Vector< StepAdjustment > &&  value)
inline

A set of adjustments that enable you to scale based on the size of the alarm breach.

Definition at line 454 of file ScalingPolicy.h.

◆ SetStepAdjustments() [2/2]

void Aws::AutoScaling::Model::ScalingPolicy::SetStepAdjustments ( const Aws::Vector< StepAdjustment > &  value)
inline

A set of adjustments that enable you to scale based on the size of the alarm breach.

Definition at line 448 of file ScalingPolicy.h.

◆ SetTargetTrackingConfiguration() [1/2]

void Aws::AutoScaling::Model::ScalingPolicy::SetTargetTrackingConfiguration ( const TargetTrackingConfiguration value)
inline

A target tracking scaling policy.

Definition at line 609 of file ScalingPolicy.h.

◆ SetTargetTrackingConfiguration() [2/2]

void Aws::AutoScaling::Model::ScalingPolicy::SetTargetTrackingConfiguration ( TargetTrackingConfiguration &&  value)
inline

A target tracking scaling policy.

Definition at line 614 of file ScalingPolicy.h.

◆ StepAdjustmentsHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::StepAdjustmentsHasBeenSet ( ) const
inline

A set of adjustments that enable you to scale based on the size of the alarm breach.

Definition at line 442 of file ScalingPolicy.h.

◆ TargetTrackingConfigurationHasBeenSet()

bool Aws::AutoScaling::Model::ScalingPolicy::TargetTrackingConfigurationHasBeenSet ( ) const
inline

A target tracking scaling policy.

Definition at line 604 of file ScalingPolicy.h.

◆ WithAdjustmentType() [1/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithAdjustmentType ( Aws::String &&  value)
inline

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Definition at line 322 of file ScalingPolicy.h.

◆ WithAdjustmentType() [2/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithAdjustmentType ( const Aws::String value)
inline

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Definition at line 315 of file ScalingPolicy.h.

◆ WithAdjustmentType() [3/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithAdjustmentType ( const char *  value)
inline

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Definition at line 329 of file ScalingPolicy.h.

◆ WithAlarms() [1/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithAlarms ( Aws::Vector< Alarm > &&  value)
inline

The CloudWatch alarms related to the policy.

Definition at line 583 of file ScalingPolicy.h.

◆ WithAlarms() [2/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithAlarms ( const Aws::Vector< Alarm > &  value)
inline

The CloudWatch alarms related to the policy.

Definition at line 578 of file ScalingPolicy.h.

◆ WithAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 80 of file ScalingPolicy.h.

◆ WithAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 75 of file ScalingPolicy.h.

◆ WithAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 85 of file ScalingPolicy.h.

◆ WithCooldown()

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithCooldown ( int  value)
inline

The duration of the policy's cooldown period, in seconds.

Definition at line 429 of file ScalingPolicy.h.

◆ WithEnabled()

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithEnabled ( bool  value)
inline

Indicates whether the policy is enabled (true) or disabled (false).

Definition at line 649 of file ScalingPolicy.h.

◆ WithEstimatedInstanceWarmup()

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithEstimatedInstanceWarmup ( int  value)
inline

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Definition at line 552 of file ScalingPolicy.h.

◆ WithMetricAggregationType() [1/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithMetricAggregationType ( Aws::String &&  value)
inline

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Definition at line 521 of file ScalingPolicy.h.

◆ WithMetricAggregationType() [2/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithMetricAggregationType ( const Aws::String value)
inline

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Definition at line 515 of file ScalingPolicy.h.

◆ WithMetricAggregationType() [3/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithMetricAggregationType ( const char *  value)
inline

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Definition at line 527 of file ScalingPolicy.h.

◆ WithMinAdjustmentMagnitude()

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithMinAdjustmentMagnitude ( int  value)
inline

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

Definition at line 379 of file ScalingPolicy.h.

◆ WithMinAdjustmentStep()

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithMinAdjustmentStep ( int  value)
inline

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Definition at line 354 of file ScalingPolicy.h.

◆ WithPolicyARN() [1/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPolicyARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the policy.

Definition at line 162 of file ScalingPolicy.h.

◆ WithPolicyARN() [2/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPolicyARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the policy.

Definition at line 157 of file ScalingPolicy.h.

◆ WithPolicyARN() [3/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPolicyARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the policy.

Definition at line 167 of file ScalingPolicy.h.

◆ WithPolicyName() [1/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPolicyName ( Aws::String &&  value)
inline

The name of the scaling policy.

Definition at line 121 of file ScalingPolicy.h.

◆ WithPolicyName() [2/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPolicyName ( const Aws::String value)
inline

The name of the scaling policy.

Definition at line 116 of file ScalingPolicy.h.

◆ WithPolicyName() [3/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPolicyName ( const char *  value)
inline

The name of the scaling policy.

Definition at line 126 of file ScalingPolicy.h.

◆ WithPolicyType() [1/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPolicyType ( Aws::String &&  value)
inline

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

Definition at line 259 of file ScalingPolicy.h.

◆ WithPolicyType() [2/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPolicyType ( const Aws::String value)
inline

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

Definition at line 246 of file ScalingPolicy.h.

◆ WithPolicyType() [3/3]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPolicyType ( const char *  value)
inline

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

Definition at line 272 of file ScalingPolicy.h.

◆ WithPredictiveScalingConfiguration() [1/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPredictiveScalingConfiguration ( const PredictiveScalingConfiguration value)
inline

A predictive scaling policy.

Definition at line 675 of file ScalingPolicy.h.

◆ WithPredictiveScalingConfiguration() [2/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithPredictiveScalingConfiguration ( PredictiveScalingConfiguration &&  value)
inline

A predictive scaling policy.

Definition at line 680 of file ScalingPolicy.h.

◆ WithScalingAdjustment()

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithScalingAdjustment ( int  value)
inline

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Definition at line 408 of file ScalingPolicy.h.

◆ WithStepAdjustments() [1/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithStepAdjustments ( Aws::Vector< StepAdjustment > &&  value)
inline

A set of adjustments that enable you to scale based on the size of the alarm breach.

Definition at line 466 of file ScalingPolicy.h.

◆ WithStepAdjustments() [2/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithStepAdjustments ( const Aws::Vector< StepAdjustment > &  value)
inline

A set of adjustments that enable you to scale based on the size of the alarm breach.

Definition at line 460 of file ScalingPolicy.h.

◆ WithTargetTrackingConfiguration() [1/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithTargetTrackingConfiguration ( const TargetTrackingConfiguration value)
inline

A target tracking scaling policy.

Definition at line 619 of file ScalingPolicy.h.

◆ WithTargetTrackingConfiguration() [2/2]

ScalingPolicy& Aws::AutoScaling::Model::ScalingPolicy::WithTargetTrackingConfiguration ( TargetTrackingConfiguration &&  value)
inline

A target tracking scaling policy.

Definition at line 624 of file ScalingPolicy.h.


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