This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::ApplicationAutoScaling::ScalableTarget 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](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide*. **Note** 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::ApplicationAutoScaling::ScalableTarget", "Properties" : { "[MaxCapacity](#cfn-applicationautoscaling-scalabletarget-maxcapacity)" : Integer, "[MinCapacity](#cfn-applicationautoscaling-scalabletarget-mincapacity)" : Integer, "[ResourceId](#cfn-applicationautoscaling-scalabletarget-resourceid)" : String, "[RoleARN](#cfn-applicationautoscaling-scalabletarget-rolearn)" : String, "[ScalableDimension](#cfn-applicationautoscaling-scalabletarget-scalabledimension)" : String, "[ScheduledActions](#cfn-applicationautoscaling-scalabletarget-scheduledactions)" : [ ScheduledAction, ... ], "[ServiceNamespace](#cfn-applicationautoscaling-scalabletarget-servicenamespace)" : String, "[SuspendedState](#cfn-applicationautoscaling-scalabletarget-suspendedstate)" : SuspendedState } } ``` ### YAML ``` Type: AWS::ApplicationAutoScaling::ScalableTarget Properties: [MaxCapacity](#cfn-applicationautoscaling-scalabletarget-maxcapacity): Integer [MinCapacity](#cfn-applicationautoscaling-scalabletarget-mincapacity): Integer [ResourceId](#cfn-applicationautoscaling-scalabletarget-resourceid): String [RoleARN](#cfn-applicationautoscaling-scalabletarget-rolearn): String [ScalableDimension](#cfn-applicationautoscaling-scalabletarget-scalabledimension): String [ScheduledActions](#cfn-applicationautoscaling-scalabletarget-scheduledactions): - ScheduledAction [ServiceNamespace](#cfn-applicationautoscaling-scalabletarget-servicenamespace): String [SuspendedState](#cfn-applicationautoscaling-scalabletarget-suspendedstate): SuspendedState ``` ## Properties `MaxCapacity` 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. *Required*: Yes *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MinCapacity` 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. *Required*: Yes *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResourceId` The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. + ECS service - The resource type is `service` and the unique identifier is the cluster name and service name. Example: `service/my-cluster/my-service`. + Spot Fleet - The resource type is `spot-fleet-request` and the unique identifier is the Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`. + EMR cluster - The resource type is `instancegroup` and the unique identifier is the cluster ID and instance group ID. Example: `instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0`. + AppStream 2.0 fleet - The resource type is `fleet` and the unique identifier is the fleet name. Example: `fleet/sample-fleet`. + DynamoDB table - The resource type is `table` and the unique identifier is the table name. Example: `table/my-table`. + DynamoDB global secondary index - The resource type is `index` and the unique identifier is the index name. Example: `table/my-table/index/my-table-index`. + Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:my-db-cluster`. + SageMaker endpoint variant - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`. + Custom resources are not supported with a resource type. This parameter must specify the `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](https://github.com/aws/aws-auto-scaling-custom-resource). + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`. + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`. + Lambda provisioned concurrency - The resource type is `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`. + Amazon Keyspaces table - The resource type is `table` and the unique identifier is the table name. Example: `keyspace/mykeyspace/table/mytable`. + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: `arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`. + Amazon ElastiCache replication group - The resource type is `replication-group` and the unique identifier is the replication group name. Example: `replication-group/mycluster`. + Amazon ElastiCache cache cluster - The resource type is `cache-cluster` and the unique identifier is the cache cluster name. Example: `cache-cluster/mycluster`. + Neptune cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:mycluster`. + SageMaker serverless endpoint - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`. + SageMaker inference component - The resource type is `inference-component` and the unique identifier is the resource ID. Example: `inference-component/my-inference-component`. + Pool of WorkSpaces - The resource type is `workspacespool` and the unique identifier is the pool ID. Example: `workspacespool/wspool-123456`. *Required*: Yes *Type*: String *Pattern*: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*` *Minimum*: `1` *Maximum*: `1600` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `RoleARN` 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](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) 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](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScalableDimension` The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. + `ecs:service:DesiredCount` - The 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 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:cache-cluster:Nodes` - The number of nodes for an Amazon ElastiCache cache 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. + `workspaces:workspacespool:DesiredUserSessions` - The number of user sessions for the WorkSpaces in the pool. *Required*: Yes *Type*: String *Allowed values*: `ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:cache-cluster:Nodes | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ScheduledActions` The scheduled actions for the scalable target. Duplicates aren't allowed. *Required*: No *Type*: Array of [ScheduledAction](aws-properties-applicationautoscaling-scalabletarget-scheduledaction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServiceNamespace` The namespace of the AWS service that provides the resource, or a `custom-resource`. *Required*: Yes *Type*: String *Allowed values*: `ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SuspendedState` 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** + For `DynamicScalingInSuspended`, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. + For `DynamicScalingOutSuspended`, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. + For `ScheduledScalingSuspended`, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. *Required*: No *Type*: [SuspendedState](aws-properties-applicationautoscaling-scalabletarget-suspendedstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the CloudFormation-generated ID of the resource. For example: `service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH|ecs:service:DesiredCount|ecs`. CloudFormation uses the following format to generate the ID: `service/resource_ID|scalable_dimension|service_namespace`. For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). ## Examples Each scalable target has a service namespace, scalable dimension, and resource ID, as well as values for minimum and maximum capacity. For more sample template snippets, see [Configure Application Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-application-auto-scaling.html). This section also provides examples of scheduled actions. ### Register a scalable target The following example creates a scalable target for an [AWS::Cassandra::Table](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html) resource. Application Auto Scaling can scale the write capacity throughput at a minimum of 1 capacity unit and a maximum of 20. To register a different resource supported by Application Auto Scaling, specify its namespace in `ServiceNamespace`, its scalable dimension in `ScalableDimension`, its resource ID in `ResourceId`, and its service-linked role in `RoleARN`. **Note** The `RoleArn` property references a service-linked role that is created for you after you use Application Auto Scaling with the specified resource for the first time. #### JSON ``` { "ScalableTarget":{ "Type":"AWS::ApplicationAutoScaling::ScalableTarget", "Properties":{ "MaxCapacity":20, "MinCapacity":1, "RoleARN":{ "Fn::Sub":"arn:aws:iam::${AWS::AccountId}:role/aws-service-role/cassandra.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_CassandraTable" }, "ServiceNamespace":"cassandra", "ScalableDimension":"cassandra:table:WriteCapacityUnits", "ResourceId":"keyspace/mykeyspace/table/mytable" } } } ``` #### YAML ``` ScalableTarget: Type: AWS::ApplicationAutoScaling::ScalableTarget Properties: MaxCapacity: 20 MinCapacity: 1 RoleARN: Fn::Sub: 'arn:aws:iam::${AWS::AccountId}:role/aws-service-role/cassandra.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_CassandraTable' ServiceNamespace: cassandra ScalableDimension: cassandra:table:WriteCapacityUnits ResourceId: keyspace/mykeyspace/table/mytable ``` ## See also + You can find additional useful snippets in the following section of the *AWS CloudFormation User Guide*: [Configure Application Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-application-auto-scaling.html) + For example implementations, see the following articles on the AWS Blog: + [How to use AWS CloudFormation to configure auto scaling for Amazon DynamoDB tables and indexes](https://aws.amazon.com/blogs/database/how-to-use-aws-cloudformation-to-configure-auto-scaling-for-amazon-dynamodb-tables-and-indexes/) + [Scheduling AWS Lambda Provisioned Concurrency for recurring peak usage](https://aws.amazon.com/blogs/compute/scheduling-aws-lambda-provisioned-concurrency-for-recurring-peak-usage/)