AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::AutoScaling::Model::PutScalingPolicyRequest Class Reference

#include <PutScalingPolicyRequest.h>

+ Inheritance diagram for Aws::AutoScaling::Model::PutScalingPolicyRequest:

Public Member Functions

 PutScalingPolicyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetAutoScalingGroupName () const
 
bool AutoScalingGroupNameHasBeenSet () const
 
void SetAutoScalingGroupName (const Aws::String &value)
 
void SetAutoScalingGroupName (Aws::String &&value)
 
void SetAutoScalingGroupName (const char *value)
 
PutScalingPolicyRequestWithAutoScalingGroupName (const Aws::String &value)
 
PutScalingPolicyRequestWithAutoScalingGroupName (Aws::String &&value)
 
PutScalingPolicyRequestWithAutoScalingGroupName (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)
 
PutScalingPolicyRequestWithPolicyName (const Aws::String &value)
 
PutScalingPolicyRequestWithPolicyName (Aws::String &&value)
 
PutScalingPolicyRequestWithPolicyName (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)
 
PutScalingPolicyRequestWithPolicyType (const Aws::String &value)
 
PutScalingPolicyRequestWithPolicyType (Aws::String &&value)
 
PutScalingPolicyRequestWithPolicyType (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)
 
PutScalingPolicyRequestWithAdjustmentType (const Aws::String &value)
 
PutScalingPolicyRequestWithAdjustmentType (Aws::String &&value)
 
PutScalingPolicyRequestWithAdjustmentType (const char *value)
 
int GetMinAdjustmentStep () const
 
bool MinAdjustmentStepHasBeenSet () const
 
void SetMinAdjustmentStep (int value)
 
PutScalingPolicyRequestWithMinAdjustmentStep (int value)
 
int GetMinAdjustmentMagnitude () const
 
bool MinAdjustmentMagnitudeHasBeenSet () const
 
void SetMinAdjustmentMagnitude (int value)
 
PutScalingPolicyRequestWithMinAdjustmentMagnitude (int value)
 
int GetScalingAdjustment () const
 
bool ScalingAdjustmentHasBeenSet () const
 
void SetScalingAdjustment (int value)
 
PutScalingPolicyRequestWithScalingAdjustment (int value)
 
int GetCooldown () const
 
bool CooldownHasBeenSet () const
 
void SetCooldown (int value)
 
PutScalingPolicyRequestWithCooldown (int value)
 
const Aws::StringGetMetricAggregationType () const
 
bool MetricAggregationTypeHasBeenSet () const
 
void SetMetricAggregationType (const Aws::String &value)
 
void SetMetricAggregationType (Aws::String &&value)
 
void SetMetricAggregationType (const char *value)
 
PutScalingPolicyRequestWithMetricAggregationType (const Aws::String &value)
 
PutScalingPolicyRequestWithMetricAggregationType (Aws::String &&value)
 
PutScalingPolicyRequestWithMetricAggregationType (const char *value)
 
const Aws::Vector< StepAdjustment > & GetStepAdjustments () const
 
bool StepAdjustmentsHasBeenSet () const
 
void SetStepAdjustments (const Aws::Vector< StepAdjustment > &value)
 
void SetStepAdjustments (Aws::Vector< StepAdjustment > &&value)
 
PutScalingPolicyRequestWithStepAdjustments (const Aws::Vector< StepAdjustment > &value)
 
PutScalingPolicyRequestWithStepAdjustments (Aws::Vector< StepAdjustment > &&value)
 
PutScalingPolicyRequestAddStepAdjustments (const StepAdjustment &value)
 
PutScalingPolicyRequestAddStepAdjustments (StepAdjustment &&value)
 
int GetEstimatedInstanceWarmup () const
 
bool EstimatedInstanceWarmupHasBeenSet () const
 
void SetEstimatedInstanceWarmup (int value)
 
PutScalingPolicyRequestWithEstimatedInstanceWarmup (int value)
 
const TargetTrackingConfigurationGetTargetTrackingConfiguration () const
 
bool TargetTrackingConfigurationHasBeenSet () const
 
void SetTargetTrackingConfiguration (const TargetTrackingConfiguration &value)
 
void SetTargetTrackingConfiguration (TargetTrackingConfiguration &&value)
 
PutScalingPolicyRequestWithTargetTrackingConfiguration (const TargetTrackingConfiguration &value)
 
PutScalingPolicyRequestWithTargetTrackingConfiguration (TargetTrackingConfiguration &&value)
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
PutScalingPolicyRequestWithEnabled (bool value)
 
- Public Member Functions inherited from Aws::AutoScaling::AutoScalingRequest
virtual ~AutoScalingRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::AutoScaling::AutoScalingRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 24 of file PutScalingPolicyRequest.h.

Constructor & Destructor Documentation

◆ PutScalingPolicyRequest()

Aws::AutoScaling::Model::PutScalingPolicyRequest::PutScalingPolicyRequest ( )

Member Function Documentation

◆ AddStepAdjustments() [1/2]

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

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

Required if the policy type is StepScaling. (Not used with any other policy type.)

Definition at line 562 of file PutScalingPolicyRequest.h.

◆ AddStepAdjustments() [2/2]

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

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

Required if the policy type is StepScaling. (Not used with any other policy type.)

Definition at line 569 of file PutScalingPolicyRequest.h.

◆ AdjustmentTypeHasBeenSet()

bool Aws::AutoScaling::Model::PutScalingPolicyRequest::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.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Definition at line 201 of file PutScalingPolicyRequest.h.

◆ AutoScalingGroupNameHasBeenSet()

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

The name of the Auto Scaling group.

Definition at line 50 of file PutScalingPolicyRequest.h.

◆ CooldownHasBeenSet()

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

The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 425 of file PutScalingPolicyRequest.h.

◆ DumpBodyToUrl()

void Aws::AutoScaling::Model::PutScalingPolicyRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EnabledHasBeenSet()

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

Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 722 of file PutScalingPolicyRequest.h.

◆ EstimatedInstanceWarmupHasBeenSet()

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

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.

Valid only if the policy type is TargetTrackingScaling or StepScaling.

Definition at line 588 of file PutScalingPolicyRequest.h.

◆ GetAdjustmentType()

const Aws::String& Aws::AutoScaling::Model::PutScalingPolicyRequest::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.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Definition at line 190 of file PutScalingPolicyRequest.h.

◆ GetAutoScalingGroupName()

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

The name of the Auto Scaling group.

Definition at line 45 of file PutScalingPolicyRequest.h.

◆ GetCooldown()

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

The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 414 of file PutScalingPolicyRequest.h.

◆ GetEnabled()

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

Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 713 of file PutScalingPolicyRequest.h.

◆ GetEstimatedInstanceWarmup()

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

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.

Valid only if the policy type is TargetTrackingScaling or StepScaling.

Definition at line 579 of file PutScalingPolicyRequest.h.

◆ GetMetricAggregationType()

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Definition at line 456 of file PutScalingPolicyRequest.h.

◆ GetMinAdjustmentMagnitude()

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

The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

Definition at line 311 of file PutScalingPolicyRequest.h.

◆ GetMinAdjustmentStep()

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

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Definition at line 274 of file PutScalingPolicyRequest.h.

◆ GetPolicyName()

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

The name of the policy.

Definition at line 86 of file PutScalingPolicyRequest.h.

◆ GetPolicyType()

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

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

Definition at line 129 of file PutScalingPolicyRequest.h.

◆ GetScalingAdjustment()

int Aws::AutoScaling::Model::PutScalingPolicyRequest::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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

Definition at line 375 of file PutScalingPolicyRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::AutoScaling::Model::PutScalingPolicyRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file PutScalingPolicyRequest.h.

◆ GetStepAdjustments()

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

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

Required if the policy type is StepScaling. (Not used with any other policy type.)

Definition at line 520 of file PutScalingPolicyRequest.h.

◆ GetTargetTrackingConfiguration()

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

A target tracking scaling policy. Includes support for predefined or customized metrics.

The following predefined metrics are available:

  • ASGAverageCPUUtilization

  • ASGAverageNetworkIn

  • ASGAverageNetworkOut

  • ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel parameter with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

Definition at line 623 of file PutScalingPolicyRequest.h.

◆ MetricAggregationTypeHasBeenSet()

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Definition at line 464 of file PutScalingPolicyRequest.h.

◆ MinAdjustmentMagnitudeHasBeenSet()

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

The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

Definition at line 329 of file PutScalingPolicyRequest.h.

◆ MinAdjustmentStepHasBeenSet()

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

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Definition at line 280 of file PutScalingPolicyRequest.h.

◆ PolicyNameHasBeenSet()

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

The name of the policy.

Definition at line 91 of file PutScalingPolicyRequest.h.

◆ PolicyTypeHasBeenSet()

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

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

Definition at line 136 of file PutScalingPolicyRequest.h.

◆ ScalingAdjustmentHasBeenSet()

bool Aws::AutoScaling::Model::PutScalingPolicyRequest::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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

Definition at line 384 of file PutScalingPolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::AutoScaling::Model::PutScalingPolicyRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAdjustmentType() [1/3]

void Aws::AutoScaling::Model::PutScalingPolicyRequest::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.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Definition at line 212 of file PutScalingPolicyRequest.h.

◆ SetAdjustmentType() [2/3]

void Aws::AutoScaling::Model::PutScalingPolicyRequest::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.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Definition at line 223 of file PutScalingPolicyRequest.h.

◆ SetAdjustmentType() [3/3]

void Aws::AutoScaling::Model::PutScalingPolicyRequest::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.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Definition at line 234 of file PutScalingPolicyRequest.h.

◆ SetAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 55 of file PutScalingPolicyRequest.h.

◆ SetAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 60 of file PutScalingPolicyRequest.h.

◆ SetAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 65 of file PutScalingPolicyRequest.h.

◆ SetCooldown()

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

The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 436 of file PutScalingPolicyRequest.h.

◆ SetEnabled()

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

Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 731 of file PutScalingPolicyRequest.h.

◆ SetEstimatedInstanceWarmup()

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

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.

Valid only if the policy type is TargetTrackingScaling or StepScaling.

Definition at line 597 of file PutScalingPolicyRequest.h.

◆ SetMetricAggregationType() [1/3]

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Definition at line 472 of file PutScalingPolicyRequest.h.

◆ SetMetricAggregationType() [2/3]

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Definition at line 480 of file PutScalingPolicyRequest.h.

◆ SetMetricAggregationType() [3/3]

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Definition at line 488 of file PutScalingPolicyRequest.h.

◆ SetMinAdjustmentMagnitude()

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

The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

Definition at line 347 of file PutScalingPolicyRequest.h.

◆ SetMinAdjustmentStep()

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

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Definition at line 286 of file PutScalingPolicyRequest.h.

◆ SetPolicyName() [1/3]

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

The name of the policy.

Definition at line 96 of file PutScalingPolicyRequest.h.

◆ SetPolicyName() [2/3]

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

The name of the policy.

Definition at line 101 of file PutScalingPolicyRequest.h.

◆ SetPolicyName() [3/3]

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

The name of the policy.

Definition at line 106 of file PutScalingPolicyRequest.h.

◆ SetPolicyType() [1/3]

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

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

Definition at line 143 of file PutScalingPolicyRequest.h.

◆ SetPolicyType() [2/3]

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

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

Definition at line 150 of file PutScalingPolicyRequest.h.

◆ SetPolicyType() [3/3]

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

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

Definition at line 157 of file PutScalingPolicyRequest.h.

◆ SetScalingAdjustment()

void Aws::AutoScaling::Model::PutScalingPolicyRequest::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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

Definition at line 393 of file PutScalingPolicyRequest.h.

◆ SetStepAdjustments() [1/2]

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

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

Required if the policy type is StepScaling. (Not used with any other policy type.)

Definition at line 534 of file PutScalingPolicyRequest.h.

◆ SetStepAdjustments() [2/2]

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

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

Required if the policy type is StepScaling. (Not used with any other policy type.)

Definition at line 541 of file PutScalingPolicyRequest.h.

◆ SetTargetTrackingConfiguration() [1/2]

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

A target tracking scaling policy. Includes support for predefined or customized metrics.

The following predefined metrics are available:

  • ASGAverageCPUUtilization

  • ASGAverageNetworkIn

  • ASGAverageNetworkOut

  • ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel parameter with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

Definition at line 655 of file PutScalingPolicyRequest.h.

◆ SetTargetTrackingConfiguration() [2/2]

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

A target tracking scaling policy. Includes support for predefined or customized metrics.

The following predefined metrics are available:

  • ASGAverageCPUUtilization

  • ASGAverageNetworkIn

  • ASGAverageNetworkOut

  • ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel parameter with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

Definition at line 671 of file PutScalingPolicyRequest.h.

◆ StepAdjustmentsHasBeenSet()

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

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

Required if the policy type is StepScaling. (Not used with any other policy type.)

Definition at line 527 of file PutScalingPolicyRequest.h.

◆ TargetTrackingConfigurationHasBeenSet()

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

A target tracking scaling policy. Includes support for predefined or customized metrics.

The following predefined metrics are available:

  • ASGAverageCPUUtilization

  • ASGAverageNetworkIn

  • ASGAverageNetworkOut

  • ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel parameter with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

Definition at line 639 of file PutScalingPolicyRequest.h.

◆ WithAdjustmentType() [1/3]

PutScalingPolicyRequest& Aws::AutoScaling::Model::PutScalingPolicyRequest::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.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Definition at line 245 of file PutScalingPolicyRequest.h.

◆ WithAdjustmentType() [2/3]

PutScalingPolicyRequest& Aws::AutoScaling::Model::PutScalingPolicyRequest::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.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Definition at line 256 of file PutScalingPolicyRequest.h.

◆ WithAdjustmentType() [3/3]

PutScalingPolicyRequest& Aws::AutoScaling::Model::PutScalingPolicyRequest::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.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Definition at line 267 of file PutScalingPolicyRequest.h.

◆ WithAutoScalingGroupName() [1/3]

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

The name of the Auto Scaling group.

Definition at line 70 of file PutScalingPolicyRequest.h.

◆ WithAutoScalingGroupName() [2/3]

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

The name of the Auto Scaling group.

Definition at line 75 of file PutScalingPolicyRequest.h.

◆ WithAutoScalingGroupName() [3/3]

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

The name of the Auto Scaling group.

Definition at line 80 of file PutScalingPolicyRequest.h.

◆ WithCooldown()

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

The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 447 of file PutScalingPolicyRequest.h.

◆ WithEnabled()

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

Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 740 of file PutScalingPolicyRequest.h.

◆ WithEstimatedInstanceWarmup()

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

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.

Valid only if the policy type is TargetTrackingScaling or StepScaling.

Definition at line 606 of file PutScalingPolicyRequest.h.

◆ WithMetricAggregationType() [1/3]

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Definition at line 496 of file PutScalingPolicyRequest.h.

◆ WithMetricAggregationType() [2/3]

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Definition at line 504 of file PutScalingPolicyRequest.h.

◆ WithMetricAggregationType() [3/3]

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Definition at line 512 of file PutScalingPolicyRequest.h.

◆ WithMinAdjustmentMagnitude()

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

The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

Definition at line 365 of file PutScalingPolicyRequest.h.

◆ WithMinAdjustmentStep()

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

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Definition at line 292 of file PutScalingPolicyRequest.h.

◆ WithPolicyName() [1/3]

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

The name of the policy.

Definition at line 111 of file PutScalingPolicyRequest.h.

◆ WithPolicyName() [2/3]

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

The name of the policy.

Definition at line 116 of file PutScalingPolicyRequest.h.

◆ WithPolicyName() [3/3]

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

The name of the policy.

Definition at line 121 of file PutScalingPolicyRequest.h.

◆ WithPolicyType() [1/3]

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

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

Definition at line 164 of file PutScalingPolicyRequest.h.

◆ WithPolicyType() [2/3]

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

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

Definition at line 171 of file PutScalingPolicyRequest.h.

◆ WithPolicyType() [3/3]

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

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

Definition at line 178 of file PutScalingPolicyRequest.h.

◆ WithScalingAdjustment()

PutScalingPolicyRequest& Aws::AutoScaling::Model::PutScalingPolicyRequest::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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

Definition at line 402 of file PutScalingPolicyRequest.h.

◆ WithStepAdjustments() [1/2]

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

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

Required if the policy type is StepScaling. (Not used with any other policy type.)

Definition at line 548 of file PutScalingPolicyRequest.h.

◆ WithStepAdjustments() [2/2]

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

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

Required if the policy type is StepScaling. (Not used with any other policy type.)

Definition at line 555 of file PutScalingPolicyRequest.h.

◆ WithTargetTrackingConfiguration() [1/2]

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

A target tracking scaling policy. Includes support for predefined or customized metrics.

The following predefined metrics are available:

  • ASGAverageCPUUtilization

  • ASGAverageNetworkIn

  • ASGAverageNetworkOut

  • ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel parameter with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

Definition at line 687 of file PutScalingPolicyRequest.h.

◆ WithTargetTrackingConfiguration() [2/2]

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

A target tracking scaling policy. Includes support for predefined or customized metrics.

The following predefined metrics are available:

  • ASGAverageCPUUtilization

  • ASGAverageNetworkIn

  • ASGAverageNetworkOut

  • ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel parameter with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

Definition at line 703 of file PutScalingPolicyRequest.h.


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