CfnScalingPlanProps

class aws_cdk.aws_autoscalingplans.CfnScalingPlanProps(*, application_source, scaling_instructions)

Bases: object

Properties for defining a CfnScalingPlan.

Parameters
  • application_source (Union[ApplicationSourceProperty, Dict[str, Any], IResolvable]) – A CloudFormation stack or a set of tags. You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.

  • scaling_instructions (Union[IResolvable, Sequence[Union[ScalingInstructionProperty, Dict[str, Any], IResolvable]]]) – The scaling instructions.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_autoscalingplans as autoscalingplans

cfn_scaling_plan_props = autoscalingplans.CfnScalingPlanProps(
    application_source=autoscalingplans.CfnScalingPlan.ApplicationSourceProperty(
        cloud_formation_stack_arn="cloudFormationStackArn",
        tag_filters=[autoscalingplans.CfnScalingPlan.TagFilterProperty(
            key="key",

            # the properties below are optional
            values=["values"]
        )]
    ),
    scaling_instructions=[autoscalingplans.CfnScalingPlan.ScalingInstructionProperty(
        max_capacity=123,
        min_capacity=123,
        resource_id="resourceId",
        scalable_dimension="scalableDimension",
        service_namespace="serviceNamespace",
        target_tracking_configurations=[autoscalingplans.CfnScalingPlan.TargetTrackingConfigurationProperty(
            target_value=123,

            # the properties below are optional
            customized_scaling_metric_specification=autoscalingplans.CfnScalingPlan.CustomizedScalingMetricSpecificationProperty(
                metric_name="metricName",
                namespace="namespace",
                statistic="statistic",

                # the properties below are optional
                dimensions=[autoscalingplans.CfnScalingPlan.MetricDimensionProperty(
                    name="name",
                    value="value"
                )],
                unit="unit"
            ),
            disable_scale_in=False,
            estimated_instance_warmup=123,
            predefined_scaling_metric_specification=autoscalingplans.CfnScalingPlan.PredefinedScalingMetricSpecificationProperty(
                predefined_scaling_metric_type="predefinedScalingMetricType",

                # the properties below are optional
                resource_label="resourceLabel"
            ),
            scale_in_cooldown=123,
            scale_out_cooldown=123
        )],

        # the properties below are optional
        customized_load_metric_specification=autoscalingplans.CfnScalingPlan.CustomizedLoadMetricSpecificationProperty(
            metric_name="metricName",
            namespace="namespace",
            statistic="statistic",

            # the properties below are optional
            dimensions=[autoscalingplans.CfnScalingPlan.MetricDimensionProperty(
                name="name",
                value="value"
            )],
            unit="unit"
        ),
        disable_dynamic_scaling=False,
        predefined_load_metric_specification=autoscalingplans.CfnScalingPlan.PredefinedLoadMetricSpecificationProperty(
            predefined_load_metric_type="predefinedLoadMetricType",

            # the properties below are optional
            resource_label="resourceLabel"
        ),
        predictive_scaling_max_capacity_behavior="predictiveScalingMaxCapacityBehavior",
        predictive_scaling_max_capacity_buffer=123,
        predictive_scaling_mode="predictiveScalingMode",
        scaling_policy_update_behavior="scalingPolicyUpdateBehavior",
        scheduled_action_buffer_time=123
    )]
)

Attributes

application_source

A CloudFormation stack or a set of tags.

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

scaling_instructions

The scaling instructions.

Link

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