Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- AdjustmentType
- MetricAggregationType
- MetricStatistic
- MetricType
- PolicyType
- ScalableDimension
- ScalingActivityStatusCode
- ServiceNamespace
- Alarm
- CustomizedMetricSpecification
- MetricDimension
- PredefinedMetricSpecification
- ScalableTarget
- ScalableTargetAction
- ScalingActivity
- ScalingPolicy
- ScheduledAction
- StepAdjustment
- StepScalingPolicyConfiguration
- TargetTrackingScalingPolicyConfiguration
With Application Auto Scaling, you can configure automatic scaling for your scalable AWS resources. You can use Application Auto Scaling to accomplish the following tasks:
- Define scaling policies to automatically scale your AWS resources
- Scale your resources in response to CloudWatch alarms
- Schedule one-time or recurring scaling actions
- View the history of your scaling events
Application Auto Scaling can scale the following AWS resources:
- Amazon ECS services. For more information, see Service Auto Scaling in the Amazon Elastic Container Service Developer Guide .
- Amazon EC2 Spot fleets. For more information, see Automatic Scaling for Spot Fleet in the Amazon EC2 User Guide .
- Amazon EMR clusters. For more information, see Using Automatic Scaling in Amazon EMR in the Amazon EMR Management Guide .
- AppStream 2.0 fleets. For more information, see Fleet Auto Scaling for Amazon AppStream 2.0 in the Amazon AppStream 2.0 Developer Guide .
- Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see Managing Throughput Capacity Automatically with DynamoDB Auto Scaling in the Amazon DynamoDB Developer Guide .
- Amazon Aurora Replicas. For more information, see Using Amazon Aurora Auto Scaling with Aurora Replicas .
- Amazon SageMaker endpoints. For more information, see Automatically Scaling Amazon SageMaker Models .
To configure automatic scaling for multiple resources across multiple services, use AWS Auto Scaling to create a scaling plan for your application. For more information, see AWS Auto Scaling .
For a list of supported regions, see AWS Regions and Endpoints: Application Auto Scaling in the AWS General Reference .
Synopsis
- 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.PutScheduledAction
- module Network.AWS.ApplicationAutoScaling.DeleteScheduledAction
- module Network.AWS.ApplicationAutoScaling.DescribeScheduledActions
- module Network.AWS.ApplicationAutoScaling.DescribeScalableTargets
- module Network.AWS.ApplicationAutoScaling.DescribeScalingActivities
- module Network.AWS.ApplicationAutoScaling.DeregisterScalableTarget
- data AdjustmentType
- data MetricAggregationType
- data MetricStatistic
- = Average
- | Maximum
- | Minimum
- | SampleCount
- | Sum
- data MetricType
- = ALBRequestCountPerTarget
- | DynamoDBReadCapacityUtilization
- | DynamoDBWriteCapacityUtilization
- | EC2SpotFleetRequestAverageCPUUtilization
- | EC2SpotFleetRequestAverageNetworkIn
- | EC2SpotFleetRequestAverageNetworkOut
- | ECSServiceAverageCPUUtilization
- | ECSServiceAverageMemoryUtilization
- | RDSReaderAverageCPUUtilization
- | RDSReaderAverageDatabaseConnections
- | SageMakerVariantInvocationsPerInstance
- data PolicyType
- data ScalableDimension
- = AppstreamFleetDesiredCapacity
- | DynamodbIndexReadCapacityUnits
- | DynamodbIndexWriteCapacityUnits
- | DynamodbTableReadCapacityUnits
- | DynamodbTableWriteCapacityUnits
- | EC2SpotFleetRequestTargetCapacity
- | EcsServiceDesiredCount
- | ElasticmapreduceInstancegroupInstanceCount
- | RDSClusterReadReplicaCount
- | SagemakerVariantDesiredInstanceCount
- data ScalingActivityStatusCode
- data ServiceNamespace
- data Alarm
- alarm :: Text -> Text -> Alarm
- aAlarmName :: Lens' Alarm Text
- aAlarmARN :: Lens' Alarm Text
- data CustomizedMetricSpecification
- customizedMetricSpecification :: Text -> Text -> MetricStatistic -> CustomizedMetricSpecification
- cmsDimensions :: Lens' CustomizedMetricSpecification [MetricDimension]
- cmsUnit :: Lens' CustomizedMetricSpecification (Maybe Text)
- cmsMetricName :: Lens' CustomizedMetricSpecification Text
- cmsNamespace :: Lens' CustomizedMetricSpecification Text
- cmsStatistic :: Lens' CustomizedMetricSpecification MetricStatistic
- data MetricDimension
- metricDimension :: Text -> Text -> MetricDimension
- mdName :: Lens' MetricDimension Text
- mdValue :: Lens' MetricDimension Text
- data PredefinedMetricSpecification
- predefinedMetricSpecification :: MetricType -> PredefinedMetricSpecification
- pmsResourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text)
- pmsPredefinedMetricType :: Lens' PredefinedMetricSpecification MetricType
- 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 ScalableTargetAction
- scalableTargetAction :: ScalableTargetAction
- staMaxCapacity :: Lens' ScalableTargetAction (Maybe Int)
- staMinCapacity :: Lens' ScalableTargetAction (Maybe Int)
- data ScalingActivity
- scalingActivity :: Text -> ServiceNamespace -> Text -> ScalableDimension -> Text -> Text -> UTCTime -> ScalingActivityStatusCode -> ScalingActivity
- sStatusMessage :: Lens' ScalingActivity (Maybe Text)
- sEndTime :: Lens' ScalingActivity (Maybe UTCTime)
- sDetails :: Lens' ScalingActivity (Maybe Text)
- sActivityId :: Lens' ScalingActivity Text
- sServiceNamespace :: Lens' ScalingActivity ServiceNamespace
- sResourceId :: Lens' ScalingActivity Text
- sScalableDimension :: Lens' ScalingActivity ScalableDimension
- sDescription :: Lens' ScalingActivity Text
- sCause :: Lens' ScalingActivity Text
- sStartTime :: Lens' ScalingActivity UTCTime
- sStatusCode :: Lens' ScalingActivity ScalingActivityStatusCode
- data ScalingPolicy
- scalingPolicy :: Text -> Text -> ServiceNamespace -> Text -> ScalableDimension -> PolicyType -> UTCTime -> ScalingPolicy
- spTargetTrackingScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration)
- 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 ScheduledAction
- scheduledAction :: Text -> Text -> ServiceNamespace -> Text -> Text -> UTCTime -> ScheduledAction
- saScalableDimension :: Lens' ScheduledAction (Maybe ScalableDimension)
- saStartTime :: Lens' ScheduledAction (Maybe UTCTime)
- saEndTime :: Lens' ScheduledAction (Maybe UTCTime)
- saScalableTargetAction :: Lens' ScheduledAction (Maybe ScalableTargetAction)
- saScheduledActionName :: Lens' ScheduledAction Text
- saScheduledActionARN :: Lens' ScheduledAction Text
- saServiceNamespace :: Lens' ScheduledAction ServiceNamespace
- saSchedule :: Lens' ScheduledAction Text
- saResourceId :: Lens' ScheduledAction Text
- saCreationTime :: Lens' ScheduledAction 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)
- data TargetTrackingScalingPolicyConfiguration
- targetTrackingScalingPolicyConfiguration :: Double -> TargetTrackingScalingPolicyConfiguration
- ttspcPredefinedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe PredefinedMetricSpecification)
- ttspcScaleInCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int)
- ttspcCustomizedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe CustomizedMetricSpecification)
- ttspcDisableScaleIn :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Bool)
- ttspcScaleOutCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int)
- ttspcTargetValue :: Lens' TargetTrackingScalingPolicyConfiguration Double
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 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 permission to call the CloudWatch DescribeAlarms on your behalf.
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 operation that 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 operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A per-account resource limit is exceeded. For more information, see Application Auto Scaling Limits .
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 (Paginated)
PutScheduledAction
DeleteScheduledAction
DescribeScheduledActions
DescribeScalableTargets (Paginated)
DescribeScalingActivities (Paginated)
DeregisterScalableTarget
Types
AdjustmentType
data AdjustmentType Source #
Instances
MetricAggregationType
data MetricAggregationType Source #
Instances
MetricStatistic
data MetricStatistic Source #
Instances
MetricType
data MetricType Source #
Instances
PolicyType
data PolicyType Source #
Instances
ScalableDimension
data ScalableDimension Source #
Instances
ScalingActivityStatusCode
data ScalingActivityStatusCode Source #
Instances
ServiceNamespace
data ServiceNamespace Source #
Instances
Alarm
Represents a CloudWatch alarm associated with a scaling policy.
See: alarm
smart constructor.
Instances
Eq Alarm Source # | |
Data Alarm Source # | |
Defined in Network.AWS.ApplicationAutoScaling.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Alarm -> c Alarm # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Alarm # dataTypeOf :: Alarm -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Alarm) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Alarm) # gmapT :: (forall b. Data b => b -> b) -> Alarm -> Alarm # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Alarm -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Alarm -> r # gmapQ :: (forall d. Data d => d -> u) -> Alarm -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Alarm -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Alarm -> m Alarm # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Alarm -> m Alarm # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Alarm -> m Alarm # | |
Read Alarm Source # | |
Show Alarm Source # | |
Generic Alarm Source # | |
Hashable Alarm Source # | |
FromJSON Alarm Source # | |
NFData Alarm Source # | |
type Rep Alarm Source # | |
Defined in Network.AWS.ApplicationAutoScaling.Types.Product type Rep Alarm = D1 (MetaData "Alarm" "Network.AWS.ApplicationAutoScaling.Types.Product" "amazonka-application-autoscaling-1.6.1-Ev8NynEC12oENiC08b24gQ" False) (C1 (MetaCons "Alarm'" PrefixI True) (S1 (MetaSel (Just "_aAlarmName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_aAlarmARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) |
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:
aAlarmName
- The name of the alarm.aAlarmARN
- The Amazon Resource Name (ARN) of the alarm.
CustomizedMetricSpecification
data CustomizedMetricSpecification Source #
Configures a customized metric for a target tracking policy.
See: customizedMetricSpecification
smart constructor.
Instances
customizedMetricSpecification Source #
Creates a value of CustomizedMetricSpecification
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmsDimensions
- The dimensions of the metric.cmsUnit
- The unit of the metric.cmsMetricName
- The name of the metric.cmsNamespace
- The namespace of the metric.cmsStatistic
- The statistic of the metric.
cmsDimensions :: Lens' CustomizedMetricSpecification [MetricDimension] Source #
The dimensions of the metric.
cmsMetricName :: Lens' CustomizedMetricSpecification Text Source #
The name of the metric.
cmsNamespace :: Lens' CustomizedMetricSpecification Text Source #
The namespace of the metric.
cmsStatistic :: Lens' CustomizedMetricSpecification MetricStatistic Source #
The statistic of the metric.
MetricDimension
data MetricDimension Source #
Describes the dimension of a metric.
See: metricDimension
smart constructor.
Instances
:: Text | |
-> Text | |
-> MetricDimension |
Creates a value of MetricDimension
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
PredefinedMetricSpecification
data PredefinedMetricSpecification Source #
Configures a predefined metric for a target tracking policy.
See: predefinedMetricSpecification
smart constructor.
Instances
predefinedMetricSpecification Source #
Creates a value of PredefinedMetricSpecification
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pmsResourceLabel
- Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type isALBRequestCountPerTarget
and there is a target group attached to the Spot fleet request or ECS service. The format is appload-balancer-nameload-balancer-idtargetgrouptarget-group-nametarget-group-id, where: * appload-balancer-nameload-balancer-id is the final portion of the load balancer ARN * targetgrouptarget-group-name/target-group-id is the final portion of the target group ARN.pmsPredefinedMetricType
- The metric type. TheALBRequestCountPerTarget
metric type applies only to Spot fleet requests and ECS services.
pmsResourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text) Source #
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 appload-balancer-nameload-balancer-idtargetgrouptarget-group-nametarget-group-id, where: * appload-balancer-nameload-balancer-id is the final portion of the load balancer ARN * targetgrouptarget-group-name/target-group-id is the final portion of the target group ARN.
pmsPredefinedMetricType :: Lens' PredefinedMetricSpecification MetricType Source #
The metric type. The ALBRequestCountPerTarget
metric type applies only to Spot fleet requests and ECS services.
ScalableTarget
data ScalableTarget Source #
Represents a scalable target.
See: scalableTarget
smart constructor.
Instances
:: 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
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .stResourceId
- 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 isservice
and the unique identifier is the cluster name and service name. Example:servicedefaultsample-webapp
. * Spot fleet request - The resource type isspot-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 isinstancegroup
and the unique identifier is the cluster ID and instance group ID. Example:instancegroupj-2EEZNYKUA1NTVig-1791Y4E1L8YI0
. * AppStream 2.0 fleet - The resource type isfleet
and the unique identifier is the fleet name. Example:fleet/sample-fleet
. * DynamoDB table - The resource type istable
and the unique identifier is the resource ID. Example:table/my-table
. * DynamoDB global secondary index - The resource type isindex
and the unique identifier is the resource ID. Example:tablemy-tableindex/my-table-index
. * Aurora DB cluster - The resource type iscluster
and the unique identifier is the cluster name. Example:cluster:my-db-cluster
. * Amazon SageMaker endpoint variants - The resource type isvariant
and the unique identifier is the resource ID. Example:endpointmy-end-pointvariant/KMeansClustering
.stScalableDimension
- 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.stMinCapacity
- The minimum value to scale to in response to a scale in event.stMaxCapacity
- The maximum value to scale to in response to a scale out event.stRoleARN
- The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.stCreationTime
- The Unix timestamp for when the scalable target was created.
stServiceNamespace :: Lens' ScalableTarget ServiceNamespace Source #
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
stResourceId :: Lens' ScalableTarget Text Source #
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: servicedefaultsample-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: instancegroupj-2EEZNYKUA1NTVig-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: tablemy-tableindex/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: endpointmy-end-pointvariant/KMeansClustering
.
stScalableDimension :: Lens' ScalableTarget ScalableDimension Source #
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.
stMinCapacity :: Lens' ScalableTarget Int Source #
The minimum value to scale to in response to a scale in event.
stMaxCapacity :: Lens' ScalableTarget Int Source #
The maximum value to scale to in response to a scale out event.
stRoleARN :: Lens' ScalableTarget Text Source #
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
stCreationTime :: Lens' ScalableTarget UTCTime Source #
The Unix timestamp for when the scalable target was created.
ScalableTargetAction
data ScalableTargetAction Source #
Represents the minimum and maximum capacity for a scheduled action.
See: scalableTargetAction
smart constructor.
Instances
scalableTargetAction :: ScalableTargetAction Source #
Creates a value of ScalableTargetAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
staMaxCapacity
- The maximum capacity.staMinCapacity
- The minimum capacity.
staMaxCapacity :: Lens' ScalableTargetAction (Maybe Int) Source #
The maximum capacity.
staMinCapacity :: Lens' ScalableTargetAction (Maybe Int) Source #
The minimum capacity.
ScalingActivity
data ScalingActivity Source #
Represents a scaling activity.
See: scalingActivity
smart constructor.
Instances
:: 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:
sStatusMessage
- A simple message about the current status of the scaling activity.sEndTime
- The Unix timestamp for when the scaling activity ended.sDetails
- The details about the scaling activity.sActivityId
- The unique identifier of the scaling activity.sServiceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .sResourceId
- 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 isservice
and the unique identifier is the cluster name and service name. Example:servicedefaultsample-webapp
. * Spot fleet request - The resource type isspot-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 isinstancegroup
and the unique identifier is the cluster ID and instance group ID. Example:instancegroupj-2EEZNYKUA1NTVig-1791Y4E1L8YI0
. * AppStream 2.0 fleet - The resource type isfleet
and the unique identifier is the fleet name. Example:fleet/sample-fleet
. * DynamoDB table - The resource type istable
and the unique identifier is the resource ID. Example:table/my-table
. * DynamoDB global secondary index - The resource type isindex
and the unique identifier is the resource ID. Example:tablemy-tableindex/my-table-index
. * Aurora DB cluster - The resource type iscluster
and the unique identifier is the cluster name. Example:cluster:my-db-cluster
. * Amazon SageMaker endpoint variants - The resource type isvariant
and the unique identifier is the resource ID. Example:endpointmy-end-pointvariant/KMeansClustering
.sScalableDimension
- 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.sDescription
- A simple description of what action the scaling activity intends to accomplish.sCause
- A simple description of what caused the scaling activity to happen.sStartTime
- The Unix timestamp for when the scaling activity began.sStatusCode
- Indicates the status of the scaling activity.
sStatusMessage :: Lens' ScalingActivity (Maybe Text) Source #
A simple message about the current status of the scaling activity.
sEndTime :: Lens' ScalingActivity (Maybe UTCTime) Source #
The Unix timestamp for when the scaling activity ended.
sActivityId :: Lens' ScalingActivity Text Source #
The unique identifier of the scaling activity.
sServiceNamespace :: Lens' ScalingActivity ServiceNamespace Source #
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
sResourceId :: Lens' ScalingActivity Text Source #
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: servicedefaultsample-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: instancegroupj-2EEZNYKUA1NTVig-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: tablemy-tableindex/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: endpointmy-end-pointvariant/KMeansClustering
.
sScalableDimension :: Lens' ScalingActivity ScalableDimension Source #
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.
sDescription :: Lens' ScalingActivity Text Source #
A simple description of what action the scaling activity intends to accomplish.
sCause :: Lens' ScalingActivity Text Source #
A simple description of what caused the scaling activity to happen.
sStartTime :: Lens' ScalingActivity UTCTime Source #
The Unix timestamp for when the scaling activity began.
sStatusCode :: Lens' ScalingActivity ScalingActivityStatusCode Source #
Indicates the status of the scaling activity.
ScalingPolicy
data ScalingPolicy Source #
Represents a scaling policy.
See: scalingPolicy
smart constructor.
Instances
:: 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:
spTargetTrackingScalingPolicyConfiguration
- A target tracking policy.spStepScalingPolicyConfiguration
- A step scaling policy.spAlarms
- The CloudWatch alarms associated with the scaling policy.spPolicyARN
- The Amazon Resource Name (ARN) of the scaling policy.spPolicyName
- The name of the scaling policy.spServiceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .spResourceId
- 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 isservice
and the unique identifier is the cluster name and service name. Example:servicedefaultsample-webapp
. * Spot fleet request - The resource type isspot-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 isinstancegroup
and the unique identifier is the cluster ID and instance group ID. Example:instancegroupj-2EEZNYKUA1NTVig-1791Y4E1L8YI0
. * AppStream 2.0 fleet - The resource type isfleet
and the unique identifier is the fleet name. Example:fleet/sample-fleet
. * DynamoDB table - The resource type istable
and the unique identifier is the resource ID. Example:table/my-table
. * DynamoDB global secondary index - The resource type isindex
and the unique identifier is the resource ID. Example:tablemy-tableindex/my-table-index
. * Aurora DB cluster - The resource type iscluster
and the unique identifier is the cluster name. Example:cluster:my-db-cluster
. * Amazon SageMaker endpoint variants - The resource type isvariant
and the unique identifier is the resource ID. Example:endpointmy-end-pointvariant/KMeansClustering
.spScalableDimension
- 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.spPolicyType
- The scaling policy type.spCreationTime
- The Unix timestamp for when the scaling policy was created.
spTargetTrackingScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration) Source #
A target tracking policy.
spStepScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe StepScalingPolicyConfiguration) Source #
A step scaling policy.
spAlarms :: Lens' ScalingPolicy [Alarm] Source #
The CloudWatch alarms 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 of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
spResourceId :: Lens' ScalingPolicy Text Source #
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: servicedefaultsample-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: instancegroupj-2EEZNYKUA1NTVig-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: tablemy-tableindex/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: endpointmy-end-pointvariant/KMeansClustering
.
spScalableDimension :: Lens' ScalingPolicy ScalableDimension Source #
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.
spPolicyType :: Lens' ScalingPolicy PolicyType Source #
The scaling policy type.
spCreationTime :: Lens' ScalingPolicy UTCTime Source #
The Unix timestamp for when the scaling policy was created.
ScheduledAction
data ScheduledAction Source #
Represents a scheduled action.
See: scheduledAction
smart constructor.
Instances
:: Text | |
-> Text | |
-> ServiceNamespace | |
-> Text | |
-> Text | |
-> UTCTime | |
-> ScheduledAction |
Creates a value of ScheduledAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saScalableDimension
- 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.saStartTime
- The date and time that the action is scheduled to begin.saEndTime
- The date and time that the action is scheduled to end.saScalableTargetAction
- 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.saScheduledActionName
- The name of the scheduled action.saScheduledActionARN
- The Amazon Resource Name (ARN) of the scheduled action.saServiceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .saSchedule
- The schedule for this action. The following formats are supported: * At expressions -at(yyyy -mm -dd Thh :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 isminute
|minutes
|hour
|hours
|day
|days
. For more information about cron expressions, see Cron .saResourceId
- 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 isservice
and the unique identifier is the cluster name and service name. Example:servicedefaultsample-webapp
. * Spot fleet request - The resource type isspot-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 isinstancegroup
and the unique identifier is the cluster ID and instance group ID. Example:instancegroupj-2EEZNYKUA1NTVig-1791Y4E1L8YI0
. * AppStream 2.0 fleet - The resource type isfleet
and the unique identifier is the fleet name. Example:fleet/sample-fleet
. * DynamoDB table - The resource type istable
and the unique identifier is the resource ID. Example:table/my-table
. * DynamoDB global secondary index - The resource type isindex
and the unique identifier is the resource ID. Example:tablemy-tableindex/my-table-index
. * Aurora DB cluster - The resource type iscluster
and the unique identifier is the cluster name. Example:cluster:my-db-cluster
. * Amazon SageMaker endpoint variants - The resource type isvariant
and the unique identifier is the resource ID. Example:endpointmy-end-pointvariant/KMeansClustering
.saCreationTime
- The date and time that the scheduled action was created.
saScalableDimension :: Lens' ScheduledAction (Maybe ScalableDimension) Source #
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.
saStartTime :: Lens' ScheduledAction (Maybe UTCTime) Source #
The date and time that the action is scheduled to begin.
saEndTime :: Lens' ScheduledAction (Maybe UTCTime) Source #
The date and time that the action is scheduled to end.
saScalableTargetAction :: Lens' ScheduledAction (Maybe ScalableTargetAction) Source #
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.
saScheduledActionName :: Lens' ScheduledAction Text Source #
The name of the scheduled action.
saScheduledActionARN :: Lens' ScheduledAction Text Source #
The Amazon Resource Name (ARN) of the scheduled action.
saServiceNamespace :: Lens' ScheduledAction ServiceNamespace Source #
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
saSchedule :: Lens' ScheduledAction Text Source #
The schedule for this action. The following formats are supported: * At expressions - at(yyyy -mm -dd Thh :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 .
saResourceId :: Lens' ScheduledAction Text Source #
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: servicedefaultsample-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: instancegroupj-2EEZNYKUA1NTVig-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: tablemy-tableindex/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: endpointmy-end-pointvariant/KMeansClustering
.
saCreationTime :: Lens' ScheduledAction UTCTime Source #
The date and time that the scheduled action was created.
StepAdjustment
data StepAdjustment Source #
Represents 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:
- To trigger the adjustment 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.
- To trigger the adjustment 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.
Instances
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
- 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
- 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
- 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.
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 #
Represents a step scaling policy configuration.
See: stepScalingPolicyConfiguration
smart constructor.
Instances
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
- A set of adjustments that enable you to scale based on the size of the alarm breach.sspcAdjustmentType
- The adjustment type, which specifies how theScalingAdjustment
parameter in aStepAdjustment
is interpreted.sspcCooldown
- 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.sspcMetricAggregationType
- The aggregation type for the CloudWatch metrics. Valid values areMinimum
,Maximum
, andAverage
.sspcMinAdjustmentMagnitude
- The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type isPercentChangeInCapacity
, the scaling policy changes the scalable dimension of the scalable target by this amount.
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 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.
sspcMetricAggregationType :: Lens' StepScalingPolicyConfiguration (Maybe MetricAggregationType) Source #
The aggregation type for the CloudWatch metrics. Valid values are Minimum
, Maximum
, and Average
.
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.
TargetTrackingScalingPolicyConfiguration
data TargetTrackingScalingPolicyConfiguration Source #
Represents a target tracking scaling policy configuration.
See: targetTrackingScalingPolicyConfiguration
smart constructor.
Instances
targetTrackingScalingPolicyConfiguration Source #
Creates a value of TargetTrackingScalingPolicyConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ttspcPredefinedMetricSpecification
- A predefined metric.ttspcScaleInCooldown
- 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.ttspcCustomizedMetricSpecification
- A customized metric.ttspcDisableScaleIn
- Indicates whether scale in by the target tracking policy is disabled. If the value istrue
, 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 isfalse
.ttspcScaleOutCooldown
- 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.ttspcTargetValue
- 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).
ttspcPredefinedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe PredefinedMetricSpecification) Source #
A predefined metric.
ttspcScaleInCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int) Source #
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.
ttspcCustomizedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe CustomizedMetricSpecification) Source #
A customized metric.
ttspcDisableScaleIn :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Bool) Source #
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
.
ttspcScaleOutCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int) Source #
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.
ttspcTargetValue :: Lens' TargetTrackingScalingPolicyConfiguration Double Source #
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).