Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. autoscalingplans
  5. ScalingPlan
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.autoscalingplans.ScalingPlan

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 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.

Example Usage

Create ScalingPlan Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ScalingPlan(name: string, args: ScalingPlanArgs, opts?: CustomResourceOptions);
@overload
def ScalingPlan(resource_name: str,
                args: ScalingPlanArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def ScalingPlan(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                application_source: Optional[ScalingPlanApplicationSourceArgs] = None,
                scaling_instructions: Optional[Sequence[ScalingPlanScalingInstructionArgs]] = None,
                name: Optional[str] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ScalingPlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ScalingPlanArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ScalingPlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ScalingPlanArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var scalingPlanResource = new Aws.AutoScalingPlans.ScalingPlan("scalingPlanResource", new()
{
    ApplicationSource = new Aws.AutoScalingPlans.Inputs.ScalingPlanApplicationSourceArgs
    {
        CloudformationStackArn = "string",
        TagFilters = new[]
        {
            new Aws.AutoScalingPlans.Inputs.ScalingPlanApplicationSourceTagFilterArgs
            {
                Key = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
    },
    ScalingInstructions = new[]
    {
        new Aws.AutoScalingPlans.Inputs.ScalingPlanScalingInstructionArgs
        {
            ScalableDimension = "string",
            ResourceId = "string",
            MaxCapacity = 0,
            MinCapacity = 0,
            TargetTrackingConfigurations = new[]
            {
                new Aws.AutoScalingPlans.Inputs.ScalingPlanScalingInstructionTargetTrackingConfigurationArgs
                {
                    TargetValue = 0,
                    CustomizedScalingMetricSpecification = new Aws.AutoScalingPlans.Inputs.ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecificationArgs
                    {
                        MetricName = "string",
                        Namespace = "string",
                        Statistic = "string",
                        Dimensions = 
                        {
                            { "string", "string" },
                        },
                        Unit = "string",
                    },
                    DisableScaleIn = false,
                    EstimatedInstanceWarmup = 0,
                    PredefinedScalingMetricSpecification = new Aws.AutoScalingPlans.Inputs.ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecificationArgs
                    {
                        PredefinedScalingMetricType = "string",
                        ResourceLabel = "string",
                    },
                    ScaleInCooldown = 0,
                    ScaleOutCooldown = 0,
                },
            },
            ServiceNamespace = "string",
            PredefinedLoadMetricSpecification = new Aws.AutoScalingPlans.Inputs.ScalingPlanScalingInstructionPredefinedLoadMetricSpecificationArgs
            {
                PredefinedLoadMetricType = "string",
                ResourceLabel = "string",
            },
            PredictiveScalingMaxCapacityBuffer = 0,
            ScalingPolicyUpdateBehavior = "string",
            CustomizedLoadMetricSpecification = new Aws.AutoScalingPlans.Inputs.ScalingPlanScalingInstructionCustomizedLoadMetricSpecificationArgs
            {
                MetricName = "string",
                Namespace = "string",
                Statistic = "string",
                Dimensions = 
                {
                    { "string", "string" },
                },
                Unit = "string",
            },
            DisableDynamicScaling = false,
            ScheduledActionBufferTime = 0,
            PredictiveScalingMaxCapacityBehavior = "string",
            PredictiveScalingMode = "string",
        },
    },
    Name = "string",
});
Copy
example, err := autoscalingplans.NewScalingPlan(ctx, "scalingPlanResource", &autoscalingplans.ScalingPlanArgs{
	ApplicationSource: &autoscalingplans.ScalingPlanApplicationSourceArgs{
		CloudformationStackArn: pulumi.String("string"),
		TagFilters: autoscalingplans.ScalingPlanApplicationSourceTagFilterArray{
			&autoscalingplans.ScalingPlanApplicationSourceTagFilterArgs{
				Key: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
	ScalingInstructions: autoscalingplans.ScalingPlanScalingInstructionArray{
		&autoscalingplans.ScalingPlanScalingInstructionArgs{
			ScalableDimension: pulumi.String("string"),
			ResourceId:        pulumi.String("string"),
			MaxCapacity:       pulumi.Int(0),
			MinCapacity:       pulumi.Int(0),
			TargetTrackingConfigurations: autoscalingplans.ScalingPlanScalingInstructionTargetTrackingConfigurationArray{
				&autoscalingplans.ScalingPlanScalingInstructionTargetTrackingConfigurationArgs{
					TargetValue: pulumi.Float64(0),
					CustomizedScalingMetricSpecification: &autoscalingplans.ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecificationArgs{
						MetricName: pulumi.String("string"),
						Namespace:  pulumi.String("string"),
						Statistic:  pulumi.String("string"),
						Dimensions: pulumi.StringMap{
							"string": pulumi.String("string"),
						},
						Unit: pulumi.String("string"),
					},
					DisableScaleIn:          pulumi.Bool(false),
					EstimatedInstanceWarmup: pulumi.Int(0),
					PredefinedScalingMetricSpecification: &autoscalingplans.ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecificationArgs{
						PredefinedScalingMetricType: pulumi.String("string"),
						ResourceLabel:               pulumi.String("string"),
					},
					ScaleInCooldown:  pulumi.Int(0),
					ScaleOutCooldown: pulumi.Int(0),
				},
			},
			ServiceNamespace: pulumi.String("string"),
			PredefinedLoadMetricSpecification: &autoscalingplans.ScalingPlanScalingInstructionPredefinedLoadMetricSpecificationArgs{
				PredefinedLoadMetricType: pulumi.String("string"),
				ResourceLabel:            pulumi.String("string"),
			},
			PredictiveScalingMaxCapacityBuffer: pulumi.Int(0),
			ScalingPolicyUpdateBehavior:        pulumi.String("string"),
			CustomizedLoadMetricSpecification: &autoscalingplans.ScalingPlanScalingInstructionCustomizedLoadMetricSpecificationArgs{
				MetricName: pulumi.String("string"),
				Namespace:  pulumi.String("string"),
				Statistic:  pulumi.String("string"),
				Dimensions: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
				Unit: pulumi.String("string"),
			},
			DisableDynamicScaling:                pulumi.Bool(false),
			ScheduledActionBufferTime:            pulumi.Int(0),
			PredictiveScalingMaxCapacityBehavior: pulumi.String("string"),
			PredictiveScalingMode:                pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
})
Copy
var scalingPlanResource = new ScalingPlan("scalingPlanResource", ScalingPlanArgs.builder()
    .applicationSource(ScalingPlanApplicationSourceArgs.builder()
        .cloudformationStackArn("string")
        .tagFilters(ScalingPlanApplicationSourceTagFilterArgs.builder()
            .key("string")
            .values("string")
            .build())
        .build())
    .scalingInstructions(ScalingPlanScalingInstructionArgs.builder()
        .scalableDimension("string")
        .resourceId("string")
        .maxCapacity(0)
        .minCapacity(0)
        .targetTrackingConfigurations(ScalingPlanScalingInstructionTargetTrackingConfigurationArgs.builder()
            .targetValue(0)
            .customizedScalingMetricSpecification(ScalingPlanScalingInstructionTargetTrackingConfigurationCustomizedScalingMetricSpecificationArgs.builder()
                .metricName("string")
                .namespace("string")
                .statistic("string")
                .dimensions(Map.of("string", "string"))
                .unit("string")
                .build())
            .disableScaleIn(false)
            .estimatedInstanceWarmup(0)
            .predefinedScalingMetricSpecification(ScalingPlanScalingInstructionTargetTrackingConfigurationPredefinedScalingMetricSpecificationArgs.builder()
                .predefinedScalingMetricType("string")
                .resourceLabel("string")
                .build())
            .scaleInCooldown(0)
            .scaleOutCooldown(0)
            .build())
        .serviceNamespace("string")
        .predefinedLoadMetricSpecification(ScalingPlanScalingInstructionPredefinedLoadMetricSpecificationArgs.builder()
            .predefinedLoadMetricType("string")
            .resourceLabel("string")
            .build())
        .predictiveScalingMaxCapacityBuffer(0)
        .scalingPolicyUpdateBehavior("string")
        .customizedLoadMetricSpecification(ScalingPlanScalingInstructionCustomizedLoadMetricSpecificationArgs.builder()
            .metricName("string")
            .namespace("string")
            .statistic("string")
            .dimensions(Map.of("string", "string"))
            .unit("string")
            .build())
        .disableDynamicScaling(false)
        .scheduledActionBufferTime(0)
        .predictiveScalingMaxCapacityBehavior("string")
        .predictiveScalingMode("string")
        .build())
    .name("string")
    .build());
Copy
scaling_plan_resource = aws.autoscalingplans.ScalingPlan("scalingPlanResource",
    application_source={
        "cloudformation_stack_arn": "string",
        "tag_filters": [{
            "key": "string",
            "values": ["string"],
        }],
    },
    scaling_instructions=[{
        "scalable_dimension": "string",
        "resource_id": "string",
        "max_capacity": 0,
        "min_capacity": 0,
        "target_tracking_configurations": [{
            "target_value": 0,
            "customized_scaling_metric_specification": {
                "metric_name": "string",
                "namespace": "string",
                "statistic": "string",
                "dimensions": {
                    "string": "string",
                },
                "unit": "string",
            },
            "disable_scale_in": False,
            "estimated_instance_warmup": 0,
            "predefined_scaling_metric_specification": {
                "predefined_scaling_metric_type": "string",
                "resource_label": "string",
            },
            "scale_in_cooldown": 0,
            "scale_out_cooldown": 0,
        }],
        "service_namespace": "string",
        "predefined_load_metric_specification": {
            "predefined_load_metric_type": "string",
            "resource_label": "string",
        },
        "predictive_scaling_max_capacity_buffer": 0,
        "scaling_policy_update_behavior": "string",
        "customized_load_metric_specification": {
            "metric_name": "string",
            "namespace": "string",
            "statistic": "string",
            "dimensions": {
                "string": "string",
            },
            "unit": "string",
        },
        "disable_dynamic_scaling": False,
        "scheduled_action_buffer_time": 0,
        "predictive_scaling_max_capacity_behavior": "string",
        "predictive_scaling_mode": "string",
    }],
    name="string")
Copy
const scalingPlanResource = new aws.autoscalingplans.ScalingPlan("scalingPlanResource", {
    applicationSource: {
        cloudformationStackArn: "string",
        tagFilters: [{
            key: "string",
            values: ["string"],
        }],
    },
    scalingInstructions: [{
        scalableDimension: "string",
        resourceId: "string",
        maxCapacity: 0,
        minCapacity: 0,
        targetTrackingConfigurations: [{
            targetValue: 0,
            customizedScalingMetricSpecification: {
                metricName: "string",
                namespace: "string",
                statistic: "string",
                dimensions: {
                    string: "string",
                },
                unit: "string",
            },
            disableScaleIn: false,
            estimatedInstanceWarmup: 0,
            predefinedScalingMetricSpecification: {
                predefinedScalingMetricType: "string",
                resourceLabel: "string",
            },
            scaleInCooldown: 0,
            scaleOutCooldown: 0,
        }],
        serviceNamespace: "string",
        predefinedLoadMetricSpecification: {
            predefinedLoadMetricType: "string",
            resourceLabel: "string",
        },
        predictiveScalingMaxCapacityBuffer: 0,
        scalingPolicyUpdateBehavior: "string",
        customizedLoadMetricSpecification: {
            metricName: "string",
            namespace: "string",
            statistic: "string",
            dimensions: {
                string: "string",
            },
            unit: "string",
        },
        disableDynamicScaling: false,
        scheduledActionBufferTime: 0,
        predictiveScalingMaxCapacityBehavior: "string",
        predictiveScalingMode: "string",
    }],
    name: "string",
});
Copy
type: aws:autoscalingplans:ScalingPlan
properties:
    applicationSource:
        cloudformationStackArn: string
        tagFilters:
            - key: string
              values:
                - string
    name: string
    scalingInstructions:
        - customizedLoadMetricSpecification:
            dimensions:
                string: string
            metricName: string
            namespace: string
            statistic: string
            unit: string
          disableDynamicScaling: false
          maxCapacity: 0
          minCapacity: 0
          predefinedLoadMetricSpecification:
            predefinedLoadMetricType: string
            resourceLabel: string
          predictiveScalingMaxCapacityBehavior: string
          predictiveScalingMaxCapacityBuffer: 0
          predictiveScalingMode: string
          resourceId: string
          scalableDimension: string
          scalingPolicyUpdateBehavior: string
          scheduledActionBufferTime: 0
          serviceNamespace: string
          targetTrackingConfigurations:
            - customizedScalingMetricSpecification:
                dimensions:
                    string: string
                metricName: string
                namespace: string
                statistic: string
                unit: string
              disableScaleIn: false
              estimatedInstanceWarmup: 0
              predefinedScalingMetricSpecification:
                predefinedScalingMetricType: string
                resourceLabel: string
              scaleInCooldown: 0
              scaleOutCooldown: 0
              targetValue: 0
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ScalingPlan resource accepts the following input properties:

ApplicationSource This property is required. ScalingPlanApplicationSource
CloudFormation stack or set of tags. You can create one scaling plan per application source.
ScalingInstructions This property is required. List<ScalingPlanScalingInstruction>
Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.
Name Changes to this property will trigger replacement. string
Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
ApplicationSource This property is required. ScalingPlanApplicationSourceArgs
CloudFormation stack or set of tags. You can create one scaling plan per application source.
ScalingInstructions This property is required. []ScalingPlanScalingInstructionArgs
Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.
Name Changes to this property will trigger replacement. string
Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
applicationSource This property is required. ScalingPlanApplicationSource
CloudFormation stack or set of tags. You can create one scaling plan per application source.
scalingInstructions This property is required. List<ScalingPlanScalingInstruction>
Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.
name Changes to this property will trigger replacement. String
Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
applicationSource This property is required. ScalingPlanApplicationSource
CloudFormation stack or set of tags. You can create one scaling plan per application source.
scalingInstructions This property is required. ScalingPlanScalingInstruction[]
Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.
name Changes to this property will trigger replacement. string
Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
application_source This property is required. ScalingPlanApplicationSourceArgs
CloudFormation stack or set of tags. You can create one scaling plan per application source.
scaling_instructions This property is required. Sequence[ScalingPlanScalingInstructionArgs]
Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.
name Changes to this property will trigger replacement. str
Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
applicationSource This property is required. Property Map
CloudFormation stack or set of tags. You can create one scaling plan per application source.
scalingInstructions This property is required. List<Property Map>
Scaling instructions. More details can be found in the AWS Auto Scaling API Reference.
name Changes to this property will trigger replacement. 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)
resources:  _:    type: aws:autoscalingplans:ScalingPlan    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 This property is required. string
Tag key.
Values List<string>
Tag values.
Key This property is required. string
Tag key.
Values []string
Tag values.
key This property is required. String
Tag key.
values List<String>
Tag values.
key This property is required. string
Tag key.
values string[]
Tag values.
key This property is required. str
Tag key.
values Sequence[str]
Tag values.
key This property is required. String
Tag key.
values List<String>
Tag values.

ScalingPlanScalingInstruction
, ScalingPlanScalingInstructionArgs

MaxCapacity This property is required. 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 This property is required. int
Minimum capacity of the resource.
ResourceId This property is required. string
ID of the resource. This string consists of the resource type and unique identifier.
ScalableDimension This property is required. 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 This property is required. string
Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.
TargetTrackingConfigurations This property is required. 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 This property is required. 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 This property is required. int
Minimum capacity of the resource.
ResourceId This property is required. string
ID of the resource. This string consists of the resource type and unique identifier.
ScalableDimension This property is required. 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 This property is required. string
Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.
TargetTrackingConfigurations This property is required. []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 This property is required. 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 This property is required. Integer
Minimum capacity of the resource.
resourceId This property is required. String
ID of the resource. This string consists of the resource type and unique identifier.
scalableDimension This property is required. 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 This property is required. String
Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.
targetTrackingConfigurations This property is required. 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 This property is required. 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 This property is required. number
Minimum capacity of the resource.
resourceId This property is required. string
ID of the resource. This string consists of the resource type and unique identifier.
scalableDimension This property is required. 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 This property is required. string
Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.
targetTrackingConfigurations This property is required. 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 This property is required. 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 This property is required. int
Minimum capacity of the resource.
resource_id This property is required. str
ID of the resource. This string consists of the resource type and unique identifier.
scalable_dimension This property is required. 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 This property is required. str
Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.
target_tracking_configurations This property is required. 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 This property is required. 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 This property is required. Number
Minimum capacity of the resource.
resourceId This property is required. String
ID of the resource. This string consists of the resource type and unique identifier.
scalableDimension This property is required. 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 This property is required. String
Namespace of the AWS service. Valid values: autoscaling, dynamodb, ecs, ec2, rds.
targetTrackingConfigurations This property is required. 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 This property is required. string
Name of the metric.
Namespace This property is required. string
Namespace of the metric.
Statistic This property is required. 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 This property is required. string
Name of the metric.
Namespace This property is required. string
Namespace of the metric.
Statistic This property is required. 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 This property is required. String
Name of the metric.
namespace This property is required. String
Namespace of the metric.
statistic This property is required. 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 This property is required. string
Name of the metric.
namespace This property is required. string
Namespace of the metric.
statistic This property is required. 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 This property is required. str
Name of the metric.
namespace This property is required. str
Namespace of the metric.
statistic This property is required. 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 This property is required. String
Name of the metric.
namespace This property is required. String
Namespace of the metric.
statistic This property is required. 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 This property is required. string
Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.
ResourceLabel string
Identifies the resource associated with the metric type.
PredefinedLoadMetricType This property is required. string
Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.
ResourceLabel string
Identifies the resource associated with the metric type.
predefinedLoadMetricType This property is required. String
Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.
resourceLabel String
Identifies the resource associated with the metric type.
predefinedLoadMetricType This property is required. string
Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.
resourceLabel string
Identifies the resource associated with the metric type.
predefined_load_metric_type This property is required. str
Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.
resource_label str
Identifies the resource associated with the metric type.
predefinedLoadMetricType This property is required. String
Metric type. Valid values: ALBTargetGroupRequestCount, ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut.
resourceLabel String
Identifies the resource associated with the metric type.

ScalingPlanScalingInstructionTargetTrackingConfiguration
, ScalingPlanScalingInstructionTargetTrackingConfigurationArgs

TargetValue This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Name of the metric.
Namespace This property is required. string
Namespace of the metric.
Statistic This property is required. 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 This property is required. string
Name of the metric.
Namespace This property is required. string
Namespace of the metric.
Statistic This property is required. 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 This property is required. String
Name of the metric.
namespace This property is required. String
Namespace of the metric.
statistic This property is required. 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 This property is required. string
Name of the metric.
namespace This property is required. string
Namespace of the metric.
statistic This property is required. 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 This property is required. str
Name of the metric.
namespace This property is required. str
Namespace of the metric.
statistic This property is required. 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 This property is required. String
Name of the metric.
namespace This property is required. String
Namespace of the metric.
statistic This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws