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 without first registering 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.

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. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.

For DynamoDB, only TargetTrackingScaling is supported. For any other service, only StepScaling is supported.

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 resource ID. Example: table/my-table.

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

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.

Public Property ServiceNamespace Amazon.ApplicationAutoScaling.ServiceNamespace

Gets and sets the property ServiceNamespace.

The namespace of the AWS 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 policy.

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

Examples

This example applies a 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 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 {
            new StepAdjustment {
                MetricIntervalLowerBound = 0,
                ScalingAdjustment = 200
            }
        }
    }
});

string policyARN = response.PolicyARN;

            

This example applies a 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 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 {
            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