The AWS::ApplicationAutoScaling::ScalableTarget
resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource.
For more information, see Getting started in the Application Auto Scaling User Guide.
If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the DependsOn attribute.
max_capacity
(Number) The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.min_capacity
(Number) The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.resource_id
(String) The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
service
and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service
.spot-fleet-request
and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
.instancegroup
and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.fleet
and the unique identifier is the fleet name. Example: fleet/sample-fleet
.table
and the unique identifier is the table name. Example: table/my-table
.index
and the unique identifier is the index name. Example: table/my-table/index/my-table-index
.cluster
and the unique identifier is the cluster name. Example: cluster:my-db-cluster
.variant
and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering
.OutputValue
from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE
.arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE
.function
and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST
. Example: function:my-function:prod
or function:my-function:1
.table
and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable
.arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
.replication-group
and the unique identifier is the replication group name. Example: replication-group/mycluster
.cluster
and the unique identifier is the cluster name. Example: cluster:mycluster
.variant
and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering
.inference-component
and the unique identifier is the resource ID. Example: inference-component/my-inference-component
.scalable_dimension
(String) The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount
- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity
- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.service_namespace
(String) The namespace of the AWS service that provides the resource, or a custom-resource
.role_arn
(String) Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling works with IAM in the Application Auto Scaling User Guide.
To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the Service-linked roles topic in the Application Auto Scaling User Guide. Look for the ARN in the table at the bottom of the page.scheduled_actions
(Attributes Set) The scheduled actions for the scalable target. Duplicates aren't allowed. (see below for nested schema)suspended_state
(Attributes) An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true
suspends the specified scaling activities. Setting it to false
(default) resumes the specified scaling activities.
Suspension Outcomes
DynamicScalingInSuspended
, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.DynamicScalingOutSuspended
, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.ScheduledScalingSuspended
, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. (see below for nested schema)id
(String) Uniquely identifies the resource.scalable_target_id
(String)scheduled_actions
Required:
schedule
(String) The schedule for this action. The following formats are supported:
at(yyyy-mm-ddThh:mm:ss)
"rate(value unit)
"cron(fields)
"At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is minute
| minutes
| hour
| hours
| day
| days
.
scheduled_action_name
(String) The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.Optional:
end_time
(String) The date and time that the action is scheduled to end, in UTC.scalable_target_action
(Attributes) The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. (see below for nested schema)start_time
(String) The date and time that the action is scheduled to begin, in UTC.timezone
(String) The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.scheduled_actions.scalable_target_action
Optional:
max_capacity
(Number) The maximum capacity.min_capacity
(Number) The minimum capacity.suspended_state
Optional:
dynamic_scaling_in_suspended
(Boolean) Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true
if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false
.dynamic_scaling_out_suspended
(Boolean) Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true
if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false
.scheduled_scaling_suspended
(Boolean) Whether scheduled scaling is suspended. Set the value to true
if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false
.Import is supported using the following syntax:
$ terraform import awscc_applicationautoscaling_scalable_target.example <resource ID>