Class CfnScalingPlan

A CloudFormation AWS::AutoScalingPlans::ScalingPlan.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnScalingPlan
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.AutoScalingPlans
Assembly: Amazon.CDK.AWS.AutoScalingPlans.dll
Syntax (csharp)
public class CfnScalingPlan : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnScalingPlan
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

The AWS::AutoScalingPlans::ScalingPlan resource defines an AWS Auto Scaling scaling plan. A scaling plan is used to scale application resources to size them appropriately to ensure that enough resource is available in the application at peak times and to reduce allocated resource during periods of low utilization. The following resources can be added to a scaling plan:

    For more information, see the AWS Auto Scaling User Guide .

    CloudformationResource: AWS::AutoScalingPlans::ScalingPlan

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.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.AutoScalingPlans;

var cfnScalingPlan = new CfnScalingPlan(this, "MyCfnScalingPlan", new CfnScalingPlanProps {
    ApplicationSource = new ApplicationSourceProperty {
        CloudFormationStackArn = "cloudFormationStackArn",
        TagFilters = new [] { new TagFilterProperty {
            Key = "key",

            // the properties below are optional
            Values = new [] { "values" }
        } }
    },
    ScalingInstructions = new [] { new ScalingInstructionProperty {
        MaxCapacity = 123,
        MinCapacity = 123,
        ResourceId = "resourceId",
        ScalableDimension = "scalableDimension",
        ServiceNamespace = "serviceNamespace",
        TargetTrackingConfigurations = new [] { new TargetTrackingConfigurationProperty {
            TargetValue = 123,

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

                // the properties below are optional
                Dimensions = new [] { new MetricDimensionProperty {
                    Name = "name",
                    Value = "value"
                } },
                Unit = "unit"
            },
            DisableScaleIn = false,
            EstimatedInstanceWarmup = 123,
            PredefinedScalingMetricSpecification = new PredefinedScalingMetricSpecificationProperty {
                PredefinedScalingMetricType = "predefinedScalingMetricType",

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

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

            // the properties below are optional
            Dimensions = new [] { new MetricDimensionProperty {
                Name = "name",
                Value = "value"
            } },
            Unit = "unit"
        },
        DisableDynamicScaling = false,
        PredefinedLoadMetricSpecification = new PredefinedLoadMetricSpecificationProperty {
            PredefinedLoadMetricType = "predefinedLoadMetricType",

            // the properties below are optional
            ResourceLabel = "resourceLabel"
        },
        PredictiveScalingMaxCapacityBehavior = "predictiveScalingMaxCapacityBehavior",
        PredictiveScalingMaxCapacityBuffer = 123,
        PredictiveScalingMode = "predictiveScalingMode",
        ScalingPolicyUpdateBehavior = "scalingPolicyUpdateBehavior",
        ScheduledActionBufferTime = 123
    } }
});

    Synopsis

    Constructors

    CfnScalingPlan(Construct, String, ICfnScalingPlanProps)

    Create a new AWS::AutoScalingPlans::ScalingPlan.
    CfnScalingPlan(ByRefValue)

    Used by jsii to construct an instance of this class from a Javascript-owned object reference
    CfnScalingPlan(DeputyBase.DeputyProps)

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

    Properties

    ApplicationSource

    A CloudFormation stack or a set of tags.
    AttrScalingPlanName
    AttrScalingPlanVersion
    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.
    CfnProperties
    ScalingInstructions

    The scaling instructions.

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.
    RenderProperties(IDictionary<String, Object>)

    Constructors

    CfnScalingPlan(Construct, String, ICfnScalingPlanProps)

    Create a new AWS::AutoScalingPlans::ScalingPlan.

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

    CfnScalingPlan(ByRefValue)

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

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

    The Javascript-owned object reference

    CfnScalingPlan(DeputyBase.DeputyProps)

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

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

    The deputy props

    Properties

    ApplicationSource

    A CloudFormation stack or a set of tags.

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

    System.Object

    Remarks

    You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-applicationsource

    AttrScalingPlanName

    public virtual string AttrScalingPlanName { get; }
    Property Value

    System.String

    Remarks

    CloudformationAttribute: ScalingPlanName

    AttrScalingPlanVersion

    public virtual string AttrScalingPlanVersion { get; }
    Property Value

    System.String

    Remarks

    CloudformationAttribute: ScalingPlanVersion

    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

    ScalingInstructions

    The scaling instructions.

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

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-scalinginstructions

    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

    Implements

    Constructs.IConstruct