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.

Describes a scaling policy.

Inheritance Hierarchy

System.Object
  Amazon.AutoScaling.Model.ScalingPolicy

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

Syntax

C#
public class ScalingPolicy

The ScalingPolicy type exposes the following members

Constructors

NameDescription
Public Method ScalingPolicy()

Properties

NameTypeDescription
Public Property 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.

Public Property Alarms System.Collections.Generic.List<Amazon.AutoScaling.Model.Alarm>

Gets and sets the property Alarms.

The CloudWatch alarms related to the policy.

Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

The name of the Auto Scaling group.

Public Property Cooldown System.Int32

Gets and sets the property Cooldown.

The duration of the policy's cooldown period, in seconds.

Public Property Enabled System.Boolean

Gets and sets the property Enabled.

Indicates whether the policy is enabled (true) or disabled (false).

Public Property EstimatedInstanceWarmup System.Int32

Gets and sets the property EstimatedInstanceWarmup.

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Public Property MetricAggregationType System.String

Gets and sets the property MetricAggregationType.

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Public Property MinAdjustmentMagnitude System.Int32

Gets and sets the property MinAdjustmentMagnitude.

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

Public Property MinAdjustmentStep System.Int32

Gets and sets the property MinAdjustmentStep.

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Public Property PolicyARN System.String

Gets and sets the property PolicyARN.

The Amazon Resource Name (ARN) of the policy.

Public Property PolicyName System.String

Gets and sets the property PolicyName.

The name of the scaling policy.

Public Property PolicyType System.String

Gets and sets the property PolicyType.

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

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

Public Property PredictiveScalingConfiguration Amazon.AutoScaling.Model.PredictiveScalingConfiguration

Gets and sets the property PredictiveScalingConfiguration.

A predictive scaling policy.

Public Property 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.

Public Property 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.

Public Property TargetTrackingConfiguration Amazon.AutoScaling.Model.TargetTrackingConfiguration

Gets and sets the property TargetTrackingConfiguration.

A target tracking scaling policy.

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