PutScalingPolicyRequest Class | AWS SDK for .NET V3

Container for the parameters to the PutScalingPolicy operation. Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.

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

For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AutoScaling.AmazonAutoScalingRequest
      Amazon.AutoScaling.Model.PutScalingPolicyRequest

Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

public class PutScalingPolicyRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The PutScalingPolicyRequest type exposes the following members

Constructors

	Name	Description
	PutScalingPolicyRequest()

Properties

Name	Type	Description
AdjustmentType	System.String	Gets and sets the property AdjustmentType. 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.
AutoScalingGroupName	System.String	Gets and sets the property AutoScalingGroupName. The name of the Auto Scaling group.
Cooldown	System.Int32	Gets and sets the property Cooldown. A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown. 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. Default: None
Enabled	System.Boolean	Gets and sets the property 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 in the Amazon EC2 Auto Scaling User Guide.
EstimatedInstanceWarmup	System.Int32	Gets and sets the property EstimatedInstanceWarmup. Not needed if the default instance warmup is defined for the group. The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup. Valid only if the policy type is `TargetTrackingScaling` or `StepScaling`. The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then `EstimatedInstanceWarmup` falls back to the value of default cooldown.
MetricAggregationType	System.String	Gets and sets the property MetricAggregationType. 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	System.Int32	Gets and sets the property MinAdjustmentMagnitude. 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.
MinAdjustmentStep	System.Int32	Gets and sets the property MinAdjustmentStep. Available for backward compatibility. Use `MinAdjustmentMagnitude` instead.
PolicyName	System.String	Gets and sets the property PolicyName. The name of the policy.
PolicyType	System.String	Gets and sets the property PolicyType. One of the following policy types: `TargetTrackingScaling` `StepScaling` `SimpleScaling` (default) `PredictiveScaling`
PredictiveScalingConfiguration	Amazon.AutoScaling.Model.PredictiveScalingConfiguration	Gets and sets the property PredictiveScalingConfiguration. A predictive scaling policy. Provides support for predefined and custom metrics. Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count. For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is `PredictiveScaling`.
ScalingAdjustment	System.Int32	Gets and sets the property ScalingAdjustment. 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 non-negative value. Required if the policy type is `SimpleScaling`. (Not used with any other policy type.)
StepAdjustments	System.Collections.Generic.List<Amazon.AutoScaling.Model.StepAdjustment>	Gets and sets the property StepAdjustments. 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	Amazon.AutoScaling.Model.TargetTrackingConfiguration	Gets and sets the property TargetTrackingConfiguration. A target tracking scaling policy. Provides support for predefined or custom metrics. The following predefined metrics are available: `ASGAverageCPUUtilization` `ASGAverageNetworkIn` `ASGAverageNetworkOut` `ALBRequestCountPerTarget` If you specify `ALBRequestCountPerTarget` for the metric, you must specify the `ResourceLabel` property with the `PredefinedMetricSpecification`. For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is `TargetTrackingScaling`.

Examples

This example adds the specified policy to the specified Auto Scaling group.

To add a scaling policy to an Auto Scaling group


var client = new AmazonAutoScalingClient();
var response = client.PutScalingPolicy(new PutScalingPolicyRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    PolicyName = "alb1000-target-tracking-scaling-policy",
    PolicyType = "TargetTrackingScaling",
    TargetTrackingConfiguration = new TargetTrackingConfiguration {
        PredefinedMetricSpecification = new PredefinedMetricSpecification {
            PredefinedMetricType = "ALBRequestCountPerTarget",
            ResourceLabel = "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff"
        },
        TargetValue = 1000
    }
});

List<Alarm> alarms = response.Alarms;
string policyARN = response.PolicyARN;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5