class Aws::AutoScaling::Types::PutScalingPolicyType
@note When making an API call, you may pass PutScalingPolicyType
data as a hash: { auto_scaling_group_name: "XmlStringMaxLen255", # required policy_name: "XmlStringMaxLen255", # required policy_type: "XmlStringMaxLen64", adjustment_type: "XmlStringMaxLen255", min_adjustment_step: 1, min_adjustment_magnitude: 1, scaling_adjustment: 1, cooldown: 1, metric_aggregation_type: "XmlStringMaxLen32", step_adjustments: [ { metric_interval_lower_bound: 1.0, metric_interval_upper_bound: 1.0, scaling_adjustment: 1, # required }, ], estimated_instance_warmup: 1, target_tracking_configuration: { predefined_metric_specification: { predefined_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, ALBRequestCountPerTarget resource_label: "XmlStringMaxLen1023", }, customized_metric_specification: { metric_name: "MetricName", # required namespace: "MetricNamespace", # required dimensions: [ { name: "MetricDimensionName", # required value: "MetricDimensionValue", # required }, ], statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum unit: "MetricUnit", }, target_value: 1.0, # required disable_scale_in: false, }, enabled: false, predictive_scaling_configuration: { metric_specifications: [ # required { target_value: 1.0, # required predefined_metric_pair_specification: { predefined_metric_type: "ASGCPUUtilization", # required, accepts ASGCPUUtilization, ASGNetworkIn, ASGNetworkOut, ALBRequestCount resource_label: "XmlStringMaxLen1023", }, predefined_scaling_metric_specification: { predefined_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, ALBRequestCountPerTarget resource_label: "XmlStringMaxLen1023", }, predefined_load_metric_specification: { predefined_metric_type: "ASGTotalCPUUtilization", # required, accepts ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut, ALBTargetGroupRequestCount resource_label: "XmlStringMaxLen1023", }, }, ], mode: "ForecastAndScale", # accepts ForecastAndScale, ForecastOnly scheduling_buffer_time: 1, max_capacity_breach_behavior: "HonorMaxCapacity", # accepts HonorMaxCapacity, IncreaseMaxCapacity max_capacity_buffer: 1, }, }
@!attribute [rw] auto_scaling_group_name
The name of the Auto Scaling group. @return [String]
@!attribute [rw] policy_name
The name of the policy. @return [String]
@!attribute [rw] policy_type
One of the following policy types: * `TargetTrackingScaling` * `StepScaling` * `SimpleScaling` (default) * `PredictiveScaling` @return [String]
@!attribute [rw] adjustment_type
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][1] in the *Amazon EC2 Auto Scaling User Guide*. [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment @return [String]
@!attribute [rw] min_adjustment_step
Available for backward compatibility. Use `MinAdjustmentMagnitude` instead. @return [Integer]
@!attribute [rw] min_adjustment_magnitude
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][1] in the *Amazon EC2 Auto Scaling User Guide*. <note markdown="1"> 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. </note> [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment @return [Integer]
@!attribute [rw] scaling_adjustment
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.) @return [Integer]
@!attribute [rw] cooldown
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][1] in the *Amazon EC2 Auto Scaling User Guide*. [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html @return [Integer]
@!attribute [rw] metric_aggregation_type
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`. @return [String]
@!attribute [rw] step_adjustments
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.) @return [Array<Types::StepAdjustment>]
@!attribute [rw] estimated_instance_warmup
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`. @return [Integer]
@!attribute [rw] target_tracking_configuration
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][1] in the *Amazon EC2 Auto Scaling API Reference*. Required if the policy type is `TargetTrackingScaling`. [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html @return [Types::TargetTrackingConfiguration]
@!attribute [rw] enabled
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][1] in the *Amazon EC2 Auto Scaling User Guide*. [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html @return [Boolean]
@!attribute [rw] predictive_scaling_configuration
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][1] in the *Amazon EC2 Auto Scaling API Reference*. Required if the policy type is `PredictiveScaling`. [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredictiveScalingConfiguration.html @return [Types::PredictiveScalingConfiguration]
@see docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutScalingPolicyType AWS API Documentation
Constants
- SENSITIVE