Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. autoscalingplans
  5. ScalingPlan

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi
pulumi/pulumi-aws

aws.autoscalingplans.ScalingPlan

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi
pulumi/pulumi-aws

    Manages an AWS Auto Scaling scaling plan. More information can be found in the AWS Auto Scaling User Guide.

    NOTE: The AWS Auto Scaling service uses an AWS IAM service-linked role to manage predictive scaling of Amazon EC2 Auto Scaling groups. The service attempts to automatically create this role the first time a scaling plan with predictive scaling enabled is created. An aws.iam.ServiceLinkedRole resource can be used to manually manage this role. See the AWS documentation for more details.

    Create ScalingPlan Resource

    new ScalingPlan(name: string, args: ScalingPlanArgs, opts?: CustomResourceOptions);
    @overload
def ScalingPlan(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                application_source: Optional[ScalingPlanApplicationSourceArgs] = None,
                name: Optional[str] = None,
                scaling_instructions: Optional[Sequence[ScalingPlanScalingInstructionArgs]] = None)
@overload
def ScalingPlan(resource_name: str,
                args: ScalingPlanArgs,
                opts: Optional[ResourceOptions] = None)
    func NewScalingPlan(ctx *Context, name string, args ScalingPlanArgs, opts ...ResourceOption) (*ScalingPlan, error)
    public ScalingPlan(string name, ScalingPlanArgs args, CustomResourceOptions? opts = null)
    public ScalingPlan(String name, ScalingPlanArgs args)
public ScalingPlan(String name, ScalingPlanArgs args, CustomResourceOptions options)

    type: aws:autoscalingplans:ScalingPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScalingPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScalingPlanArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScalingPlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScalingPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScalingPlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ScalingPlan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ScalingPlan resource accepts the following input properties:

    ApplicationSource ScalingPlanApplicationSource

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    ScalingInstructions List<ScalingPlanScalingInstruction>

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    Name string

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    ApplicationSource ScalingPlanApplicationSourceArgs

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    ScalingInstructions []ScalingPlanScalingInstructionArgs

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    Name string

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    applicationSource ScalingPlanApplicationSource

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    scalingInstructions List<ScalingPlanScalingInstruction>

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    name String

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    applicationSource ScalingPlanApplicationSource

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    scalingInstructions ScalingPlanScalingInstruction[]

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    name string

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    application_source ScalingPlanApplicationSourceArgs

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    scaling_instructions Sequence[ScalingPlanScalingInstructionArgs]

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    name str

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    applicationSource Property Map

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    scalingInstructions List<Property Map>

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    name String

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScalingPlan resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    ScalingPlanVersion int

    The version number of the scaling plan. This value is always 1.

    Id string

    The provider-assigned unique ID for this managed resource.

    ScalingPlanVersion int

    The version number of the scaling plan. This value is always 1.

    id String

    The provider-assigned unique ID for this managed resource.

    scalingPlanVersion Integer

    The version number of the scaling plan. This value is always 1.

    id string

    The provider-assigned unique ID for this managed resource.

    scalingPlanVersion number

    The version number of the scaling plan. This value is always 1.

    id str

    The provider-assigned unique ID for this managed resource.

    scaling_plan_version int

    The version number of the scaling plan. This value is always 1.

    id String

    The provider-assigned unique ID for this managed resource.

    scalingPlanVersion Number

    The version number of the scaling plan. This value is always 1.

    Look up Existing ScalingPlan Resource

    Get an existing ScalingPlan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ScalingPlanState, opts?: CustomResourceOptions): ScalingPlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_source: Optional[ScalingPlanApplicationSourceArgs] = None,
        name: Optional[str] = None,
        scaling_instructions: Optional[Sequence[ScalingPlanScalingInstructionArgs]] = None,
        scaling_plan_version: Optional[int] = None) -> ScalingPlan
    func GetScalingPlan(ctx *Context, name string, id IDInput, state *ScalingPlanState, opts ...ResourceOption) (*ScalingPlan, error)
    public static ScalingPlan Get(string name, Input<string> id, ScalingPlanState? state, CustomResourceOptions? opts = null)
    public static ScalingPlan get(String name, Output<String> id, ScalingPlanState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApplicationSource ScalingPlanApplicationSource

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    Name string

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    ScalingInstructions List<ScalingPlanScalingInstruction>

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    ScalingPlanVersion int

    The version number of the scaling plan. This value is always 1.

    ApplicationSource ScalingPlanApplicationSourceArgs

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    Name string

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    ScalingInstructions []ScalingPlanScalingInstructionArgs

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    ScalingPlanVersion int

    The version number of the scaling plan. This value is always 1.

    applicationSource ScalingPlanApplicationSource

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    name String

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    scalingInstructions List<ScalingPlanScalingInstruction>

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    scalingPlanVersion Integer

    The version number of the scaling plan. This value is always 1.

    applicationSource ScalingPlanApplicationSource

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    name string

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    scalingInstructions ScalingPlanScalingInstruction[]

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    scalingPlanVersion number

    The version number of the scaling plan. This value is always 1.

    application_source ScalingPlanApplicationSourceArgs

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    name str

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    scaling_instructions Sequence[ScalingPlanScalingInstructionArgs]

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    scaling_plan_version int

    The version number of the scaling plan. This value is always 1.

    applicationSource Property Map

    CloudFormation stack or set of tags. You can create one scaling plan per application source.

    name String

    Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

    scalingInstructions List<Property Map>

    Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.

    scalingPlanVersion Number

    The version number of the scaling plan. This value is always 1.

    Supporting Types

    ScalingPlanApplicationSource, ScalingPlanApplicationSourceArgs

    CloudformationStackArn string

    ARN of a AWS CloudFormation stack.

    TagFilters List<ScalingPlanApplicationSourceTagFilter>

    Set of tags.

    CloudformationStackArn string

    ARN of a AWS CloudFormation stack.

    TagFilters []ScalingPlanApplicationSourceTagFilter

    Set of tags.

    cloudformationStackArn String

    ARN of a AWS CloudFormation stack.

    tagFilters List<ScalingPlanApplicationSourceTagFilter>

    Set of tags.

    cloudformationStackArn string

    ARN of a AWS CloudFormation stack.

    tagFilters ScalingPlanApplicationSourceTagFilter[]

    Set of tags.

    cloudformationStackArn String

    ARN of a AWS CloudFormation stack.

    tagFilters List<Property Map>

    Set of tags.

    ScalingPlanApplicationSourceTagFilter, ScalingPlanApplicationSourceTagFilterArgs

    Key string

    Tag key.

    Values List<string>

    Tag values.

    Key string

    Tag key.

    Values []string

    Tag values.

    key String

    Tag key.

    values List<String>

    Tag values.

    key string

    Tag key.

    values string[]

    Tag values.

    key str

    Tag key.

    values Sequence[str]

    Tag values.

    key String

    Tag key.

    values List<String>

    Tag values.

    ScalingPlanScalingInstruction, ScalingPlanScalingInstructionArgs

    MaxCapacity int

    Maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for predictive_scaling_max_capacity_behavior.

    MinCapacity int

    Minimum capacity of the resource.

    ResourceId string

    ID of the resource. This string consists of the resource type and unique identifier.

    ScalableDimension string

    Scalable dimension associated with the resource. Valid values: autoscaling:autoScalingGroup:DesiredCapacity, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount.

    ServiceNamespace string

    Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.

    TargetTrackingConfigurations List<ScalingPlanScalingInstructionTargetTrackingConfiguration>

    Structure that defines new target tracking configurations. Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling. More details can be found in the AWS Auto Scaling API Reference.

    CustomizedLoadMetricSpecification ScalingPlanScalingInstructionCustomizedLoadMetricSpecification

    Customized load metric to use for predictive scaling. You must specify either customized_load_metric_specification or predefined_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    DisableDynamicScaling bool

    Boolean controlling whether dynamic scaling by AWS Auto Scaling is disabled. Defaults to false.

    PredefinedLoadMetricSpecification ScalingPlanScalingInstructionPredefinedLoadMetricSpecification

    Predefined load metric to use for predictive scaling. You must specify either predefined_load_metric_specification or customized_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    PredictiveScalingMaxCapacityBehavior string

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. Valid values: SetForecastCapacityToMaxCapacity, SetMaxCapacityAboveForecastCapacity, SetMaxCapacityToForecastCapacity.

    PredictiveScalingMaxCapacityBuffer int

    Size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

    PredictiveScalingMode string

    Predictive scaling mode. Valid values: ForecastAndScale, ForecastOnly.

    ScalingPolicyUpdateBehavior string

    Controls whether a resource's externally created scaling policies are kept or replaced. Valid values: KeepExternalPolicies, ReplaceExternalPolicies. Defaults to KeepExternalPolicies.

    ScheduledActionBufferTime int

    Amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.

    MaxCapacity int

    Maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for predictive_scaling_max_capacity_behavior.

    MinCapacity int

    Minimum capacity of the resource.

    ResourceId string

    ID of the resource. This string consists of the resource type and unique identifier.

    ScalableDimension string

    Scalable dimension associated with the resource. Valid values: autoscaling:autoScalingGroup:DesiredCapacity, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount.

    ServiceNamespace string

    Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.

    TargetTrackingConfigurations []ScalingPlanScalingInstructionTargetTrackingConfiguration

    Structure that defines new target tracking configurations. Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling. More details can be found in the AWS Auto Scaling API Reference.

    CustomizedLoadMetricSpecification ScalingPlanScalingInstructionCustomizedLoadMetricSpecification

    Customized load metric to use for predictive scaling. You must specify either customized_load_metric_specification or predefined_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    DisableDynamicScaling bool

    Boolean controlling whether dynamic scaling by AWS Auto Scaling is disabled. Defaults to false.

    PredefinedLoadMetricSpecification ScalingPlanScalingInstructionPredefinedLoadMetricSpecification

    Predefined load metric to use for predictive scaling. You must specify either predefined_load_metric_specification or customized_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    PredictiveScalingMaxCapacityBehavior string

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. Valid values: SetForecastCapacityToMaxCapacity, SetMaxCapacityAboveForecastCapacity, SetMaxCapacityToForecastCapacity.

    PredictiveScalingMaxCapacityBuffer int

    Size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

    PredictiveScalingMode string

    Predictive scaling mode. Valid values: ForecastAndScale, ForecastOnly.

    ScalingPolicyUpdateBehavior string

    Controls whether a resource's externally created scaling policies are kept or replaced. Valid values: KeepExternalPolicies, ReplaceExternalPolicies. Defaults to KeepExternalPolicies.

    ScheduledActionBufferTime int

    Amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.

    maxCapacity Integer

    Maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for predictive_scaling_max_capacity_behavior.

    minCapacity Integer

    Minimum capacity of the resource.

    resourceId String

    ID of the resource. This string consists of the resource type and unique identifier.

    scalableDimension String

    Scalable dimension associated with the resource. Valid values: autoscaling:autoScalingGroup:DesiredCapacity, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount.

    serviceNamespace String

    Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.

    targetTrackingConfigurations List<ScalingPlanScalingInstructionTargetTrackingConfiguration>

    Structure that defines new target tracking configurations. Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling. More details can be found in the AWS Auto Scaling API Reference.

    customizedLoadMetricSpecification ScalingPlanScalingInstructionCustomizedLoadMetricSpecification

    Customized load metric to use for predictive scaling. You must specify either customized_load_metric_specification or predefined_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    disableDynamicScaling Boolean

    Boolean controlling whether dynamic scaling by AWS Auto Scaling is disabled. Defaults to false.

    predefinedLoadMetricSpecification ScalingPlanScalingInstructionPredefinedLoadMetricSpecification

    Predefined load metric to use for predictive scaling. You must specify either predefined_load_metric_specification or customized_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    predictiveScalingMaxCapacityBehavior String

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. Valid values: SetForecastCapacityToMaxCapacity, SetMaxCapacityAboveForecastCapacity, SetMaxCapacityToForecastCapacity.

    predictiveScalingMaxCapacityBuffer Integer

    Size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

    predictiveScalingMode String

    Predictive scaling mode. Valid values: ForecastAndScale, ForecastOnly.

    scalingPolicyUpdateBehavior String

    Controls whether a resource's externally created scaling policies are kept or replaced. Valid values: KeepExternalPolicies, ReplaceExternalPolicies. Defaults to KeepExternalPolicies.

    scheduledActionBufferTime Integer

    Amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.

    maxCapacity number

    Maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for predictive_scaling_max_capacity_behavior.

    minCapacity number

    Minimum capacity of the resource.

    resourceId string

    ID of the resource. This string consists of the resource type and unique identifier.

    scalableDimension string

    Scalable dimension associated with the resource. Valid values: autoscaling:autoScalingGroup:DesiredCapacity, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount.

    serviceNamespace string

    Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.

    targetTrackingConfigurations ScalingPlanScalingInstructionTargetTrackingConfiguration[]

    Structure that defines new target tracking configurations. Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling. More details can be found in the AWS Auto Scaling API Reference.

    customizedLoadMetricSpecification ScalingPlanScalingInstructionCustomizedLoadMetricSpecification

    Customized load metric to use for predictive scaling. You must specify either customized_load_metric_specification or predefined_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    disableDynamicScaling boolean

    Boolean controlling whether dynamic scaling by AWS Auto Scaling is disabled. Defaults to false.

    predefinedLoadMetricSpecification ScalingPlanScalingInstructionPredefinedLoadMetricSpecification

    Predefined load metric to use for predictive scaling. You must specify either predefined_load_metric_specification or customized_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    predictiveScalingMaxCapacityBehavior string

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. Valid values: SetForecastCapacityToMaxCapacity, SetMaxCapacityAboveForecastCapacity, SetMaxCapacityToForecastCapacity.

    predictiveScalingMaxCapacityBuffer number

    Size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

    predictiveScalingMode string

    Predictive scaling mode. Valid values: ForecastAndScale, ForecastOnly.

    scalingPolicyUpdateBehavior string

    Controls whether a resource's externally created scaling policies are kept or replaced. Valid values: KeepExternalPolicies, ReplaceExternalPolicies. Defaults to KeepExternalPolicies.

    scheduledActionBufferTime number

    Amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.

    max_capacity int

    Maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for predictive_scaling_max_capacity_behavior.

    min_capacity int

    Minimum capacity of the resource.

    resource_id str

    ID of the resource. This string consists of the resource type and unique identifier.

    scalable_dimension str

    Scalable dimension associated with the resource. Valid values: autoscaling:autoScalingGroup:DesiredCapacity, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount.

    service_namespace str

    Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.

    target_tracking_configurations Sequence[ScalingPlanScalingInstructionTargetTrackingConfiguration]

    Structure that defines new target tracking configurations. Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling. More details can be found in the AWS Auto Scaling API Reference.

    customized_load_metric_specification ScalingPlanScalingInstructionCustomizedLoadMetricSpecification

    Customized load metric to use for predictive scaling. You must specify either customized_load_metric_specification or predefined_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    disable_dynamic_scaling bool

    Boolean controlling whether dynamic scaling by AWS Auto Scaling is disabled. Defaults to false.

    predefined_load_metric_specification ScalingPlanScalingInstructionPredefinedLoadMetricSpecification

    Predefined load metric to use for predictive scaling. You must specify either predefined_load_metric_specification or customized_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    predictive_scaling_max_capacity_behavior str

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. Valid values: SetForecastCapacityToMaxCapacity, SetMaxCapacityAboveForecastCapacity, SetMaxCapacityToForecastCapacity.

    predictive_scaling_max_capacity_buffer int

    Size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

    predictive_scaling_mode str

    Predictive scaling mode. Valid values: ForecastAndScale, ForecastOnly.

    scaling_policy_update_behavior str

    Controls whether a resource's externally created scaling policies are kept or replaced. Valid values: KeepExternalPolicies, ReplaceExternalPolicies. Defaults to KeepExternalPolicies.

    scheduled_action_buffer_time int

    Amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.

    maxCapacity Number

    Maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for predictive_scaling_max_capacity_behavior.

    minCapacity Number

    Minimum capacity of the resource.

    resourceId String

    ID of the resource. This string consists of the resource type and unique identifier.

    scalableDimension String

    Scalable dimension associated with the resource. Valid values: autoscaling:autoScalingGroup:DesiredCapacity, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount.

    serviceNamespace String

    Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.

    targetTrackingConfigurations List<Property Map>

    Structure that defines new target tracking configurations. Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling. More details can be found in the AWS Auto Scaling API Reference.

    customizedLoadMetricSpecification Property Map

    Customized load metric to use for predictive scaling. You must specify either customized_load_metric_specification or predefined_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    disableDynamicScaling Boolean

    Boolean controlling whether dynamic scaling by AWS Auto Scaling is disabled. Defaults to false.

    predefinedLoadMetricSpecification Property Map

    Predefined load metric to use for predictive scaling. You must specify either predefined_load_metric_specification or customized_load_metric_specification when configuring predictive scaling. More details can be found in the AWS Auto Scaling API Reference.

    predictiveScalingMaxCapacityBehavior String

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. Valid values: SetForecastCapacityToMaxCapacity, SetMaxCapacityAboveForecastCapacity, SetMaxCapacityToForecastCapacity.

    predictiveScalingMaxCapacityBuffer Number

    Size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

    predictiveScalingMode String

    Predictive scaling mode. Valid values: ForecastAndScale, ForecastOnly.

    scalingPolicyUpdateBehavior String

    Controls whether a resource's externally created scaling policies are kept or replaced. Valid values: KeepExternalPolicies, ReplaceExternalPolicies. Defaults to KeepExternalPolicies.

    scheduledActionBufferTime Number

    Amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.

    ScalingPlanScalingInstructionCustomizedLoadMetricSpecification, ScalingPlanScalingInstructionCustomizedLoadMetricSpecificationArgs

    MetricName string

    Name of the metric.

    Namespace string

    Namespace of the metric.

    Statistic string

    Statistic of the metric. Currently, the value must always be Sum.

    Dimensions Dictionary<string, string>

    Dimensions of the metric.

    Unit string

    Unit of the metric.

    MetricName string

    Name of the metric.

    Namespace string

    Namespace of the metric.

    Statistic string

    Statistic of the metric. Currently, the value must always be Sum.

    Dimensions map[string]string

    Dimensions of the metric.

    Unit string

    Unit of the metric.

    metricName String

    Name of the metric.

    namespace String

    Namespace of the metric.

    statistic String

    Statistic of the metric. Currently, the value must always be Sum.

    dimensions Map<String,String>

    Dimensions of the metric.

    unit String

    Unit of the metric.

    metricName string

    Name of the metric.

    namespace string

    Namespace of the metric.

    statistic string

    Statistic of the metric. Currently, the value must always be Sum.

    dimensions {[key: string]: string}

    Dimensions of the metric.

    unit string

    Unit of the metric.

    metric_name str

    Name of the metric.

    namespace str

    Namespace of the metric.

    statistic str

    Statistic of the metric. Currently, the value must always be Sum.

    dimensions Mapping[str, str]

    Dimensions of the metric.

    unit str

    Unit of the metric.

    metricName String

    Name of the metric.

    namespace String

    Namespace of the metric.

    statistic String

    Statistic of the metric. Currently, the value must always be Sum.

    dimensions Map<String>

    Dimensions of the metric.

    unit String

    Unit of the metric.

    ScalingPlanScalingInstructionPredefinedLoadMetricSpecification, ScalingPlanScalingInstructionPredefinedLoadMetricSpecificationArgs

    PredefinedLoadMetricType string

    Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.

    ResourceLabel string

    Identifies the resource associated with the metric type.

    PredefinedLoadMetricType string

    Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.

    ResourceLabel string

    Identifies the resource associated with the metric type.

    predefinedLoadMetricType String

    Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.

    resourceLabel String

    Identifies the resource associated with the metric type.

    predefinedLoadMetricType string

    Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.

    resourceLabel string

    Identifies the resource associated with the metric type.

    predefined_load_metric_type str

    Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.

    resource_label str

    Identifies the resource associated with the metric type.

    predefinedLoadMetricType String

    Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.

    resourceLabel String

    Identifies the resource associated with the metric type.

    ScalingPlanScalingInstructionTargetTrackingConfiguration, ScalingPlanScalingInstructionTargetTrackingConfigurationArgs

    TargetValue double

    Target value for the metric.

    CustomizedScalingMetricSpecification ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification

    Customized metric. You can specify either customized_scaling_metric_specification or predefined_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    DisableScaleIn bool

    Boolean indicating whether scale in by the target tracking scaling policy is disabled. Defaults to false.

    EstimatedInstanceWarmup int

    Estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

    PredefinedScalingMetricSpecification ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification

    Predefined metric. You can specify either predefined_scaling_metric_specification or customized_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    ScaleInCooldown int

    Amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    ScaleOutCooldown int

    Amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    TargetValue float64

    Target value for the metric.

    CustomizedScalingMetricSpecification ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification

    Customized metric. You can specify either customized_scaling_metric_specification or predefined_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    DisableScaleIn bool

    Boolean indicating whether scale in by the target tracking scaling policy is disabled. Defaults to false.

    EstimatedInstanceWarmup int

    Estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

    PredefinedScalingMetricSpecification ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification

    Predefined metric. You can specify either predefined_scaling_metric_specification or customized_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    ScaleInCooldown int

    Amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    ScaleOutCooldown int

    Amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    targetValue Double

    Target value for the metric.

    customizedScalingMetricSpecification ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification

    Customized metric. You can specify either customized_scaling_metric_specification or predefined_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    disableScaleIn Boolean

    Boolean indicating whether scale in by the target tracking scaling policy is disabled. Defaults to false.

    estimatedInstanceWarmup Integer

    Estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

    predefinedScalingMetricSpecification ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification

    Predefined metric. You can specify either predefined_scaling_metric_specification or customized_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    scaleInCooldown Integer

    Amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    scaleOutCooldown Integer

    Amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    targetValue number

    Target value for the metric.

    customizedScalingMetricSpecification ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification

    Customized metric. You can specify either customized_scaling_metric_specification or predefined_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    disableScaleIn boolean

    Boolean indicating whether scale in by the target tracking scaling policy is disabled. Defaults to false.

    estimatedInstanceWarmup number

    Estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

    predefinedScalingMetricSpecification ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification

    Predefined metric. You can specify either predefined_scaling_metric_specification or customized_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    scaleInCooldown number

    Amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    scaleOutCooldown number

    Amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    target_value float

    Target value for the metric.

    customized_scaling_metric_specification ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification

    Customized metric. You can specify either customized_scaling_metric_specification or predefined_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    disable_scale_in bool

    Boolean indicating whether scale in by the target tracking scaling policy is disabled. Defaults to false.

    estimated_instance_warmup int

    Estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

    predefined_scaling_metric_specification ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification

    Predefined metric. You can specify either predefined_scaling_metric_specification or customized_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    scale_in_cooldown int

    Amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    scale_out_cooldown int

    Amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    targetValue Number

    Target value for the metric.

    customizedScalingMetricSpecification Property Map

    Customized metric. You can specify either customized_scaling_metric_specification or predefined_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    disableScaleIn Boolean

    Boolean indicating whether scale in by the target tracking scaling policy is disabled. Defaults to false.

    estimatedInstanceWarmup Number

    Estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

    predefinedScalingMetricSpecification Property Map

    Predefined metric. You can specify either predefined_scaling_metric_specification or customized_scaling_metric_specification. More details can be found in the AWS Auto Scaling API Reference.

    scaleInCooldown Number

    Amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    scaleOutCooldown Number

    Amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

    ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecification, ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecificationArgs

    MetricName string

    Name of the metric.

    Namespace string

    Namespace of the metric.

    Statistic string

    Statistic of the metric. Valid values: Average, Maximum, Minimum, SampleCount, Sum.

    Dimensions Dictionary<string, string>

    Dimensions of the metric.

    Unit string

    Unit of the metric.

    MetricName string

    Name of the metric.

    Namespace string

    Namespace of the metric.

    Statistic string

    Statistic of the metric. Valid values: Average, Maximum, Minimum, SampleCount, Sum.

    Dimensions map[string]string

    Dimensions of the metric.

    Unit string

    Unit of the metric.

    metricName String

    Name of the metric.

    namespace String

    Namespace of the metric.

    statistic String

    Statistic of the metric. Valid values: Average, Maximum, Minimum, SampleCount, Sum.

    dimensions Map<String,String>

    Dimensions of the metric.

    unit String

    Unit of the metric.

    metricName string

    Name of the metric.

    namespace string

    Namespace of the metric.

    statistic string

    Statistic of the metric. Valid values: Average, Maximum, Minimum, SampleCount, Sum.

    dimensions {[key: string]: string}

    Dimensions of the metric.

    unit string

    Unit of the metric.

    metric_name str

    Name of the metric.

    namespace str

    Namespace of the metric.

    statistic str

    Statistic of the metric. Valid values: Average, Maximum, Minimum, SampleCount, Sum.

    dimensions Mapping[str, str]

    Dimensions of the metric.

    unit str

    Unit of the metric.

    metricName String

    Name of the metric.

    namespace String

    Namespace of the metric.

    statistic String

    Statistic of the metric. Valid values: Average, Maximum, Minimum, SampleCount, Sum.

    dimensions Map<String>

    Dimensions of the metric.

    unit String

    Unit of the metric.

    ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecification, ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecificationArgs

    PredefinedScalingMetricType string

    Metric type. Valid values: ALBRequestCountPerTarget, ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections.

    ResourceLabel string

    Identifies the resource associated with the metric type.

    PredefinedScalingMetricType string

    Metric type. Valid values: ALBRequestCountPerTarget, ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections.

    ResourceLabel string

    Identifies the resource associated with the metric type.

    predefinedScalingMetricType String

    Metric type. Valid values: ALBRequestCountPerTarget, ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections.

    resourceLabel String

    Identifies the resource associated with the metric type.

    predefinedScalingMetricType string

    Metric type. Valid values: ALBRequestCountPerTarget, ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections.

    resourceLabel string

    Identifies the resource associated with the metric type.

    predefined_scaling_metric_type str

    Metric type. Valid values: ALBRequestCountPerTarget, ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections.

    resource_label str

    Identifies the resource associated with the metric type.

    predefinedScalingMetricType String

    Metric type. Valid values: ALBRequestCountPerTarget, ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections.

    resourceLabel String

    Identifies the resource associated with the metric type.

    Import

    Using pulumi import, import Auto Scaling scaling plans using the name. For example:

     $ pulumi import aws:autoscalingplans/scalingPlan:ScalingPlan example MyScale1

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi
    pulumi/pulumi-aws