String policyName
The name of the scaling policy.
String serviceNamespace
The namespace of the AWS 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
String serviceNamespace
The namespace of the AWS 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
String serviceNamespace
The namespace of the AWS 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
String serviceNamespace
The namespace of the AWS 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
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. 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
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. 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
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. 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
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. 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
String policyType
The policy type. This parameter is required if you are creating a policy.
For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS,
both StepScaling and TargetTrackingScaling are supported. For any other service, only
StepScaling is supported.
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 policy.
This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling
.
String serviceNamespace
The namespace of the AWS 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.
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 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.
String scalableDimension
The scalable dimension. This parameter is required if you are creating a scheduled action. 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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
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. 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
Integer minCapacity
The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target.
Integer maxCapacity
The maximum value to scale to in response to a scale out event. This parameter is required if you are registering 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 resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
String serviceNamespace
The namespace of the AWS 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
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.
String activityId
The unique identifier of the scaling activity.
String serviceNamespace
The namespace of the AWS 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
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. 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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
String policyType
The scaling policy type.
StepScalingPolicyConfiguration stepScalingPolicyConfiguration
A step scaling policy.
TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration
A target tracking 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. 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.
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 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.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model
endpoint variant.
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
The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment
is interpreted.
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.
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.
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.
CustomizedMetricSpecification customizedMetricSpecification
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 policy is disabled. If the value is true, scale in
is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in
is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is
false.
Copyright © 2018. All rights reserved.