/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::AutoScaling::PutScalingPolicy

NAME

Paws::AutoScaling::PutScalingPolicy - Arguments for method PutScalingPolicy on Paws::AutoScaling

DESCRIPTION

This class represents the parameters used for calling the method PutScalingPolicy on the Auto Scaling service. Use the attributes of this class as arguments to method PutScalingPolicy.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutScalingPolicy.

SYNOPSIS

 my $autoscaling = Paws->service('AutoScaling');
# To add a scaling policy to an Auto Scaling group
# This example adds the specified policy to the specified Auto Scaling group.
 my $PolicyARNType = $autoscaling->PutScalingPolicy(
   'AutoScalingGroupName'        => 'my-auto-scaling-group',
   'PolicyName'                  => 'alb1000-target-tracking-scaling-policy',
   'PolicyType'                  => 'TargetTrackingScaling',
   'TargetTrackingConfiguration' => {
     'PredefinedMetricSpecification' => {
       'PredefinedMetricType' => 'ALBRequestCountPerTarget',
       'ResourceLabel'        =>
'app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff'
     },
     'TargetValue' => 1000
   }
 );

 # Results:
 my $Alarms    = $PolicyARNType->Alarms;
 my $PolicyARN = $PolicyARNType->PolicyARN;

 # Returns a L<Paws::AutoScaling::PolicyARNType> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/autoscaling/PutScalingPolicy

ATTRIBUTES

AdjustmentType => Str

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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) in the Amazon EC2 Auto Scaling User Guide.

REQUIRED AutoScalingGroupName => Str

The name of the Auto Scaling group.

Cooldown => Int

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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the Amazon EC2 Auto Scaling User Guide.

Enabled => Bool

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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html) in the Amazon EC2 Auto Scaling User Guide.

EstimatedInstanceWarmup => Int

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.

MetricAggregationType => Str

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.

MinAdjustmentMagnitude => Int

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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) 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.

MinAdjustmentStep => Int

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

REQUIRED PolicyName => Str

The name of the policy.

PolicyType => Str

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

PredictiveScalingConfiguration => Paws::AutoScaling::PredictiveScalingConfiguration

A predictive scaling policy. Provides support for only predefined metrics.

Predictive scaling works with CPU utilization, network in/out, and the Application Load Balancer request count.

For more information, see PredictiveScalingConfiguration (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredictiveScalingConfiguration.html) in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is PredictiveScaling.

ScalingAdjustment => Int

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.)

StepAdjustments => ArrayRef[Paws::AutoScaling::StepAdjustment]

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.)

TargetTrackingConfiguration => Paws::AutoScaling::TargetTrackingConfiguration

A target tracking scaling policy. Provides 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 (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html) in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

SEE ALSO

This class forms part of Paws, documenting arguments for method PutScalingPolicy in Paws::AutoScaling

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues