AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the PutScalingPolicy operation. Creates or updates a policy for an Application Auto Scaling scalable target.

Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target using RegisterScalableTarget.

To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.

You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.

Learn more about how to work with scaling policies in the Application Auto Scaling User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ApplicationAutoScaling.AmazonApplicationAutoScalingRequest
      Amazon.ApplicationAutoScaling.Model.PutScalingPolicyRequest

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

Syntax

C#
public class PutScalingPolicyRequest : AmazonApplicationAutoScalingRequest
         IAmazonWebServiceRequest

The PutScalingPolicyRequest type exposes the following members

Constructors

NameDescription
Public Method PutScalingPolicyRequest()

Properties

NameTypeDescription
Public Property PolicyName System.String

Gets and sets the property PolicyName.

The name of the scaling policy.

Public Property PolicyType Amazon.ApplicationAutoScaling.PolicyType

Gets and sets the property PolicyType.

The policy type. This parameter is required if you are creating a scaling policy.

The following policy types are supported:

TargetTrackingScaling—Not supported for Amazon EMR

StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS Lambda

For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.

Public Property ResourceId System.String

Gets and sets the property ResourceId.

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

  • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

  • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

Public Property ScalableDimension Amazon.ApplicationAutoScaling.ScalableDimension

Gets and sets the property ScalableDimension.

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

  • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

  • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

Public Property ServiceNamespace Amazon.ApplicationAutoScaling.ServiceNamespace

Gets and sets the property ServiceNamespace.

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Public Property StepScalingPolicyConfiguration Amazon.ApplicationAutoScaling.Model.StepScalingPolicyConfiguration

Gets and sets the property StepScalingPolicyConfiguration.

A step scaling policy.

This parameter is required if you are creating a policy and the policy type is StepScaling.

Public Property TargetTrackingScalingPolicyConfiguration Amazon.ApplicationAutoScaling.Model.TargetTrackingScalingPolicyConfiguration

Gets and sets the property TargetTrackingScalingPolicyConfiguration.

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

This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling.

Examples

The following example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds.

To apply a target tracking scaling policy with a predefined metric specification


var response = client.PutScalingPolicy(new PutScalingPolicyRequest 
{
    PolicyName = "cpu75-target-tracking-scaling-policy",
    PolicyType = "TargetTrackingScaling",
    ResourceId = "service/default/web-app",
    ScalableDimension = "ecs:service:DesiredCount",
    ServiceNamespace = "ecs",
    TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfiguration {
        PredefinedMetricSpecification = new PredefinedMetricSpecification { PredefinedMetricType = "ECSServiceAverageCPUUtilization" },
        ScaleInCooldown = 60,
        ScaleOutCooldown = 60,
        TargetValue = 75
    }
});

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

            

The following example applies a target tracking scaling policy with a customized metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds.

To apply a target tracking scaling policy with a customized metric specification


var response = client.PutScalingPolicy(new PutScalingPolicyRequest 
{
    PolicyName = "cms75-target-tracking-scaling-policy",
    PolicyType = "TargetTrackingScaling",
    ResourceId = "service/default/web-app",
    ScalableDimension = "ecs:service:DesiredCount",
    ServiceNamespace = "ecs",
    TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfiguration {
        CustomizedMetricSpecification = new CustomizedMetricSpecification {
            Dimensions = new List<MetricDimension> {
                new MetricDimension {
                    Name = "MyOptionalMetricDimensionName",
                    Value = "MyOptionalMetricDimensionValue"
                }
            },
            MetricName = "MyUtilizationMetric",
            Namespace = "MyNamespace",
            Statistic = "Average",
            Unit = "Percent"
        },
        ScaleInCooldown = 60,
        ScaleOutCooldown = 60,
        TargetValue = 75
    }
});

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

            

The following example applies a target tracking scaling policy to an Amazon ECS service called web-app in the default cluster. The policy is used to scale out the ECS service when the RequestCountPerTarget metric from the Application Load Balancer exceeds the threshold.

To apply a target tracking scaling policy for scale out only


var response = client.PutScalingPolicy(new PutScalingPolicyRequest 
{
    PolicyName = "alb-scale-out-target-tracking-scaling-policy",
    PolicyType = "TargetTrackingScaling",
    ResourceId = "service/default/web-app",
    ScalableDimension = "ecs:service:DesiredCount",
    ServiceNamespace = "ecs",
    TargetTrackingScalingPolicyConfiguration = new TargetTrackingScalingPolicyConfiguration {
        DisableScaleIn = true,
        PredefinedMetricSpecification = new PredefinedMetricSpecification {
            PredefinedMetricType = "ALBRequestCountPerTarget",
            ResourceLabel = "app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d"
        },
        ScaleInCooldown = 60,
        ScaleOutCooldown = 60,
        TargetValue = 1000
    }
});

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

            

This example applies a step scaling policy to an Amazon ECS service called web-app in the default cluster. The policy increases the desired count of the service by 200%, with a cool down period of 60 seconds.

To apply a step scaling policy to an Amazon ECS service


var response = client.PutScalingPolicy(new PutScalingPolicyRequest 
{
    PolicyName = "web-app-cpu-gt-75",
    PolicyType = "StepScaling",
    ResourceId = "service/default/web-app",
    ScalableDimension = "ecs:service:DesiredCount",
    ServiceNamespace = "ecs",
    StepScalingPolicyConfiguration = new StepScalingPolicyConfiguration {
        AdjustmentType = "PercentChangeInCapacity",
        Cooldown = 60,
        StepAdjustments = new List<StepAdjustment> {
            new StepAdjustment {
                MetricIntervalLowerBound = 0,
                ScalingAdjustment = 200
            }
        }
    }
});

string policyARN = response.PolicyARN;

            

This example applies a step scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot fleet by 200%, with a cool down period of 180 seconds.",

To apply a step scaling policy to an Amazon EC2 Spot fleet


var response = client.PutScalingPolicy(new PutScalingPolicyRequest 
{
    PolicyName = "fleet-cpu-gt-75",
    PolicyType = "StepScaling",
    ResourceId = "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3",
    ScalableDimension = "ec2:spot-fleet-request:TargetCapacity",
    ServiceNamespace = "ec2",
    StepScalingPolicyConfiguration = new StepScalingPolicyConfiguration {
        AdjustmentType = "PercentChangeInCapacity",
        Cooldown = 180,
        StepAdjustments = new List<StepAdjustment> {
            new StepAdjustment {
                MetricIntervalLowerBound = 0,
                ScalingAdjustment = 200
            }
        }
    }
});

string policyARN = response.PolicyARN;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms