Registry /
aws / aws-cdk-aws-applicationautoscaling
Install & Compatibility
Where this runs
tested against v1.204.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.920 runs
installs and imports cleanly · install 0.0s · import 0.000s · 32.6MB
glibcpy 3.10–3.920 runs
installs and imports cleanly · install 4.0s · import 0.000s · 33MB
32MB installed
● package 32MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
ScalableTarget
✓ from aws_cdk import aws_applicationautoscaling as appautoscaling
✗ from aws_cdk.aws_applicationautoscaling import ScalableTarget
While direct import works, aliasing to `appautoscaling` is a common and recommended pattern in CDK examples.
This example demonstrates how to define a `ScalableTarget` for an ECS service's desired count and apply a CPU utilization scaling policy. Remember to replace the placeholder `resource_id` with your actual service details and ensure your environment variables `CDK_DEFAULT_ACCOUNT` and `CDK_DEFAULT_REGION` are set.
import os
from aws_cdk import App, Stack, Duration
from aws_cdk import aws_applicationautoscaling as appautoscaling
class ApplicationAutoScalingStack(Stack):
def __init__(self, scope: App, id: str, **kwargs) -> None:
super().__init__(scope, id, **kwargs)
# Define a scalable target for an ECS service's desired count.
# In a real application, 'resource_id' would refer to an existing
# ECS service ARN or logical ID. Adjust 'resource_id' to your target service.
scalable_target = appautoscaling.ScalableTarget(
self, "MyEcsScalableTarget",
service_namespace=appautoscaling.ServiceNamespace.ECS,
min_capacity=1,
max_capacity=10,
# IMPORTANT: Replace with your actual ECS Cluster/Service name
resource_id="service/YourEcsClusterName/YourEcsServiceName",
scalable_dimension="ecs:service:DesiredCount"
)
# Scale out based on CPU utilization
scalable_target.scale_on_cpu_utilization(
"CpuScalingPolicy",
target_utilization_percent=70,
scale_in_cooldown=Duration.seconds(60),
scale_out_cooldown=Duration.seconds(60)
)
app = App()
ApplicationAutoScalingStack(app, "ApplicationAutoScalingStack",
env={
'account': os.environ.get('CDK_DEFAULT_ACCOUNT', '123456789012'),
'region': os.environ.get('CDK_DEFAULT_REGION', 'us-east-1')
}
)
app.synth()
Debug
Known issues
breakingThis library is for AWS CDK v1. AWS CDK v2 consolidated all construct libraries into a single `aws-cdk` package. Migrating from v1 to v2 requires updating imports and potentially some API changes.fixFor new projects, consider using AWS CDK v2 (install `aws-cdk` instead of individual modules). For existing v1 projects, ensure `pip install aws-cdk.aws-applicationautoscaling` is used.
affects: All versions up to 1.x.x (v1)
gotchaThe `resource_id` and `scalable_dimension` parameters for `ScalableTarget` are highly specific to the AWS service you are scaling. Incorrect formats will lead to CloudFormation deployment failures.fixConsult the AWS documentation for Application Auto Scaling to find the exact `resource_id` and `scalable_dimension` formats for your target service (e.g., ECS, DynamoDB, RDS Aurora, AppStream 2.0).
affects: All versions
gotchaApplication Auto Scaling requires specific IAM permissions to describe the target resource and its metrics, as well as to update its capacity. Deployment might fail with permission errors if the CDK's execution role or the auto-scaling service-linked role lacks these permissions.fixEnsure the IAM role used by CloudFormation and the implicitly created service-linked role for Application Auto Scaling have adequate permissions (e.g., `ecs:UpdateService`, `dynamodb:UpdateTable`, `cloudwatch:GetMetricData`).
affects: All versions
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'aws_cdk.aws_applicationautoscaling'
The `aws-cdk.aws-applicationautoscaling` package is not installed or the import path is incorrect for CDK v1.
fixRun `pip install aws-cdk.aws-applicationautoscaling`. Ensure your import statement is `from aws_cdk import aws_applicationautoscaling as appautoscaling`.
AWS CloudFormation Error: Parameter 'ResourceId' must be in the format 'service/<service_name>' for ECS (or similar for other services like 'table/<table_name>' for DynamoDB).
The `resource_id` provided to `appautoscaling.ScalableTarget` does not conform to the expected format for the specified `service_namespace`.
fixVerify the `resource_id` format based on the `service_namespace`. For ECS, it's typically `service/<cluster-name>/<service-name>`. For DynamoDB, `table/<table-name>` or `table/<table-name>/index/<index-name>`.
AttributeError: 'ScalableTarget' object has no attribute 'scale_on_cpu_utilization' (or 'scale_on_metric', etc.)
This error can occur if you are mixing CDK v1 constructs with v2 API patterns, or vice-versa, or if you're trying to call a method that doesn't exist on the `ScalableTarget` object.
fixEnsure your CDK version (v1) matches the documentation you are following. For v1, methods like `scale_on_cpu_utilization`, `scale_on_request_count`, and `scale_on_metric` are valid directly on the `ScalableTarget` object.
Upgrade
Version history
1.204.0latest on PyPI · released Jun 19, 2023
Audit
Dependencies
aws-cdk.corerequiredCore CDK constructs and app definition for v1.