Show / Hide Table of Contents

Class CfnScalingPolicy

A CloudFormation AWS::AutoScaling::ScalingPolicy.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnScalingPolicy
Implements
IConstruct
Constructs.IConstruct
IDependable
IInspectable
Inherited Members
CfnResource.IsCfnResource(IConstruct)
CfnResource.AddDeletionOverride(String)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(String, Object)
CfnResource.AddOverride(String, Object)
CfnResource.AddPropertyDeletionOverride(String)
CfnResource.AddPropertyOverride(String, Object)
CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String)
CfnResource.GetMetadata(String)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(Object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.AWS.AutoScaling.dll
Syntax (csharp)
public class CfnScalingPolicy : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnScalingPolicy
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

The AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.

For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic scaling and Predictive scaling in the Amazon EC2 Auto Scaling User Guide .

CloudformationResource: AWS::AutoScaling::ScalingPolicy

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AutoScaling;

CfnScalingPolicy cfnScalingPolicy = new CfnScalingPolicy(this, "MyCfnScalingPolicy", new CfnScalingPolicyProps {
    AutoScalingGroupName = "autoScalingGroupName",

    // the properties below are optional
    AdjustmentType = "adjustmentType",
    Cooldown = "cooldown",
    EstimatedInstanceWarmup = 123,
    MetricAggregationType = "metricAggregationType",
    MinAdjustmentMagnitude = 123,
    PolicyType = "policyType",
    PredictiveScalingConfiguration = new PredictiveScalingConfigurationProperty {
        MetricSpecifications = new [] { new PredictiveScalingMetricSpecificationProperty {
            TargetValue = 123,

            // the properties below are optional
            CustomizedCapacityMetricSpecification = new PredictiveScalingCustomizedCapacityMetricProperty {
                MetricDataQueries = new [] { new MetricDataQueryProperty {
                    Id = "id",

                    // the properties below are optional
                    Expression = "expression",
                    Label = "label",
                    MetricStat = new MetricStatProperty {
                        Metric = new MetricProperty {
                            MetricName = "metricName",
                            Namespace = "namespace",

                            // the properties below are optional
                            Dimensions = new [] { new MetricDimensionProperty {
                                Name = "name",
                                Value = "value"
                            } }
                        },
                        Stat = "stat",

                        // the properties below are optional
                        Unit = "unit"
                    },
                    ReturnData = false
                } }
            },
            CustomizedLoadMetricSpecification = new PredictiveScalingCustomizedLoadMetricProperty {
                MetricDataQueries = new [] { new MetricDataQueryProperty {
                    Id = "id",

                    // the properties below are optional
                    Expression = "expression",
                    Label = "label",
                    MetricStat = new MetricStatProperty {
                        Metric = new MetricProperty {
                            MetricName = "metricName",
                            Namespace = "namespace",

                            // the properties below are optional
                            Dimensions = new [] { new MetricDimensionProperty {
                                Name = "name",
                                Value = "value"
                            } }
                        },
                        Stat = "stat",

                        // the properties below are optional
                        Unit = "unit"
                    },
                    ReturnData = false
                } }
            },
            CustomizedScalingMetricSpecification = new PredictiveScalingCustomizedScalingMetricProperty {
                MetricDataQueries = new [] { new MetricDataQueryProperty {
                    Id = "id",

                    // the properties below are optional
                    Expression = "expression",
                    Label = "label",
                    MetricStat = new MetricStatProperty {
                        Metric = new MetricProperty {
                            MetricName = "metricName",
                            Namespace = "namespace",

                            // the properties below are optional
                            Dimensions = new [] { new MetricDimensionProperty {
                                Name = "name",
                                Value = "value"
                            } }
                        },
                        Stat = "stat",

                        // the properties below are optional
                        Unit = "unit"
                    },
                    ReturnData = false
                } }
            },
            PredefinedLoadMetricSpecification = new PredictiveScalingPredefinedLoadMetricProperty {
                PredefinedMetricType = "predefinedMetricType",

                // the properties below are optional
                ResourceLabel = "resourceLabel"
            },
            PredefinedMetricPairSpecification = new PredictiveScalingPredefinedMetricPairProperty {
                PredefinedMetricType = "predefinedMetricType",

                // the properties below are optional
                ResourceLabel = "resourceLabel"
            },
            PredefinedScalingMetricSpecification = new PredictiveScalingPredefinedScalingMetricProperty {
                PredefinedMetricType = "predefinedMetricType",

                // the properties below are optional
                ResourceLabel = "resourceLabel"
            }
        } },

        // the properties below are optional
        MaxCapacityBreachBehavior = "maxCapacityBreachBehavior",
        MaxCapacityBuffer = 123,
        Mode = "mode",
        SchedulingBufferTime = 123
    },
    ScalingAdjustment = 123,
    StepAdjustments = new [] { new StepAdjustmentProperty {
        ScalingAdjustment = 123,

        // the properties below are optional
        MetricIntervalLowerBound = 123,
        MetricIntervalUpperBound = 123
    } },
    TargetTrackingConfiguration = new TargetTrackingConfigurationProperty {
        TargetValue = 123,

        // the properties below are optional
        CustomizedMetricSpecification = new CustomizedMetricSpecificationProperty {
            MetricName = "metricName",
            Namespace = "namespace",
            Statistic = "statistic",

            // the properties below are optional
            Dimensions = new [] { new MetricDimensionProperty {
                Name = "name",
                Value = "value"
            } },
            Unit = "unit"
        },
        DisableScaleIn = false,
        PredefinedMetricSpecification = new PredefinedMetricSpecificationProperty {
            PredefinedMetricType = "predefinedMetricType",

            // the properties below are optional
            ResourceLabel = "resourceLabel"
        }
    }
});

Synopsis

Constructors

CfnScalingPolicy(Construct, String, ICfnScalingPolicyProps)

Create a new AWS::AutoScaling::ScalingPolicy.

CfnScalingPolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnScalingPolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AdjustmentType

Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .

AutoScalingGroupName

The name of the Auto Scaling group.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
Cooldown

A cooldown period, in seconds, that applies to a specific simple scaling policy.

EstimatedInstanceWarmup

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

MetricAggregationType

The aggregation type for the CloudWatch metrics.

MinAdjustmentMagnitude

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

PolicyType

One of the following policy types:.

PredictiveScalingConfiguration

A predictive scaling policy. Provides support for predefined and custom metrics.

ScalingAdjustment

The amount by which to scale, based on the specified adjustment type.

StepAdjustments

A set of adjustments that enable you to scale based on the size of the alarm breach.

TargetTrackingConfiguration

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

Constructors

CfnScalingPolicy(Construct, String, ICfnScalingPolicyProps)

Create a new AWS::AutoScaling::ScalingPolicy.

public CfnScalingPolicy(Construct scope, string id, ICfnScalingPolicyProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnScalingPolicyProps
  • resource properties.

CfnScalingPolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnScalingPolicy(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnScalingPolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnScalingPolicy(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AdjustmentType

Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .

public virtual string AdjustmentType { get; set; }
Property Value

System.String

Remarks

Required if the policy type is StepScaling or SimpleScaling . For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-adjustmenttype

AutoScalingGroupName

The name of the Auto Scaling group.

public virtual string AutoScalingGroupName { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-autoscalinggroupname

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.CfnProperties

Cooldown

A cooldown period, in seconds, that applies to a specific simple scaling policy.

public virtual string Cooldown { get; set; }
Property Value

System.String

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-cooldown

EstimatedInstanceWarmup

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

public virtual Nullable<double> EstimatedInstanceWarmup { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

This warm-up period applies to instances launched due to a specific target tracking or step scaling policy.

Valid only if the policy type is TargetTrackingScaling or StepScaling .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-estimatedinstancewarmup

MetricAggregationType

The aggregation type for the CloudWatch metrics.

public virtual string MetricAggregationType { get; set; }
Property Value

System.String

Remarks

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-metricaggregationtype

MinAdjustmentMagnitude

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

public virtual Nullable<double> MinAdjustmentMagnitude { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-minadjustmentmagnitude

PolicyType

One of the following policy types:.

public virtual string PolicyType { get; set; }
Property Value

System.String

Remarks

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

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-policytype

    PredictiveScalingConfiguration

    A predictive scaling policy. Provides support for predefined and custom metrics.

    public virtual object PredictiveScalingConfiguration { get; set; }
    Property Value

    System.Object

    Remarks

    Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration

    ScalingAdjustment

    The amount by which to scale, based on the specified adjustment type.

    public virtual Nullable<double> ScalingAdjustment { get; set; }
    Property Value

    System.Nullable<System.Double>

    Remarks

    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.)

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-scalingadjustment

    StepAdjustments

    A set of adjustments that enable you to scale based on the size of the alarm breach.

    public virtual object StepAdjustments { get; set; }
    Property Value

    System.Object

    Remarks

    Required if the policy type is StepScaling . (Not used with any other policy type.)

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-stepadjustments

    TargetTrackingConfiguration

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

    public virtual object TargetTrackingConfiguration { get; set; }
    Property Value

    System.Object

    Remarks

    The following predefined metrics are available:

      If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification .

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration

      Methods

      Inspect(TreeInspector)

      Examines the CloudFormation resource and discloses attributes.

      public virtual void Inspect(TreeInspector inspector)
      Parameters
      inspector TreeInspector
      • tree inspector to collect and process attributes.

      RenderProperties(IDictionary<String, Object>)

      protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
      Parameters
      props System.Collections.Generic.IDictionary<System.String, System.Object>
      Returns

      System.Collections.Generic.IDictionary<System.String, System.Object>

      Overrides
      CfnResource.RenderProperties(IDictionary<String, Object>)

      Implements

      IConstruct
      Constructs.IConstruct
      IDependable
      IInspectable
      Back to top Generated by DocFX