aws-native.autoscalingplans.getScalingPlan

AWS Cloud Control v1.85.0, Nov 2 26

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getScalingPlan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getScalingPlan(args: GetScalingPlanArgs, opts?: InvokeOptions): Promise<GetScalingPlanResult>
function getScalingPlanOutput(args: GetScalingPlanOutputArgs, opts?: InvokeOutputOptions): Output<GetScalingPlanResult>

def get_scaling_plan(scaling_plan_name: Optional[str] = None,
                     scaling_plan_version: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetScalingPlanResult
def get_scaling_plan_output(scaling_plan_name: pulumi.Input[Optional[str]] = None,
                     scaling_plan_version: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetScalingPlanResult]

func LookupScalingPlan(ctx *Context, args *LookupScalingPlanArgs, opts ...InvokeOption) (*LookupScalingPlanResult, error)
func LookupScalingPlanOutput(ctx *Context, args *LookupScalingPlanOutputArgs, opts ...InvokeOption) LookupScalingPlanResultOutput

> Note: This function is named LookupScalingPlan in the Go SDK.

public static class GetScalingPlan 
{
    public static Task<GetScalingPlanResult> InvokeAsync(GetScalingPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetScalingPlanResult> Invoke(GetScalingPlanInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetScalingPlanResult> Invoke(GetScalingPlanInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetScalingPlanResult> getScalingPlan(GetScalingPlanArgs args, InvokeOptions options)
public static Output<GetScalingPlanResult> getScalingPlan(GetScalingPlanArgs args, InvokeOptions options)
public static Output<GetScalingPlanResult> getScalingPlan(GetScalingPlanArgs args, InvokeOutputOptions options)

fn::invoke:
  function: aws-native:autoscalingplans:getScalingPlan
  arguments:
    # arguments dictionary

data "aws-native_autoscalingplans_get_scaling_plan" "name" {
    # arguments
}

The following arguments are supported:

ScalingPlanName string: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
ScalingPlanVersion string: The version number of the scaling plan. This value is always 1.

ScalingPlanName string: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
ScalingPlanVersion string: The version number of the scaling plan. This value is always 1.

scaling_plan_name string: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scaling_plan_version string: The version number of the scaling plan. This value is always 1.

scalingPlanName String: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scalingPlanVersion String: The version number of the scaling plan. This value is always 1.

scalingPlanName string: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scalingPlanVersion string: The version number of the scaling plan. This value is always 1.

scaling_plan_name str: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scaling_plan_version str: The version number of the scaling plan. This value is always 1.

scalingPlanName String: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scalingPlanVersion String: The version number of the scaling plan. This value is always 1.

getScalingPlan Result

The following output properties are available:

ApplicationSource Pulumi.AwsNative.AutoScalingPlans.Outputs.ScalingPlanApplicationSource: A CloudFormation stack or a set of tags. You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.
ScalingInstructions List<Pulumi.AwsNative.AutoScalingPlans.Outputs.ScalingPlanScalingInstruction>: The scaling instructions.
ScalingPlanArn string: The Amazon Resource Name (ARN) of the scaling plan.
ScalingPlanName string: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
ScalingPlanVersion string: The version number of the scaling plan. This value is always 1.

ApplicationSource ScalingPlanApplicationSource: A CloudFormation stack or a set of tags. You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.
ScalingInstructions []ScalingPlanScalingInstruction: The scaling instructions.
ScalingPlanArn string: The Amazon Resource Name (ARN) of the scaling plan.
ScalingPlanName string: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
ScalingPlanVersion string: The version number of the scaling plan. This value is always 1.

application_source object: A CloudFormation stack or a set of tags. You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.
scaling_instructions list(object): The scaling instructions.
scaling_plan_arn string: The Amazon Resource Name (ARN) of the scaling plan.
scaling_plan_name string: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scaling_plan_version string: The version number of the scaling plan. This value is always 1.

applicationSource ScalingPlanApplicationSource: A CloudFormation stack or a set of tags. You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.
scalingInstructions List<ScalingPlanScalingInstruction>: The scaling instructions.
scalingPlanArn String: The Amazon Resource Name (ARN) of the scaling plan.
scalingPlanName String: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scalingPlanVersion String: The version number of the scaling plan. This value is always 1.

applicationSource ScalingPlanApplicationSource: A CloudFormation stack or a set of tags. You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.
scalingInstructions ScalingPlanScalingInstruction[]: The scaling instructions.
scalingPlanArn string: The Amazon Resource Name (ARN) of the scaling plan.
scalingPlanName string: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scalingPlanVersion string: The version number of the scaling plan. This value is always 1.

application_source ScalingPlanApplicationSource: A CloudFormation stack or a set of tags. You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.
scaling_instructions Sequence[ScalingPlanScalingInstruction]: The scaling instructions.
scaling_plan_arn str: The Amazon Resource Name (ARN) of the scaling plan.
scaling_plan_name str: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scaling_plan_version str: The version number of the scaling plan. This value is always 1.

applicationSource Property Map: A CloudFormation stack or a set of tags. You can create one scaling plan per application source. The ApplicationSource property must be present to ensure interoperability with the AWS Auto Scaling console.
scalingInstructions List<Property Map>: The scaling instructions.
scalingPlanArn String: The Amazon Resource Name (ARN) of the scaling plan.
scalingPlanName String: The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
scalingPlanVersion String: The version number of the scaling plan. This value is always 1.

Supporting Types

ScalingPlanApplicationSource

CloudFormationStackArn string: The Amazon Resource Name (ARN) of a CloudFormation stack. The stack must contain at least one scalable resource.
TagFilters List<Pulumi.AwsNative.AutoScalingPlans.Inputs.ScalingPlanTagFilter>: A set of tag filters (keys and values). Each tag filter specified must contain a key with values as optional. Each scaling plan can include up to 50 keys, and each key can include up to 20 values.

CloudFormationStackArn string: The Amazon Resource Name (ARN) of a CloudFormation stack. The stack must contain at least one scalable resource.
TagFilters []ScalingPlanTagFilter: A set of tag filters (keys and values). Each tag filter specified must contain a key with values as optional. Each scaling plan can include up to 50 keys, and each key can include up to 20 values.

cloud_formation_stack_arn string: The Amazon Resource Name (ARN) of a CloudFormation stack. The stack must contain at least one scalable resource.
tag_filters list(object): A set of tag filters (keys and values). Each tag filter specified must contain a key with values as optional. Each scaling plan can include up to 50 keys, and each key can include up to 20 values.

cloudFormationStackArn String: The Amazon Resource Name (ARN) of a CloudFormation stack. The stack must contain at least one scalable resource.
tagFilters List<ScalingPlanTagFilter>: A set of tag filters (keys and values). Each tag filter specified must contain a key with values as optional. Each scaling plan can include up to 50 keys, and each key can include up to 20 values.

cloudFormationStackArn string: The Amazon Resource Name (ARN) of a CloudFormation stack. The stack must contain at least one scalable resource.
tagFilters ScalingPlanTagFilter[]: A set of tag filters (keys and values). Each tag filter specified must contain a key with values as optional. Each scaling plan can include up to 50 keys, and each key can include up to 20 values.

cloud_formation_stack_arn str: The Amazon Resource Name (ARN) of a CloudFormation stack. The stack must contain at least one scalable resource.
tag_filters Sequence[ScalingPlanTagFilter]: A set of tag filters (keys and values). Each tag filter specified must contain a key with values as optional. Each scaling plan can include up to 50 keys, and each key can include up to 20 values.

cloudFormationStackArn String: The Amazon Resource Name (ARN) of a CloudFormation stack. The stack must contain at least one scalable resource.
tagFilters List<Property Map>: A set of tag filters (keys and values). Each tag filter specified must contain a key with values as optional. Each scaling plan can include up to 50 keys, and each key can include up to 20 values.

ScalingPlanCustomizedLoadMetricSpecification

MetricName string: The name of the metric.
Namespace string: The namespace of the metric.
Statistic string: The statistic of the metric.
Dimensions List<Pulumi.AwsNative.AutoScalingPlans.Inputs.ScalingPlanMetricDimension>: The dimensions of the metric.
Unit string: The unit of the metric.

MetricName string: The name of the metric.
Namespace string: The namespace of the metric.
Statistic string: The statistic of the metric.
Dimensions []ScalingPlanMetricDimension: The dimensions of the metric.
Unit string: The unit of the metric.

metric_name string: The name of the metric.
namespace string: The namespace of the metric.
statistic string: The statistic of the metric.
dimensions list(object): The dimensions of the metric.
unit string: The unit of the metric.

metricName String: The name of the metric.
namespace String: The namespace of the metric.
statistic String: The statistic of the metric.
dimensions List<ScalingPlanMetricDimension>: The dimensions of the metric.
unit String: The unit of the metric.

metricName string: The name of the metric.
namespace string: The namespace of the metric.
statistic string: The statistic of the metric.
dimensions ScalingPlanMetricDimension[]: The dimensions of the metric.
unit string: The unit of the metric.

metric_name str: The name of the metric.
namespace str: The namespace of the metric.
statistic str: The statistic of the metric.
dimensions Sequence[ScalingPlanMetricDimension]: The dimensions of the metric.
unit str: The unit of the metric.

metricName String: The name of the metric.
namespace String: The namespace of the metric.
statistic String: The statistic of the metric.
dimensions List<Property Map>: The dimensions of the metric.
unit String: The unit of the metric.

ScalingPlanCustomizedScalingMetricSpecification

MetricName string: The name of the metric.
Namespace string: The namespace of the metric.
Statistic string: The statistic of the metric.
Dimensions List<Pulumi.AwsNative.AutoScalingPlans.Inputs.ScalingPlanMetricDimension>: The dimensions of the metric.
Unit string: The unit of the metric.

MetricName string: The name of the metric.
Namespace string: The namespace of the metric.
Statistic string: The statistic of the metric.
Dimensions []ScalingPlanMetricDimension: The dimensions of the metric.
Unit string: The unit of the metric.

metric_name string: The name of the metric.
namespace string: The namespace of the metric.
statistic string: The statistic of the metric.
dimensions list(object): The dimensions of the metric.
unit string: The unit of the metric.

metricName String: The name of the metric.
namespace String: The namespace of the metric.
statistic String: The statistic of the metric.
dimensions List<ScalingPlanMetricDimension>: The dimensions of the metric.
unit String: The unit of the metric.

metricName string: The name of the metric.
namespace string: The namespace of the metric.
statistic string: The statistic of the metric.
dimensions ScalingPlanMetricDimension[]: The dimensions of the metric.
unit string: The unit of the metric.

metric_name str: The name of the metric.
namespace str: The namespace of the metric.
statistic str: The statistic of the metric.
dimensions Sequence[ScalingPlanMetricDimension]: The dimensions of the metric.
unit str: The unit of the metric.

metricName String: The name of the metric.
namespace String: The namespace of the metric.
statistic String: The statistic of the metric.
dimensions List<Property Map>: The dimensions of the metric.
unit String: The unit of the metric.

ScalingPlanMetricDimension

Name string: The name of the dimension.
Value string: The value of the dimension.

Name string: The name of the dimension.
Value string: The value of the dimension.

name string: The name of the dimension.
value string: The value of the dimension.

name String: The name of the dimension.
value String: The value of the dimension.

name string: The name of the dimension.
value string: The value of the dimension.

name str: The name of the dimension.
value str: The value of the dimension.

name String: The name of the dimension.
value String: The value of the dimension.

ScalingPlanPredefinedLoadMetricSpecification

PredefinedLoadMetricType string: The metric type.
ResourceLabel string: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

PredefinedLoadMetricType string: The metric type.
ResourceLabel string: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

predefined_load_metric_type string: The metric type.
resource_label string: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

predefinedLoadMetricType String: The metric type.
resourceLabel String: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

predefinedLoadMetricType string: The metric type.
resourceLabel string: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

predefined_load_metric_type str: The metric type.
resource_label str: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

predefinedLoadMetricType String: The metric type.
resourceLabel String: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

ScalingPlanPredefinedScalingMetricSpecification

PredefinedScalingMetricType string: The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
ResourceLabel string: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

PredefinedScalingMetricType string: The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
ResourceLabel string: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

predefined_scaling_metric_type string: The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
resource_label string: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

predefinedScalingMetricType String: The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
resourceLabel String: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

predefinedScalingMetricType string: The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
resourceLabel string: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

predefined_scaling_metric_type str: The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
resource_label str: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

predefinedScalingMetricType String: The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
resourceLabel String: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

ScalingPlanScalingInstruction

MaxCapacity int: The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
MinCapacity int: The minimum capacity of the resource.
ResourceId string: The ID of the resource. This string consists of the resource type and unique identifier.
ScalableDimension string: The scalable dimension associated with the resource.
ServiceNamespace string: The namespace of the AWS service.
TargetTrackingConfigurations List<Pulumi.AwsNative.AutoScalingPlans.Inputs.ScalingPlanTargetTrackingConfiguration>: The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
CustomizedLoadMetricSpecification Pulumi.AwsNative.AutoScalingPlans.Inputs.ScalingPlanCustomizedLoadMetricSpecification: The customized load metric to use for predictive scaling. This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
DisableDynamicScaling bool: Controls whether dynamic scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false).
PredefinedLoadMetricSpecification Pulumi.AwsNative.AutoScalingPlans.Inputs.ScalingPlanPredefinedLoadMetricSpecification: The predefined load metric to use for predictive scaling. This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
PredictiveScalingMaxCapacityBehavior string: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
PredictiveScalingMaxCapacityBuffer int: The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. The range is 1-100. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
PredictiveScalingMode string: The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.
ScalingPolicyUpdateBehavior string: Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. The default value is KeepExternalPolicies. Valid only when configuring dynamic scaling.
ScheduledActionBufferTime int: The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Valid only when configuring predictive scaling.

MaxCapacity int: The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
MinCapacity int: The minimum capacity of the resource.
ResourceId string: The ID of the resource. This string consists of the resource type and unique identifier.
ScalableDimension string: The scalable dimension associated with the resource.
ServiceNamespace string: The namespace of the AWS service.
TargetTrackingConfigurations []ScalingPlanTargetTrackingConfiguration: The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
CustomizedLoadMetricSpecification ScalingPlanCustomizedLoadMetricSpecification: The customized load metric to use for predictive scaling. This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
DisableDynamicScaling bool: Controls whether dynamic scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false).
PredefinedLoadMetricSpecification ScalingPlanPredefinedLoadMetricSpecification: The predefined load metric to use for predictive scaling. This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
PredictiveScalingMaxCapacityBehavior string: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
PredictiveScalingMaxCapacityBuffer int: The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. The range is 1-100. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
PredictiveScalingMode string: The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.
ScalingPolicyUpdateBehavior string: Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. The default value is KeepExternalPolicies. Valid only when configuring dynamic scaling.
ScheduledActionBufferTime int: The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Valid only when configuring predictive scaling.

max_capacity number: The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
min_capacity number: The minimum capacity of the resource.
resource_id string: The ID of the resource. This string consists of the resource type and unique identifier.
scalable_dimension string: The scalable dimension associated with the resource.
service_namespace string: The namespace of the AWS service.
target_tracking_configurations list(object): The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
customized_load_metric_specification object: The customized load metric to use for predictive scaling. This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
disable_dynamic_scaling bool: Controls whether dynamic scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false).
predefined_load_metric_specification object: The predefined load metric to use for predictive scaling. This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
predictive_scaling_max_capacity_behavior string: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
predictive_scaling_max_capacity_buffer number: The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. The range is 1-100. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
predictive_scaling_mode string: The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.
scaling_policy_update_behavior string: Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. The default value is KeepExternalPolicies. Valid only when configuring dynamic scaling.
scheduled_action_buffer_time number: The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Valid only when configuring predictive scaling.

maxCapacity Integer: The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
minCapacity Integer: The minimum capacity of the resource.
resourceId String: The ID of the resource. This string consists of the resource type and unique identifier.
scalableDimension String: The scalable dimension associated with the resource.
serviceNamespace String: The namespace of the AWS service.
targetTrackingConfigurations List<ScalingPlanTargetTrackingConfiguration>: The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
customizedLoadMetricSpecification ScalingPlanCustomizedLoadMetricSpecification: The customized load metric to use for predictive scaling. This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
disableDynamicScaling Boolean: Controls whether dynamic scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false).
predefinedLoadMetricSpecification ScalingPlanPredefinedLoadMetricSpecification: The predefined load metric to use for predictive scaling. This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
predictiveScalingMaxCapacityBehavior String: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
predictiveScalingMaxCapacityBuffer Integer: The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. The range is 1-100. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
predictiveScalingMode String: The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.
scalingPolicyUpdateBehavior String: Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. The default value is KeepExternalPolicies. Valid only when configuring dynamic scaling.
scheduledActionBufferTime Integer: The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Valid only when configuring predictive scaling.

maxCapacity number: The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
minCapacity number: The minimum capacity of the resource.
resourceId string: The ID of the resource. This string consists of the resource type and unique identifier.
scalableDimension string: The scalable dimension associated with the resource.
serviceNamespace string: The namespace of the AWS service.
targetTrackingConfigurations ScalingPlanTargetTrackingConfiguration[]: The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
customizedLoadMetricSpecification ScalingPlanCustomizedLoadMetricSpecification: The customized load metric to use for predictive scaling. This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
disableDynamicScaling boolean: Controls whether dynamic scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false).
predefinedLoadMetricSpecification ScalingPlanPredefinedLoadMetricSpecification: The predefined load metric to use for predictive scaling. This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
predictiveScalingMaxCapacityBehavior string: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
predictiveScalingMaxCapacityBuffer number: The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. The range is 1-100. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
predictiveScalingMode string: The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.
scalingPolicyUpdateBehavior string: Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. The default value is KeepExternalPolicies. Valid only when configuring dynamic scaling.
scheduledActionBufferTime number: The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Valid only when configuring predictive scaling.

max_capacity int: The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
min_capacity int: The minimum capacity of the resource.
resource_id str: The ID of the resource. This string consists of the resource type and unique identifier.
scalable_dimension str: The scalable dimension associated with the resource.
service_namespace str: The namespace of the AWS service.
target_tracking_configurations Sequence[ScalingPlanTargetTrackingConfiguration]: The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
customized_load_metric_specification ScalingPlanCustomizedLoadMetricSpecification: The customized load metric to use for predictive scaling. This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
disable_dynamic_scaling bool: Controls whether dynamic scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false).
predefined_load_metric_specification ScalingPlanPredefinedLoadMetricSpecification: The predefined load metric to use for predictive scaling. This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
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. The default value is SetForecastCapacityToMaxCapacity.
predictive_scaling_max_capacity_buffer int: The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. The range is 1-100. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
predictive_scaling_mode str: The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.
scaling_policy_update_behavior str: Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. The default value is KeepExternalPolicies. Valid only when configuring dynamic scaling.
scheduled_action_buffer_time int: The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Valid only when configuring predictive scaling.

maxCapacity Number: The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
minCapacity Number: The minimum capacity of the resource.
resourceId String: The ID of the resource. This string consists of the resource type and unique identifier.
scalableDimension String: The scalable dimension associated with the resource.
serviceNamespace String: The namespace of the AWS service.
targetTrackingConfigurations List<Property Map>: The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
customizedLoadMetricSpecification Property Map: The customized load metric to use for predictive scaling. This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
disableDynamicScaling Boolean: Controls whether dynamic scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false).
predefinedLoadMetricSpecification Property Map: The predefined load metric to use for predictive scaling. This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
predictiveScalingMaxCapacityBehavior String: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
predictiveScalingMaxCapacityBuffer Number: The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. The range is 1-100. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
predictiveScalingMode String: The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.
scalingPolicyUpdateBehavior String: Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. The default value is KeepExternalPolicies. Valid only when configuring dynamic scaling.
scheduledActionBufferTime Number: The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Valid only when configuring predictive scaling.

ScalingPlanTagFilter

Key string: The tag key.
Values List<string>: The tag values (0 to 20).

Key string: The tag key.
Values []string: The tag values (0 to 20).

key string: The tag key.
values list(string): The tag values (0 to 20).

key String: The tag key.
values List<String>: The tag values (0 to 20).

key string: The tag key.
values string[]: The tag values (0 to 20).

key str: The tag key.
values Sequence[str]: The tag values (0 to 20).

key String: The tag key.
values List<String>: The tag values (0 to 20).

ScalingPlanTargetTrackingConfiguration

TargetValue double: The target value for the metric.
CustomizedScalingMetricSpecification Pulumi.AwsNative.AutoScalingPlans.Inputs.ScalingPlanCustomizedScalingMetricSpecification: A customized metric. You can specify either a predefined metric or a customized metric.
DisableScaleIn bool: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
EstimatedInstanceWarmup int: The 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 Pulumi.AwsNative.AutoScalingPlans.Inputs.ScalingPlanPredefinedScalingMetricSpecification: A predefined metric. You can specify either a predefined metric or a customized metric.
ScaleInCooldown int: The 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: The 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: The target value for the metric.
CustomizedScalingMetricSpecification ScalingPlanCustomizedScalingMetricSpecification: A customized metric. You can specify either a predefined metric or a customized metric.
DisableScaleIn bool: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
EstimatedInstanceWarmup int: The 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 ScalingPlanPredefinedScalingMetricSpecification: A predefined metric. You can specify either a predefined metric or a customized metric.
ScaleInCooldown int: The 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: The 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 number: The target value for the metric.
customized_scaling_metric_specification object: A customized metric. You can specify either a predefined metric or a customized metric.
disable_scale_in bool: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
estimated_instance_warmup number: The 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 object: A predefined metric. You can specify either a predefined metric or a customized metric.
scale_in_cooldown number: The 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 number: The 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: The target value for the metric.
customizedScalingMetricSpecification ScalingPlanCustomizedScalingMetricSpecification: A customized metric. You can specify either a predefined metric or a customized metric.
disableScaleIn Boolean: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
estimatedInstanceWarmup Integer: The 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 ScalingPlanPredefinedScalingMetricSpecification: A predefined metric. You can specify either a predefined metric or a customized metric.
scaleInCooldown Integer: The 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: The 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: The target value for the metric.
customizedScalingMetricSpecification ScalingPlanCustomizedScalingMetricSpecification: A customized metric. You can specify either a predefined metric or a customized metric.
disableScaleIn boolean: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
estimatedInstanceWarmup number: The 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 ScalingPlanPredefinedScalingMetricSpecification: A predefined metric. You can specify either a predefined metric or a customized metric.
scaleInCooldown number: The 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: The 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: The target value for the metric.
customized_scaling_metric_specification ScalingPlanCustomizedScalingMetricSpecification: A customized metric. You can specify either a predefined metric or a customized metric.
disable_scale_in bool: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
estimated_instance_warmup int: The 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 ScalingPlanPredefinedScalingMetricSpecification: A predefined metric. You can specify either a predefined metric or a customized metric.
scale_in_cooldown int: The 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: The 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: The target value for the metric.
customizedScalingMetricSpecification Property Map: A customized metric. You can specify either a predefined metric or a customized metric.
disableScaleIn Boolean: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
estimatedInstanceWarmup Number: The 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: A predefined metric. You can specify either a predefined metric or a customized metric.
scaleInCooldown Number: The 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: The 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.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

aws-native.autoscalingplans.getScalingPlan

On this page

On this page

Using getScalingPlan

getScalingPlan Result

Supporting Types

ScalingPlanApplicationSource

ScalingPlanCustomizedLoadMetricSpecification

ScalingPlanCustomizedScalingMetricSpecification

ScalingPlanMetricDimension

ScalingPlanPredefinedLoadMetricSpecification

ScalingPlanPredefinedScalingMetricSpecification

ScalingPlanScalingInstruction

ScalingPlanTagFilter

ScalingPlanTargetTrackingConfiguration

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

aws-native.autoscalingplans.getScalingPlan

On this page

On this page

Using getScalingPlan

getScalingPlan Result

Supporting Types

ScalingPlanApplicationSource

ScalingPlanCustomizedLoadMetricSpecification

ScalingPlanCustomizedScalingMetricSpecification

ScalingPlanMetricDimension

ScalingPlanPredefinedLoadMetricSpecification

ScalingPlanPredefinedScalingMetricSpecification

ScalingPlanScalingInstruction

ScalingPlanTagFilter

ScalingPlanTargetTrackingConfiguration

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.