String metricName
The name of the metric.
String namespace
The namespace of the metric.
List<E> dimensions
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
String statistic
The statistic of the metric.
String unit
The unit of the metric.
String policyName
The name of the scaling policy.
String 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.
String 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/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.
String 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.
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.
String 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.
String scheduledActionName
The name of the scheduled action.
String resourceId
The identifier of the resource associated with the scheduled action. 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.
String 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.
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.
String 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.
String 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/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.
String 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 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.
String 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.
List<E> resourceIds
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
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.
String scalableDimension
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
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.
Integer maxResults
The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
If this parameter is used, the operation returns up to MaxResults results at a time, along with a
NextToken value. To get the next set of results, include the NextToken value in a
subsequent call. If this parameter is not used, the operation returns up to 50 results and a
NextToken value, if applicable.
String nextToken
The token for the next set of results.
String 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.
String resourceId
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
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.
String scalableDimension
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
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.
Integer maxResults
The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
If this parameter is used, the operation returns up to MaxResults results at a time, along with a
NextToken value. To get the next set of results, include the NextToken value in a
subsequent call. If this parameter is not used, the operation returns up to 50 results and a
NextToken value, if applicable.
String nextToken
The token for the next set of results.
List<E> policyNames
The names of the scaling policies to describe.
String 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.
String resourceId
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
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.
String scalableDimension
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
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.
Integer maxResults
The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
If this parameter is used, the operation returns up to MaxResults results at a time, along with a
NextToken value. To get the next set of results, include the NextToken value in a
subsequent call. If this parameter is not used, the operation returns up to 50 results and a
NextToken value, if applicable.
String nextToken
The token for the next set of results.
List<E> scheduledActionNames
The names of the scheduled actions to describe.
String 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.
String resourceId
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
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.
String scalableDimension
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
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.
Integer maxResults
The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50.
If this parameter is used, the operation returns up to MaxResults results at a time, along with a
NextToken value. To get the next set of results, include the NextToken value in a
subsequent call. If this parameter is not used, the operation returns up to 50 results and a
NextToken value, if applicable.
String nextToken
The token for the next set of results.
String predefinedMetricType
The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleet requests and
ECS services.
String resourceLabel
Identifies the resource associated with the metric type. You can't specify a resource label unless the metric
type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet request or
ECS service.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target -group-id>, where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
String policyName
The name of the scaling policy.
String 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.
String 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 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.
String 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.
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.
String policyType
The policy type. This parameter is required if you are creating a scaling policy.
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR
StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS Lambda
For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.
StepScalingPolicyConfiguration stepScalingPolicyConfiguration
A step scaling policy.
This parameter is required if you are creating a policy and the policy type is StepScaling.
TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration
A target tracking scaling policy. Includes support for predefined or customized metrics.
This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling
.
String 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.
String schedule
The schedule for this action. The following formats are supported:
At expressions - "at(yyyy-mm-ddThh:mm:ss)"
Rate expressions - "rate(value unit)"
Cron expressions - "cron(fields)"
At expressions are useful for one-time schedules. Specify the time, in UTC.
For rate expressions, value is a positive integer and unit is minute |
minutes | hour | hours | day | days.
For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.
String scheduledActionName
The name of the scheduled action.
String resourceId
The identifier of the resource associated with the scheduled action. 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.
String 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.
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.
Date startTime
The date and time for the scheduled action to start.
Date endTime
The date and time for the scheduled action to end.
ScalableTargetAction scalableTargetAction
The new minimum and maximum capacity. You can set both values or just one. During 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.
String 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.
String resourceId
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.
String 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 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.
Integer minCapacity
The minimum value to scale to in response to a scale-in event. MinCapacity is required to register a
scalable target.
Integer maxCapacity
The maximum value to scale to in response to a scale-out event. MaxCapacity is required to register
a scalable target.
String roleARN
Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling.
For Amazon EMR, this parameter is required, and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
SuspendedState 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.
For more information, see Suspending and Resuming Scaling in the Application Auto Scaling User Guide.
String 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.
String 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/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.
String 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 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.
Integer minCapacity
The minimum value to scale to in response to a scale-in event.
Integer maxCapacity
The maximum value to scale to in response to a scale-out event.
String roleARN
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
Date creationTime
The Unix timestamp for when the scalable target was created.
SuspendedState suspendedState
String activityId
The unique identifier of the scaling activity.
String 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.
String resourceId
The identifier of the resource associated with the scaling activity. 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.
String 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.
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.
String description
A simple description of what action the scaling activity intends to accomplish.
String cause
A simple description of what caused the scaling activity to happen.
Date startTime
The Unix timestamp for when the scaling activity began.
Date endTime
The Unix timestamp for when the scaling activity ended.
String statusCode
Indicates the status of the scaling activity.
String statusMessage
A simple message about the current status of the scaling activity.
String details
The details about the scaling activity.
String policyARN
The Amazon Resource Name (ARN) of the scaling policy.
String policyName
The name of the scaling policy.
String 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.
String 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 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.
String 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.
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.
String policyType
The scaling policy type.
StepScalingPolicyConfiguration stepScalingPolicyConfiguration
A step scaling policy.
TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration
A target tracking scaling policy.
List<E> alarms
The CloudWatch alarms associated with the scaling policy.
Date creationTime
The Unix timestamp for when the scaling policy was created.
String scheduledActionName
The name of the scheduled action.
String scheduledActionARN
The Amazon Resource Name (ARN) of the scheduled action.
String 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.
String schedule
The schedule for this action. The following formats are supported:
At expressions - "at(yyyy-mm-ddThh:mm:ss)"
Rate expressions - "rate(value unit)"
Cron expressions - "cron(fields)"
At expressions are useful for one-time schedules. Specify the time, in UTC.
For rate expressions, value is a positive integer and unit is minute |
minutes | hour | hours | day | days.
For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.
String 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 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.
String 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.
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.
Date startTime
The date and time that the action is scheduled to begin.
Date endTime
The date and time that the action is scheduled to end.
ScalableTargetAction scalableTargetAction
The new minimum and maximum capacity. You can set both values or just one. During 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.
Date creationTime
The date and time that the scheduled action was created.
Double metricIntervalLowerBound
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
Double metricIntervalUpperBound
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.
String adjustmentType
Specifies whether the ScalingAdjustment value in a StepAdjustment is an absolute number or a
percentage of the current capacity.
List<E> stepAdjustments
A set of adjustments that enable you to scale based on the size of the alarm breach.
Integer minAdjustmentMagnitude
The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is
PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by
this amount.
For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and
you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is
performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2,
Application Auto Scaling scales out the service by 2 tasks.
Integer cooldown
The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count.
For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
String metricAggregationType
The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and
Average. If the aggregation type is null, the value is treated as Average.
Boolean dynamicScalingInSuspended
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.
Boolean dynamicScalingOutSuspended
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.
Boolean scheduledScalingSuspended
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.
Double targetValue
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
PredefinedMetricSpecification predefinedMetricSpecification
A predefined metric. You can specify either a predefined metric or a customized metric.
CustomizedMetricSpecification customizedMetricSpecification
A customized metric. You can specify either a predefined metric or a customized metric.
Integer scaleOutCooldown
The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.
Integer scaleInCooldown
The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.
The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
Boolean disableScaleIn
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true,
scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource.
Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable
resource. The default value is false.
Copyright © 2020. All rights reserved.