String scalingPlanName
The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
ApplicationSource applicationSource
A CloudFormation stack or set of tags. You can create one scaling plan per application source.
List<E> scalingInstructions
The scaling instructions.
Long scalingPlanVersion
The version of the scaling plan. This value is always 1.
String scalingPlanName
The name of the scaling plan.
Long scalingPlanVersion
The version of the scaling plan.
Integer maxResults
The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.
String nextToken
The token for the next set of results.
List<E> scalingPlanNames
The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.
Long scalingPlanVersion
The version of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.
List<E> applicationSources
The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.
Integer maxResults
The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.
String nextToken
The token for the next set of results.
String predefinedScalingMetricType
The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Sport
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 for an Application Load Balancer
attached to the Auto Scaling group, 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 serviceNamespace
The namespace of the AWS service.
String resourceId
The ID of the resource. This string consists of the resource type and unique identifier.
Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of
the Auto Scaling group. Example: autoScalingGroup/my-asg.
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.
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.
String scalableDimension
The scalable dimension associated with the resource.
autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.
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.
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.
List<E> targetTrackingConfigurations
The target tracking scaling policies (up to 10).
String scalingPlanName
The name of the scaling plan.
Long scalingPlanVersion
The version of the scaling plan.
ApplicationSource applicationSource
The application source.
List<E> scalingInstructions
The scaling instructions.
String statusCode
The status of the scaling plan.
Active - The scaling plan is active.
ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more
resources could not be applied.
CreationInProgress - The scaling plan is being created.
CreationFailed - The scaling plan could not be created.
DeletionInProgress - The scaling plan is being deleted.
DeletionFailed - The scaling plan could not be deleted.
String statusMessage
A simple message about the current status of the scaling plan.
Date statusStartTime
The Unix timestamp when the scaling plan entered the current status.
Date creationTime
The Unix timestamp when the scaling plan was created.
String scalingPlanName
The name of the scaling plan.
Long scalingPlanVersion
The version of the scaling plan.
String serviceNamespace
The namespace of the AWS service.
String resourceId
The ID of the resource. This string consists of the resource type and unique identifier.
Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of
the Auto Scaling group. Example: autoScalingGroup/my-asg.
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.
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.
String scalableDimension
The scalable dimension for the resource.
autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.
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.
List<E> scalingPolicies
The scaling policies.
String scalingStatusCode
The scaling status of the resource.
Active - The scaling configuration is active.
Inactive - The scaling configuration is not active because the scaling plan is being created or the
scaling configuration could not be applied. Check the status message for more information.
PartiallyActive - The scaling configuration is partially active because the scaling plan is being
created or deleted or the scaling configuration could not be fully applied. Check the status message for more
information.
String scalingStatusMessage
A simple message about the current scaling status of the resource.
String policyName
The name of the scaling policy.
String policyType
The type of scaling policy.
TargetTrackingConfiguration targetTrackingConfiguration
The target tracking scaling policy.
PredefinedScalingMetricSpecification predefinedScalingMetricSpecification
A predefined metric.
CustomizedScalingMetricSpecification customizedScalingMetricSpecification
A customized metric.
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).
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.
Integer scaleOutCooldown
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
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. This value is not used if the scalable resource is an Auto Scaling group.
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, AWS Auto Scaling scales out your scalable target immediately.
Integer estimatedInstanceWarmup
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
ApplicationSource applicationSource
A CloudFormation stack or set of tags.
String scalingPlanName
The name of the scaling plan.
List<E> scalingInstructions
The scaling instructions.
Long scalingPlanVersion
The version number.
Copyright © 2018. All rights reserved.