ScalingPolicy
Represents a scaling policy to use with Application Auto Scaling.
Contents
- Alarms
-
The CloudWatch alarms associated with the scaling policy.
Type: Array of Alarm objects
Required: No
- CreationTime
-
The Unix timestamp for when the scaling policy was created.
Type: Timestamp
Required: Yes
- PolicyARN
-
The Amazon Resource Name (ARN) of the scaling policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- PolicyName
-
The name of the scaling policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
\p{Print}+
Required: Yes
- PolicyType
-
The scaling policy type.
Type: String
Valid Values:
StepScaling | TargetTrackingScaling
Required: Yes
- ResourceId
-
The identifier of the resource associated with the scaling policy. 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 resource ID. Example:table/my-table
. -
DynamoDB global secondary index - The resource type is
index
and the unique identifier is the resource ID. 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 variants - 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
-
- ScalableDimension
-
The scalable dimension. 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.
Type: String
Valid 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
Required: Yes
-
- ServiceNamespace
-
The namespace of the AWS service that provides the resource or
custom-resource
for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.Type: String
Valid Values:
ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource
Required: Yes
- StepScalingPolicyConfiguration
-
A step scaling policy.
Type: StepScalingPolicyConfiguration object
Required: No
- TargetTrackingScalingPolicyConfiguration
-
A target tracking scaling policy.
Type: TargetTrackingScalingPolicyConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: