Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Application Auto Scaling is a general purpose Auto Scaling service for supported elastic AWS resources. With Application Auto Scaling, you can automatically scale your AWS resources, with an experience similar to that of Auto Scaling.
At this time, Application Auto Scaling only supports scaling Amazon ECS services.
For example, you can use Application Auto Scaling to accomplish the following tasks:
- Define scaling policies for automatically adjusting your application’s resources
- Scale your resources in response to CloudWatch alarms
- View history of your scaling events
- applicationAutoScaling :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _FailedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentUpdateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ObjectNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.ApplicationAutoScaling.DeleteScalingPolicy
- module Network.AWS.ApplicationAutoScaling.PutScalingPolicy
- module Network.AWS.ApplicationAutoScaling.RegisterScalableTarget
- module Network.AWS.ApplicationAutoScaling.DescribeScalingPolicies
- module Network.AWS.ApplicationAutoScaling.DescribeScalableTargets
- module Network.AWS.ApplicationAutoScaling.DescribeScalingActivities
- module Network.AWS.ApplicationAutoScaling.DeregisterScalableTarget
- data AdjustmentType
- data MetricAggregationType
- data PolicyType = StepScaling
- data ScalableDimension = EcsServiceDesiredCount
- data ScalingActivityStatusCode
- data ServiceNamespace = Ecs
- data Alarm
- alarm :: Text -> Text -> Alarm
- aAlarmName :: Lens' Alarm Text
- aAlarmARN :: Lens' Alarm Text
- data ScalableTarget
- scalableTarget :: ServiceNamespace -> Text -> ScalableDimension -> Int -> Int -> Text -> UTCTime -> ScalableTarget
- stServiceNamespace :: Lens' ScalableTarget ServiceNamespace
- stResourceId :: Lens' ScalableTarget Text
- stScalableDimension :: Lens' ScalableTarget ScalableDimension
- stMinCapacity :: Lens' ScalableTarget Int
- stMaxCapacity :: Lens' ScalableTarget Int
- stRoleARN :: Lens' ScalableTarget Text
- stCreationTime :: Lens' ScalableTarget UTCTime
- data ScalingActivity
- scalingActivity :: Text -> ServiceNamespace -> Text -> ScalableDimension -> Text -> Text -> UTCTime -> ScalingActivityStatusCode -> ScalingActivity
- saStatusMessage :: Lens' ScalingActivity (Maybe Text)
- saEndTime :: Lens' ScalingActivity (Maybe UTCTime)
- saDetails :: Lens' ScalingActivity (Maybe Text)
- saActivityId :: Lens' ScalingActivity Text
- saServiceNamespace :: Lens' ScalingActivity ServiceNamespace
- saResourceId :: Lens' ScalingActivity Text
- saScalableDimension :: Lens' ScalingActivity ScalableDimension
- saDescription :: Lens' ScalingActivity Text
- saCause :: Lens' ScalingActivity Text
- saStartTime :: Lens' ScalingActivity UTCTime
- saStatusCode :: Lens' ScalingActivity ScalingActivityStatusCode
- data ScalingPolicy
- scalingPolicy :: Text -> Text -> ServiceNamespace -> Text -> ScalableDimension -> PolicyType -> UTCTime -> ScalingPolicy
- spStepScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe StepScalingPolicyConfiguration)
- spAlarms :: Lens' ScalingPolicy [Alarm]
- spPolicyARN :: Lens' ScalingPolicy Text
- spPolicyName :: Lens' ScalingPolicy Text
- spServiceNamespace :: Lens' ScalingPolicy ServiceNamespace
- spResourceId :: Lens' ScalingPolicy Text
- spScalableDimension :: Lens' ScalingPolicy ScalableDimension
- spPolicyType :: Lens' ScalingPolicy PolicyType
- spCreationTime :: Lens' ScalingPolicy UTCTime
- data StepAdjustment
- stepAdjustment :: Int -> StepAdjustment
- saMetricIntervalLowerBound :: Lens' StepAdjustment (Maybe Double)
- saMetricIntervalUpperBound :: Lens' StepAdjustment (Maybe Double)
- saScalingAdjustment :: Lens' StepAdjustment Int
- data StepScalingPolicyConfiguration
- stepScalingPolicyConfiguration :: StepScalingPolicyConfiguration
- sspcStepAdjustments :: Lens' StepScalingPolicyConfiguration [StepAdjustment]
- sspcAdjustmentType :: Lens' StepScalingPolicyConfiguration (Maybe AdjustmentType)
- sspcCooldown :: Lens' StepScalingPolicyConfiguration (Maybe Int)
- sspcMetricAggregationType :: Lens' StepScalingPolicyConfiguration (Maybe MetricAggregationType)
- sspcMinAdjustmentMagnitude :: Lens' StepScalingPolicyConfiguration (Maybe Int)
Service Configuration
applicationAutoScaling :: Service Source #
API version '2016-02-06' of the Amazon Application Auto Scaling SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ApplicationAutoScaling
.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception was thrown for a validation issue. Review the available parameters for the API request.
FailedResourceAccessException
_FailedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Failed access to resources caused an exception. This exception currently only applies to DescribeScalingPolicies. It is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have the proper permissions to call the CloudWatch DescribeAlarms API operation on behalf of your account.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The next token supplied was invalid.
ConcurrentUpdateException
_ConcurrentUpdateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
InternalServiceException
_InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service encountered an internal error.
ObjectNotFoundException
_ObjectNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified object could not be found. For any Put
or Register
API
operation, which depends on the existence of a scalable target, this
exception is thrown if the scalable target with the specified service
namespace, resource ID, and scalable dimension does not exist. For any
Delete
or Deregister
API operation, this exception is thrown if the
resource that is to be deleted or deregistered cannot be found.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded. Application Auto Scaling has a limit of 40 scalable targets per account for Amazon ECS services, 50 scaling policies per scalable target, and 20 step adjustments per step scaling policy.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeleteScalingPolicy
PutScalingPolicy
RegisterScalableTarget
DescribeScalingPolicies
DescribeScalableTargets
DescribeScalingActivities
DeregisterScalableTarget
Types
AdjustmentType
data AdjustmentType Source #
MetricAggregationType
data MetricAggregationType Source #
PolicyType
data PolicyType Source #
ScalableDimension
data ScalableDimension Source #
ScalingActivityStatusCode
data ScalingActivityStatusCode Source #
ServiceNamespace
data ServiceNamespace Source #
Alarm
An object representing a CloudWatch alarm associated with a scaling policy.
See: alarm
smart constructor.
Creates a value of Alarm
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ScalableTarget
data ScalableTarget Source #
An object representing a scalable target.
See: scalableTarget
smart constructor.
:: ServiceNamespace | |
-> Text | |
-> ScalableDimension | |
-> Int | |
-> Int | |
-> Text | |
-> UTCTime | |
-> ScalableTarget |
Creates a value of ScalableTarget
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stServiceNamespace :: Lens' ScalableTarget ServiceNamespace Source #
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.
stResourceId :: Lens' ScalableTarget Text Source #
The unique identifier string for the resource associated with the scalable target. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as 'service\/default\/sample-webapp'.
stScalableDimension :: Lens' ScalableTarget ScalableDimension Source #
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.
stMinCapacity :: Lens' ScalableTarget Int Source #
The minimum value for this scalable target to scale in to in response to scaling activities.
stMaxCapacity :: Lens' ScalableTarget Int Source #
The maximum value for this scalable target to scale out to in response to scaling activities.
stRoleARN :: Lens' ScalableTarget Text Source #
The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.
stCreationTime :: Lens' ScalableTarget UTCTime Source #
The Unix timestamp for when the scalable target was created.
ScalingActivity
data ScalingActivity Source #
An object representing a scaling activity.
See: scalingActivity
smart constructor.
:: Text | |
-> ServiceNamespace | |
-> Text | |
-> ScalableDimension | |
-> Text | |
-> Text | |
-> UTCTime | |
-> ScalingActivityStatusCode | |
-> ScalingActivity |
Creates a value of ScalingActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saStatusMessage :: Lens' ScalingActivity (Maybe Text) Source #
A simple message about the current status of the scaling activity.
saEndTime :: Lens' ScalingActivity (Maybe UTCTime) Source #
The Unix timestamp for when the scaling activity ended.
saActivityId :: Lens' ScalingActivity Text Source #
The unique identifier string for the scaling activity.
saServiceNamespace :: Lens' ScalingActivity ServiceNamespace Source #
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.
saResourceId :: Lens' ScalingActivity Text Source #
The unique identifier string for the resource associated with the scaling activity. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as 'service\/default\/sample-webapp'.
saScalableDimension :: Lens' ScalingActivity ScalableDimension Source #
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.
saDescription :: Lens' ScalingActivity Text Source #
A simple description of what action the scaling activity intends to accomplish.
saCause :: Lens' ScalingActivity Text Source #
A simple description of what caused the scaling activity to happen.
saStartTime :: Lens' ScalingActivity UTCTime Source #
The Unix timestamp for when the scaling activity began.
saStatusCode :: Lens' ScalingActivity ScalingActivityStatusCode Source #
Indicates the status of the scaling activity.
ScalingPolicy
data ScalingPolicy Source #
An object representing a scaling policy.
See: scalingPolicy
smart constructor.
:: Text | |
-> Text | |
-> ServiceNamespace | |
-> Text | |
-> ScalableDimension | |
-> PolicyType | |
-> UTCTime | |
-> ScalingPolicy |
Creates a value of ScalingPolicy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spStepScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe StepScalingPolicyConfiguration) Source #
The configuration for the step scaling policy.
spAlarms :: Lens' ScalingPolicy [Alarm] Source #
The CloudWatch alarms that are associated with the scaling policy.
spPolicyARN :: Lens' ScalingPolicy Text Source #
The Amazon Resource Name (ARN) of the scaling policy.
spPolicyName :: Lens' ScalingPolicy Text Source #
The name of the scaling policy.
spServiceNamespace :: Lens' ScalingPolicy ServiceNamespace Source #
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.
spResourceId :: Lens' ScalingPolicy Text Source #
The unique identifier string for the resource associated with the scaling policy. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as 'service\/default\/sample-webapp'.
spScalableDimension :: Lens' ScalingPolicy ScalableDimension Source #
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.
spPolicyType :: Lens' ScalingPolicy PolicyType Source #
The scaling policy type.
spCreationTime :: Lens' ScalingPolicy UTCTime Source #
The Unix timestamp for when the scaling policy was created.
StepAdjustment
data StepAdjustment Source #
An object representing a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
- If you want the adjustment to be triggered when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
- If you want the adjustment to be triggered when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy:
- The ranges of your step adjustments can't overlap or have a gap.
- At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
- At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
- The upper and lower bound can't be null in the same step adjustment.
See: stepAdjustment
smart constructor.
Creates a value of StepAdjustment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saMetricIntervalLowerBound :: Lens' StepAdjustment (Maybe Double) Source #
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.
saMetricIntervalUpperBound :: Lens' StepAdjustment (Maybe Double) Source #
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.
saScalingAdjustment :: Lens' StepAdjustment Int Source #
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.
StepScalingPolicyConfiguration
data StepScalingPolicyConfiguration Source #
An object representing a step scaling policy configuration.
See: stepScalingPolicyConfiguration
smart constructor.
stepScalingPolicyConfiguration :: StepScalingPolicyConfiguration Source #
Creates a value of StepScalingPolicyConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sspcStepAdjustments :: Lens' StepScalingPolicyConfiguration [StepAdjustment] Source #
A set of adjustments that enable you to scale based on the size of the alarm breach.
sspcAdjustmentType :: Lens' StepScalingPolicyConfiguration (Maybe AdjustmentType) Source #
The adjustment type, which specifies how the ScalingAdjustment
parameter in a StepAdjustment is interpreted.
sspcCooldown :: Lens' StepScalingPolicyConfiguration (Maybe Int) Source #
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.
sspcMetricAggregationType :: Lens' StepScalingPolicyConfiguration (Maybe MetricAggregationType) Source #
sspcMinAdjustmentMagnitude :: Lens' StepScalingPolicyConfiguration (Maybe Int) Source #
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.