Registers or updates a scalable target.
applicationautoscaling_register_scalable_target(ServiceNamespace,
ResourceId, ScalableDimension, MinCapacity, MaxCapacity, RoleARN,
SuspendedState)[required] The namespace of the AWS service that provides the resource. For a
resource provided by your own application or service, use
custom-resource instead.
[required] The identifier of the resource that is 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/default/sample-webapp.
Spot Fleet request - 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.
Amazon 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.
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.
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.
[required] 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.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a
Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count
of an EMR Instance Group.
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 an Amazon 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.
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.
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.
This parameter is required if you are registering a scalable target. For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
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.
This parameter is required if you are registering a scalable target.
This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see Application Auto Scaling IAM Roles.
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.
For more information, see Suspending and Resuming Scaling in the Application Auto Scaling User Guide.
svc$register_scalable_target(
ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|"appstream"|"dynamodb"|"rds"|"sagemaker"|"custom-resource"|"comprehend"|"lambda"|"cassandra",
ResourceId = "string",
ScalableDimension = "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"|"lambda:function:ProvisionedConcurrency"|"cassandra:table:ReadCapacityUnits"|"cassandra:table:WriteCapacityUnits",
MinCapacity = 123,
MaxCapacity = 123,
RoleARN = "string",
SuspendedState = list(
DynamicScalingInSuspended = TRUE|FALSE,
DynamicScalingOutSuspended = TRUE|FALSE,
ScheduledScalingSuspended = TRUE|FALSE
)
)
A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.
When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling scaling policies will not scale capacity to values that are outside of this range.
After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.
To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don\'t specify are not changed by this update request.
# NOT RUN {
# This example registers a scalable target from an Amazon ECS service
# called web-app that is running on the default cluster, with a minimum
# desired count of 1 task and a maximum desired count of 10 tasks.
svc$register_scalable_target(
MaxCapacity = 10L,
MinCapacity = 1L,
ResourceId = "service/default/web-app",
ScalableDimension = "ecs:service:DesiredCount",
ServiceNamespace = "ecs"
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab