String policyName
The name of the scaling policy to delete.
String serviceNamespace
The namespace for the AWS service that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
String resourceId
The resource type and unique identifier string for the resource associated with the scaling policy. For Amazon
ECS services, the resource type is services, and the identifier is the cluster name and service
name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource
type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
String scalableDimension
The scalable dimension associated with the scaling policy. The scalable dimension contains the service namespace,
resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of
an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon
EC2 Spot fleet request.
String serviceNamespace
The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
String resourceId
The resource type and unique identifier string for the resource associated with the scalable target. For Amazon
ECS services, the resource type is services, and the identifier is the cluster name and service
name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource
type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
String scalableDimension
The scalable dimension associated with the scalable target. The scalable dimension contains the service
namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired
task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target
capacity of an Amazon EC2 Spot fleet request.
String serviceNamespace
The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
List<E> resourceIds
The resource type and unique identifier string for the resource associated with the scalable target. For Amazon
ECS services, the resource type is services, and the identifier is the cluster name and service
name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource
type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. If you specify a scalable dimension,
you must also specify a resource ID.
String scalableDimension
The scalable dimension associated with the scalable target. The scalable dimension contains the service
namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired
task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target
capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a
resource ID.
Integer maxResults
The maximum number of scalable target results returned by DescribeScalableTargets in paginated
output. When this parameter is used, DescribeScalableTargets returns up to MaxResults
results in a single page along with a NextToken response element. The remaining results of the
initial request can be seen by sending another DescribeScalableTargets request with the returned
NextToken value. This value can be between 1 and 50. If this parameter is not used, then
DescribeScalableTargets returns up to 50 results and a NextToken value, if applicable.
String nextToken
The NextToken value returned from a previous paginated DescribeScalableTargets request.
Pagination continues from the end of the previous results that returned the NextToken value. This
value is null when there are no more results to return.
List<E> scalableTargets
The list of scalable targets that matches the request parameters.
String nextToken
The NextToken value to include in a future DescribeScalableTargets request. When the
results of a DescribeScalableTargets request exceed MaxResults, this value can be used
to retrieve the next page of results. This value is null when there are no more results to return.
String serviceNamespace
The namespace for the AWS service that the scaling activity is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
String resourceId
The resource type and unique identifier string for the resource associated with the scaling activity. For Amazon
ECS services, the resource type is services, and the identifier is the cluster name and service
name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource
type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. If you specify a scalable dimension,
you must also specify a resource ID.
String scalableDimension
The scalable dimension associated with the scaling activity. The scalable dimension contains the service
namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired
task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target
capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a
resource ID.
Integer maxResults
The maximum number of scaling activity results returned by DescribeScalingActivities in paginated
output. When this parameter is used, DescribeScalingActivities returns up to MaxResults
results in a single page along with a NextToken response element. The remaining results of the
initial request can be seen by sending another DescribeScalingActivities request with the returned
NextToken value. This value can be between 1 and 50. If this parameter is not used, then
DescribeScalingActivities returns up to 50 results and a NextToken value, if
applicable.
String nextToken
The NextToken value returned from a previous paginated DescribeScalingActivities
request. Pagination continues from the end of the previous results that returned the NextToken
value. This value is null when there are no more results to return.
List<E> scalingActivities
A list of scaling activity objects.
String nextToken
The NextToken value to include in a future DescribeScalingActivities request. When the
results of a DescribeScalingActivities request exceed MaxResults, this value can be
used to retrieve the next page of results. This value is null when there are no more results to
return.
List<E> policyNames
The names of the scaling policies to describe.
String serviceNamespace
The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
String resourceId
The unique resource identifier string of the scalable target that the scaling policy is associated with. For
Amazon ECS services, the resource type is services, and the identifier is the cluster name and
service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the
resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. If you specify a scalable dimension,
you must also specify a resource ID.
String scalableDimension
The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension
contains the service namespace, resource type, and scaling property, such as
ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or
ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.
If you specify a scalable dimension, you must also specify a resource ID.
Integer maxResults
The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated
output. When this parameter is used, DescribeScalingPolicies returns up to MaxResults
results in a single page along with a NextToken response element. The remaining results of the
initial request can be seen by sending another DescribeScalingPolicies request with the returned
NextToken value. This value can be between 1 and 50. If this parameter is not used, then
DescribeScalingPolicies returns up to 50 results and a NextToken value, if applicable.
String nextToken
The NextToken value returned from a previous paginated DescribeScalingPolicies request.
Pagination continues from the end of the previous results that returned the NextToken value. This
value is null when there are no more results to return.
List<E> scalingPolicies
A list of scaling policy objects.
String nextToken
The NextToken value to include in a future DescribeScalingPolicies request. When the
results of a DescribeScalingPolicies request exceed MaxResults, this value can be used
to retrieve the next page of results. This value is null when there are no more results to return.
String policyName
The name of the scaling policy.
String serviceNamespace
The AWS service namespace of the scalable target that this scaling policy applies to. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
String resourceId
The unique resource identifier string for the scalable target that this scaling policy applies to. For Amazon ECS
services, the resource type is services, and the identifier is the cluster name and service name;
for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is
spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
String scalableDimension
The scalable dimension of the scalable target that this scaling policy applies to. The scalable dimension
contains the service namespace, resource type, and scaling property, such as
ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or
ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.
String policyType
The policy type. If you are creating a new policy, this parameter is required. If you are updating an existing policy, this parameter is not required.
StepScalingPolicyConfiguration stepScalingPolicyConfiguration
The configuration for the step scaling policy. If you are creating a new policy, this parameter is required. If you are updating an existing policy, this parameter is not required. For more information, see StepScalingPolicyConfiguration and StepAdjustment.
String policyARN
The Amazon Resource Name (ARN) of the resulting scaling policy.
String serviceNamespace
The namespace for the AWS service that the scalable target is associated with. For Amazon ECS services, the
namespace value is ecs. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
String resourceId
The resource type and unique identifier string for the resource to associate with the scalable target. For Amazon
ECS services, the resource type is services, and the identifier is the cluster name and service
name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource
type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
String scalableDimension
The scalable dimension associated with the scalable target. The scalable dimension contains the service
namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired
task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target
capacity of an Amazon EC2 Spot fleet request.
Integer minCapacity
The minimum value for this scalable target to scale in to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.
Integer maxCapacity
The maximum value for this scalable target to scale out to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.
String roleARN
The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.
String serviceNamespace
The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
String resourceId
The resource type and unique identifier string for the resource associated with the scalable target. For Amazon
ECS services, the resource type is services, and the identifier is the cluster name and service
name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource
type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
String scalableDimension
The scalable dimension associated with the scalable target. The scalable dimension contains the service
namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired
task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target
capacity of an Amazon EC2 Spot fleet request.
Integer minCapacity
The minimum value for this scalable target to scale in to in response to scaling activities.
Integer maxCapacity
The maximum value for this scalable target to scale out to in response to scaling activities.
String roleARN
The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.
Date creationTime
The Unix timestamp for when the scalable target was created.
String activityId
The unique identifier string for the scaling activity.
String serviceNamespace
The namespace for the AWS service that the scaling activity is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
String resourceId
The resource type and unique identifier string for the resource associated with the scaling activity. For Amazon
ECS services, the resource type is services, and the identifier is the cluster name and service
name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource
type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
String scalableDimension
The scalable dimension associated with the scaling activity. The scalable dimension contains the service
namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired
task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target
capacity of an Amazon EC2 Spot fleet request.
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 for the AWS service that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
String resourceId
The resource type and unique identifier string for the resource associated with the scaling policy. For Amazon
ECS services, the resource type is services, and the identifier is the cluster name and service
name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource
type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example,
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
String scalableDimension
The scalable dimension associated with the scaling policy. The scalable dimension contains the service namespace,
resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of
an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon
EC2 Spot fleet request.
String policyType
The scaling policy type.
StepScalingPolicyConfiguration stepScalingPolicyConfiguration
The configuration for the step scaling policy.
List<E> alarms
The CloudWatch alarms that are associated with the scaling policy.
Date creationTime
The Unix timestamp for when the scaling policy 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 Cooldown 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.
Copyright © 2016. All rights reserved.