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 |
Network.AWS.AutoScalingPlans
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- MetricStatistic
- PolicyType
- ScalableDimension
- ScalingMetricType
- ScalingPlanStatusCode
- ScalingStatusCode
- ServiceNamespace
- ApplicationSource
- CustomizedScalingMetricSpecification
- MetricDimension
- PredefinedScalingMetricSpecification
- ScalingInstruction
- ScalingPlan
- ScalingPlanResource
- ScalingPolicy
- TagFilter
- TargetTrackingConfiguration
Description
AWS Auto Scaling
Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling for your scalable resources.
To get started, create a scaling plan with a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies for the scalable resources in your scaling plan. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.
Synopsis
- autoScalingPlans :: Service
- _ValidationException :: 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.AutoScalingPlans.DescribeScalingPlanResources
- module Network.AWS.AutoScalingPlans.CreateScalingPlan
- module Network.AWS.AutoScalingPlans.DeleteScalingPlan
- module Network.AWS.AutoScalingPlans.UpdateScalingPlan
- module Network.AWS.AutoScalingPlans.DescribeScalingPlans
- data MetricStatistic
- = Average
- | Maximum
- | Minimum
- | SampleCount
- | Sum
- data PolicyType = TargetTrackingScaling
- data ScalableDimension
- data ScalingMetricType
- = ALBRequestCountPerTarget
- | ASGAverageCPUUtilization
- | ASGAverageNetworkIn
- | ASGAverageNetworkOut
- | DynamoDBReadCapacityUtilization
- | DynamoDBWriteCapacityUtilization
- | EC2SpotFleetRequestAverageCPUUtilization
- | EC2SpotFleetRequestAverageNetworkIn
- | EC2SpotFleetRequestAverageNetworkOut
- | ECSServiceAverageCPUUtilization
- | ECSServiceAverageMemoryUtilization
- | RDSReaderAverageCPUUtilization
- | RDSReaderAverageDatabaseConnections
- data ScalingPlanStatusCode
- data ScalingStatusCode
- data ServiceNamespace
- = Autoscaling
- | Dynamodb
- | EC2
- | Ecs
- | RDS
- data ApplicationSource
- applicationSource :: ApplicationSource
- asTagFilters :: Lens' ApplicationSource [TagFilter]
- asCloudFormationStackARN :: Lens' ApplicationSource (Maybe Text)
- data CustomizedScalingMetricSpecification
- customizedScalingMetricSpecification :: Text -> Text -> MetricStatistic -> CustomizedScalingMetricSpecification
- csmsDimensions :: Lens' CustomizedScalingMetricSpecification [MetricDimension]
- csmsUnit :: Lens' CustomizedScalingMetricSpecification (Maybe Text)
- csmsMetricName :: Lens' CustomizedScalingMetricSpecification Text
- csmsNamespace :: Lens' CustomizedScalingMetricSpecification Text
- csmsStatistic :: Lens' CustomizedScalingMetricSpecification MetricStatistic
- data MetricDimension
- metricDimension :: Text -> Text -> MetricDimension
- mdName :: Lens' MetricDimension Text
- mdValue :: Lens' MetricDimension Text
- data PredefinedScalingMetricSpecification
- predefinedScalingMetricSpecification :: ScalingMetricType -> PredefinedScalingMetricSpecification
- psmsResourceLabel :: Lens' PredefinedScalingMetricSpecification (Maybe Text)
- psmsPredefinedScalingMetricType :: Lens' PredefinedScalingMetricSpecification ScalingMetricType
- data ScalingInstruction
- scalingInstruction :: ServiceNamespace -> Text -> ScalableDimension -> Int -> Int -> ScalingInstruction
- siServiceNamespace :: Lens' ScalingInstruction ServiceNamespace
- siResourceId :: Lens' ScalingInstruction Text
- siScalableDimension :: Lens' ScalingInstruction ScalableDimension
- siMinCapacity :: Lens' ScalingInstruction Int
- siMaxCapacity :: Lens' ScalingInstruction Int
- siTargetTrackingConfigurations :: Lens' ScalingInstruction [TargetTrackingConfiguration]
- data ScalingPlan
- scalingPlan :: Text -> Integer -> ApplicationSource -> ScalingPlanStatusCode -> ScalingPlan
- spCreationTime :: Lens' ScalingPlan (Maybe UTCTime)
- spStatusStartTime :: Lens' ScalingPlan (Maybe UTCTime)
- spStatusMessage :: Lens' ScalingPlan (Maybe Text)
- spScalingPlanName :: Lens' ScalingPlan Text
- spScalingPlanVersion :: Lens' ScalingPlan Integer
- spApplicationSource :: Lens' ScalingPlan ApplicationSource
- spScalingInstructions :: Lens' ScalingPlan [ScalingInstruction]
- spStatusCode :: Lens' ScalingPlan ScalingPlanStatusCode
- data ScalingPlanResource
- scalingPlanResource :: Text -> Integer -> ServiceNamespace -> Text -> ScalableDimension -> ScalingStatusCode -> ScalingPlanResource
- sprScalingStatusMessage :: Lens' ScalingPlanResource (Maybe Text)
- sprScalingPolicies :: Lens' ScalingPlanResource [ScalingPolicy]
- sprScalingPlanName :: Lens' ScalingPlanResource Text
- sprScalingPlanVersion :: Lens' ScalingPlanResource Integer
- sprServiceNamespace :: Lens' ScalingPlanResource ServiceNamespace
- sprResourceId :: Lens' ScalingPlanResource Text
- sprScalableDimension :: Lens' ScalingPlanResource ScalableDimension
- sprScalingStatusCode :: Lens' ScalingPlanResource ScalingStatusCode
- data ScalingPolicy
- scalingPolicy :: Text -> PolicyType -> ScalingPolicy
- spTargetTrackingConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingConfiguration)
- spPolicyName :: Lens' ScalingPolicy Text
- spPolicyType :: Lens' ScalingPolicy PolicyType
- data TagFilter
- tagFilter :: TagFilter
- tfValues :: Lens' TagFilter [Text]
- tfKey :: Lens' TagFilter (Maybe Text)
- data TargetTrackingConfiguration
- targetTrackingConfiguration :: Double -> TargetTrackingConfiguration
- ttcEstimatedInstanceWarmup :: Lens' TargetTrackingConfiguration (Maybe Int)
- ttcPredefinedScalingMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe PredefinedScalingMetricSpecification)
- ttcScaleInCooldown :: Lens' TargetTrackingConfiguration (Maybe Int)
- ttcDisableScaleIn :: Lens' TargetTrackingConfiguration (Maybe Bool)
- ttcCustomizedScalingMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe CustomizedScalingMetricSpecification)
- ttcScaleOutCooldown :: Lens' TargetTrackingConfiguration (Maybe Int)
- ttcTargetValue :: Lens' TargetTrackingConfiguration Double
Service Configuration
autoScalingPlans :: Service Source #
API version 2018-01-06
of the Amazon Auto Scaling Plans 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 AutoScalingPlans
.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception was thrown for a validation issue. Review the parameters provided.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The token provided is not valid.
ConcurrentUpdateException
_ConcurrentUpdateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
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.
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.
DescribeScalingPlanResources
CreateScalingPlan
DeleteScalingPlan
UpdateScalingPlan
DescribeScalingPlans
Types
MetricStatistic
data MetricStatistic Source #
Constructors
Average | |
Maximum | |
Minimum | |
SampleCount | |
Sum |
Instances
PolicyType
data PolicyType Source #
Constructors
TargetTrackingScaling |
Instances
ScalableDimension
data ScalableDimension Source #
Constructors
Instances
ScalingMetricType
data ScalingMetricType Source #
Constructors
Instances
ScalingPlanStatusCode
data ScalingPlanStatusCode Source #
Constructors
SPSCActive | |
SPSCActiveWithProblems | |
SPSCCreationFailed | |
SPSCCreationInProgress | |
SPSCDeletionFailed | |
SPSCDeletionInProgress | |
SPSCUpdateFailed | |
SPSCUpdateInProgress |
Instances
ScalingStatusCode
data ScalingStatusCode Source #
Constructors
Active | |
Inactive | |
PartiallyActive |
Instances
ServiceNamespace
data ServiceNamespace Source #
Constructors
Autoscaling | |
Dynamodb | |
EC2 | |
Ecs | |
RDS |
Instances
ApplicationSource
data ApplicationSource Source #
Represents an application source.
See: applicationSource
smart constructor.
Instances
applicationSource :: ApplicationSource Source #
Creates a value of ApplicationSource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asTagFilters
- A set of tags (up to 50).asCloudFormationStackARN
- The Amazon Resource Name (ARN) of a CloudFormation stack.
asTagFilters :: Lens' ApplicationSource [TagFilter] Source #
A set of tags (up to 50).
asCloudFormationStackARN :: Lens' ApplicationSource (Maybe Text) Source #
The Amazon Resource Name (ARN) of a CloudFormation stack.
CustomizedScalingMetricSpecification
data CustomizedScalingMetricSpecification Source #
Represents a customized metric for a target tracking policy.
See: customizedScalingMetricSpecification
smart constructor.
Instances
customizedScalingMetricSpecification Source #
Arguments
:: Text | |
-> Text | |
-> MetricStatistic | |
-> CustomizedScalingMetricSpecification |
Creates a value of CustomizedScalingMetricSpecification
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csmsDimensions
- The dimensions of the metric.csmsUnit
- The unit of the metric.csmsMetricName
- The name of the metric.csmsNamespace
- The namespace of the metric.csmsStatistic
- The statistic of the metric.
csmsDimensions :: Lens' CustomizedScalingMetricSpecification [MetricDimension] Source #
The dimensions of the metric.
csmsMetricName :: Lens' CustomizedScalingMetricSpecification Text Source #
The name of the metric.
csmsNamespace :: Lens' CustomizedScalingMetricSpecification Text Source #
The namespace of the metric.
csmsStatistic :: Lens' CustomizedScalingMetricSpecification MetricStatistic Source #
The statistic of the metric.
MetricDimension
data MetricDimension Source #
Represents a dimension for a customized metric.
See: metricDimension
smart constructor.
Instances
Arguments
:: 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:
PredefinedScalingMetricSpecification
data PredefinedScalingMetricSpecification Source #
Represents a predefined metric for a target tracking policy.
See: predefinedScalingMetricSpecification
smart constructor.
Instances
predefinedScalingMetricSpecification Source #
Creates a value of PredefinedScalingMetricSpecification
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psmsResourceLabel
- 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 for an Application Load Balancer attached to the Auto Scaling group, 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.psmsPredefinedScalingMetricType
- The metric type. TheALBRequestCountPerTarget
metric type applies only to Auto Scaling groups, Sport Fleet requests, and ECS services.
psmsResourceLabel :: Lens' PredefinedScalingMetricSpecification (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 for an Application Load Balancer attached to the Auto Scaling group, 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.
psmsPredefinedScalingMetricType :: Lens' PredefinedScalingMetricSpecification ScalingMetricType Source #
The metric type. The ALBRequestCountPerTarget
metric type applies only to Auto Scaling groups, Sport Fleet requests, and ECS services.
ScalingInstruction
data ScalingInstruction Source #
Specifies the scaling configuration for a scalable resource.
See: scalingInstruction
smart constructor.
Instances
Arguments
:: ServiceNamespace | |
-> Text | |
-> ScalableDimension | |
-> Int | |
-> Int | |
-> ScalingInstruction |
Creates a value of ScalingInstruction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siServiceNamespace
- The namespace of the AWS service.siResourceId
- The ID of the resource. This string consists of the resource type and unique identifier. * Auto Scaling group - The resource type isautoScalingGroup
and the unique identifier is the name of the Auto Scaling group. Example:autoScalingGroup/my-asg
. * 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
. * 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
.siScalableDimension
- The scalable dimension associated with the resource. *autoscaling:autoScalingGroup:DesiredCapacity
- The desired capacity of an Auto Scaling group. *ecs:service:DesiredCount
- The desired task count of an ECS service. *ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot fleet request. *dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table. *dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table. *dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index. *dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index. *rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.siMinCapacity
- The minimum value to scale to in response to a scale in event.siMaxCapacity
- The maximum value to scale to in response to a scale out event.siTargetTrackingConfigurations
- The target tracking scaling policies (up to 10).
siServiceNamespace :: Lens' ScalingInstruction ServiceNamespace Source #
The namespace of the AWS service.
siResourceId :: Lens' ScalingInstruction Text Source #
The ID of the resource. This string consists of the resource type and unique identifier. * Auto Scaling group - The resource type is autoScalingGroup
and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg
. * ECS service - The resource type is service
and the unique identifier is the cluster name and service name. Example: 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
. * 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
.
siScalableDimension :: Lens' ScalingInstruction ScalableDimension Source #
The scalable dimension associated with the resource. * autoscaling:autoScalingGroup:DesiredCapacity
- The desired capacity of an Auto Scaling group. * ecs:service:DesiredCount
- The desired task count of an ECS service. * ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot fleet request. * dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table. * dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table. * dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index. * dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index. * rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.
siMinCapacity :: Lens' ScalingInstruction Int Source #
The minimum value to scale to in response to a scale in event.
siMaxCapacity :: Lens' ScalingInstruction Int Source #
The maximum value to scale to in response to a scale out event.
siTargetTrackingConfigurations :: Lens' ScalingInstruction [TargetTrackingConfiguration] Source #
The target tracking scaling policies (up to 10).
ScalingPlan
data ScalingPlan Source #
Represents a scaling plan.
See: scalingPlan
smart constructor.
Instances
Arguments
:: Text | |
-> Integer | |
-> ApplicationSource | |
-> ScalingPlanStatusCode | |
-> ScalingPlan |
Creates a value of ScalingPlan
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spCreationTime
- The Unix timestamp when the scaling plan was created.spStatusStartTime
- The Unix timestamp when the scaling plan entered the current status.spStatusMessage
- A simple message about the current status of the scaling plan.spScalingPlanName
- The name of the scaling plan.spScalingPlanVersion
- The version of the scaling plan.spApplicationSource
- The application source.spScalingInstructions
- The scaling instructions.spStatusCode
- The status of the scaling plan. *Active
- The scaling plan is active. *ActiveWithProblems
- The scaling plan is active, but the scaling configuration for one or more resources could not be applied. *CreationInProgress
- The scaling plan is being created. *CreationFailed
- The scaling plan could not be created. *DeletionInProgress
- The scaling plan is being deleted. *DeletionFailed
- The scaling plan could not be deleted.
spCreationTime :: Lens' ScalingPlan (Maybe UTCTime) Source #
The Unix timestamp when the scaling plan was created.
spStatusStartTime :: Lens' ScalingPlan (Maybe UTCTime) Source #
The Unix timestamp when the scaling plan entered the current status.
spStatusMessage :: Lens' ScalingPlan (Maybe Text) Source #
A simple message about the current status of the scaling plan.
spScalingPlanName :: Lens' ScalingPlan Text Source #
The name of the scaling plan.
spScalingPlanVersion :: Lens' ScalingPlan Integer Source #
The version of the scaling plan.
spApplicationSource :: Lens' ScalingPlan ApplicationSource Source #
The application source.
spScalingInstructions :: Lens' ScalingPlan [ScalingInstruction] Source #
The scaling instructions.
spStatusCode :: Lens' ScalingPlan ScalingPlanStatusCode Source #
The status of the scaling plan. * Active
- The scaling plan is active. * ActiveWithProblems
- The scaling plan is active, but the scaling configuration for one or more resources could not be applied. * CreationInProgress
- The scaling plan is being created. * CreationFailed
- The scaling plan could not be created. * DeletionInProgress
- The scaling plan is being deleted. * DeletionFailed
- The scaling plan could not be deleted.
ScalingPlanResource
data ScalingPlanResource Source #
Represents a scalable resource.
See: scalingPlanResource
smart constructor.
Instances
Arguments
:: Text | |
-> Integer | |
-> ServiceNamespace | |
-> Text | |
-> ScalableDimension | |
-> ScalingStatusCode | |
-> ScalingPlanResource |
Creates a value of ScalingPlanResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sprScalingStatusMessage
- A simple message about the current scaling status of the resource.sprScalingPolicies
- The scaling policies.sprScalingPlanName
- The name of the scaling plan.sprScalingPlanVersion
- The version of the scaling plan.sprServiceNamespace
- The namespace of the AWS service.sprResourceId
- The ID of the resource. This string consists of the resource type and unique identifier. * Auto Scaling group - The resource type isautoScalingGroup
and the unique identifier is the name of the Auto Scaling group. Example:autoScalingGroup/my-asg
. * 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
. * 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
.sprScalableDimension
- The scalable dimension for the resource. *autoscaling:autoScalingGroup:DesiredCapacity
- The desired capacity of an Auto Scaling group. *ecs:service:DesiredCount
- The desired task count of an ECS service. *ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot fleet request. *dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table. *dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table. *dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index. *dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index. *rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.sprScalingStatusCode
- The scaling status of the resource. *Active
- The scaling configuration is active. *Inactive
- The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. *PartiallyActive
- The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.
sprScalingStatusMessage :: Lens' ScalingPlanResource (Maybe Text) Source #
A simple message about the current scaling status of the resource.
sprScalingPolicies :: Lens' ScalingPlanResource [ScalingPolicy] Source #
The scaling policies.
sprScalingPlanName :: Lens' ScalingPlanResource Text Source #
The name of the scaling plan.
sprScalingPlanVersion :: Lens' ScalingPlanResource Integer Source #
The version of the scaling plan.
sprServiceNamespace :: Lens' ScalingPlanResource ServiceNamespace Source #
The namespace of the AWS service.
sprResourceId :: Lens' ScalingPlanResource Text Source #
The ID of the resource. This string consists of the resource type and unique identifier. * Auto Scaling group - The resource type is autoScalingGroup
and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg
. * ECS service - The resource type is service
and the unique identifier is the cluster name and service name. Example: 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
. * 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
.
sprScalableDimension :: Lens' ScalingPlanResource ScalableDimension Source #
The scalable dimension for the resource. * autoscaling:autoScalingGroup:DesiredCapacity
- The desired capacity of an Auto Scaling group. * ecs:service:DesiredCount
- The desired task count of an ECS service. * ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot fleet request. * dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table. * dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table. * dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index. * dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index. * rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.
sprScalingStatusCode :: Lens' ScalingPlanResource ScalingStatusCode Source #
The scaling status of the resource. * Active
- The scaling configuration is active. * Inactive
- The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. * PartiallyActive
- The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.
ScalingPolicy
data ScalingPolicy Source #
Represents a scaling policy.
See: scalingPolicy
smart constructor.
Instances
Arguments
:: Text | |
-> PolicyType | |
-> 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:
spTargetTrackingConfiguration
- The target tracking scaling policy.spPolicyName
- The name of the scaling policy.spPolicyType
- The type of scaling policy.
spTargetTrackingConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingConfiguration) Source #
The target tracking scaling policy.
spPolicyName :: Lens' ScalingPolicy Text Source #
The name of the scaling policy.
spPolicyType :: Lens' ScalingPolicy PolicyType Source #
The type of scaling policy.
TagFilter
Represents a tag.
See: tagFilter
smart constructor.
Instances
TargetTrackingConfiguration
data TargetTrackingConfiguration Source #
Represents a target tracking scaling policy.
See: targetTrackingConfiguration
smart constructor.
Instances
targetTrackingConfiguration Source #
Arguments
:: Double | |
-> TargetTrackingConfiguration |
Creates a value of TargetTrackingConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ttcEstimatedInstanceWarmup
- The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.ttcPredefinedScalingMetricSpecification
- A predefined metric.ttcScaleInCooldown
- The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group. The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.ttcDisableScaleIn
- 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
.ttcCustomizedScalingMetricSpecification
- A customized metric.ttcScaleOutCooldown
- The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.ttcTargetValue
- 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).
ttcEstimatedInstanceWarmup :: Lens' TargetTrackingConfiguration (Maybe Int) Source #
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
ttcPredefinedScalingMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe PredefinedScalingMetricSpecification) Source #
A predefined metric.
ttcScaleInCooldown :: Lens' TargetTrackingConfiguration (Maybe Int) Source #
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group. The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.
ttcDisableScaleIn :: Lens' TargetTrackingConfiguration (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
.
ttcCustomizedScalingMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe CustomizedScalingMetricSpecification) Source #
A customized metric.
ttcScaleOutCooldown :: Lens' TargetTrackingConfiguration (Maybe Int) Source #
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.
ttcTargetValue :: Lens' TargetTrackingConfiguration 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).