Copyright | (c) 2013-2021 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 |
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to execute scaling policies. Any scaling policies that were specified for the scalable target are deleted.
Synopsis
- data PutScalingPolicy = PutScalingPolicy' {
- policyType :: Maybe PolicyType
- targetTrackingScalingPolicyConfiguration :: Maybe TargetTrackingScalingPolicyConfiguration
- stepScalingPolicyConfiguration :: Maybe StepScalingPolicyConfiguration
- policyName :: Text
- serviceNamespace :: ServiceNamespace
- resourceId :: Text
- scalableDimension :: ScalableDimension
- newPutScalingPolicy :: Text -> ServiceNamespace -> Text -> ScalableDimension -> PutScalingPolicy
- putScalingPolicy_policyType :: Lens' PutScalingPolicy (Maybe PolicyType)
- putScalingPolicy_targetTrackingScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration)
- putScalingPolicy_stepScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe StepScalingPolicyConfiguration)
- putScalingPolicy_policyName :: Lens' PutScalingPolicy Text
- putScalingPolicy_serviceNamespace :: Lens' PutScalingPolicy ServiceNamespace
- putScalingPolicy_resourceId :: Lens' PutScalingPolicy Text
- putScalingPolicy_scalableDimension :: Lens' PutScalingPolicy ScalableDimension
- data PutScalingPolicyResponse = PutScalingPolicyResponse' {}
- newPutScalingPolicyResponse :: Int -> Text -> PutScalingPolicyResponse
- putScalingPolicyResponse_alarms :: Lens' PutScalingPolicyResponse (Maybe [Alarm])
- putScalingPolicyResponse_httpStatus :: Lens' PutScalingPolicyResponse Int
- putScalingPolicyResponse_policyARN :: Lens' PutScalingPolicyResponse Text
Creating a Request
data PutScalingPolicy Source #
See: newPutScalingPolicy
smart constructor.
PutScalingPolicy' | |
|
Instances
:: Text | |
-> ServiceNamespace | |
-> Text | |
-> ScalableDimension | |
-> PutScalingPolicy |
Create a value of PutScalingPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyType:PutScalingPolicy'
, putScalingPolicy_policyType
- The policy type. This parameter is required if you are creating a
scaling policy.
The following policy types are supported:
TargetTrackingScaling
—Not supported for Amazon EMR
StepScaling
—Not supported for DynamoDB, Amazon Comprehend, Lambda,
Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
$sel:targetTrackingScalingPolicyConfiguration:PutScalingPolicy'
, putScalingPolicy_targetTrackingScalingPolicyConfiguration
- A target tracking scaling policy. Includes support for predefined or
customized metrics.
This parameter is required if you are creating a policy and the policy
type is TargetTrackingScaling
.
$sel:stepScalingPolicyConfiguration:PutScalingPolicy'
, putScalingPolicy_stepScalingPolicyConfiguration
- A step scaling policy.
This parameter is required if you are creating a policy and the policy
type is StepScaling
.
$sel:policyName:PutScalingPolicy'
, putScalingPolicy_policyName
- The name of the scaling policy.
$sel:serviceNamespace:PutScalingPolicy'
, putScalingPolicy_serviceNamespace
- The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use custom-resource
instead.
$sel:resourceId:PutScalingPolicy'
, putScalingPolicy_resourceId
- 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:service/default/sample-webapp
. - Spot Fleet - 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:instancegroup/j-2EEZNYKUA1NTV/ig-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 table name. Example:table/my-table
. - DynamoDB global secondary index - The resource type is
index
and the unique identifier is the index name. Example:table/my-table/index/my-table-index
. - Aurora DB cluster - The resource type is
cluster
and the unique identifier is the cluster name. Example:cluster:my-db-cluster
. - SageMaker endpoint variant - The resource type is
variant
and the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering
. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValue
from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE
. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE
. - Lambda provisioned concurrency - The resource type is
function
and the unique identifier is the function name with a function version or alias name suffix that is not$LATEST
. Example:function:my-function:prod
orfunction:my-function:1
. - Amazon Keyspaces table - The resource type is
table
and the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable
. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
. - Amazon ElastiCache replication group - The resource type is
replication-group
and the unique identifier is the replication group name. Example:replication-group/mycluster
. - Neptune cluster - The resource type is
cluster
and the unique identifier is the cluster name. Example:cluster:mycluster
.
$sel:scalableDimension:PutScalingPolicy'
, putScalingPolicy_scalableDimension
- 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.elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.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 and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
Request Lenses
putScalingPolicy_policyType :: Lens' PutScalingPolicy (Maybe PolicyType) Source #
The policy type. This parameter is required if you are creating a scaling policy.
The following policy types are supported:
TargetTrackingScaling
—Not supported for Amazon EMR
StepScaling
—Not supported for DynamoDB, Amazon Comprehend, Lambda,
Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
putScalingPolicy_targetTrackingScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration) Source #
A target tracking scaling policy. Includes support for predefined or customized metrics.
This parameter is required if you are creating a policy and the policy
type is TargetTrackingScaling
.
putScalingPolicy_stepScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe StepScalingPolicyConfiguration) Source #
A step scaling policy.
This parameter is required if you are creating a policy and the policy
type is StepScaling
.
putScalingPolicy_policyName :: Lens' PutScalingPolicy Text Source #
The name of the scaling policy.
putScalingPolicy_serviceNamespace :: Lens' PutScalingPolicy ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use custom-resource
instead.
putScalingPolicy_resourceId :: Lens' PutScalingPolicy 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:service/default/sample-webapp
. - Spot Fleet - 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:instancegroup/j-2EEZNYKUA1NTV/ig-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 table name. Example:table/my-table
. - DynamoDB global secondary index - The resource type is
index
and the unique identifier is the index name. Example:table/my-table/index/my-table-index
. - Aurora DB cluster - The resource type is
cluster
and the unique identifier is the cluster name. Example:cluster:my-db-cluster
. - SageMaker endpoint variant - The resource type is
variant
and the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering
. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValue
from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE
. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE
. - Lambda provisioned concurrency - The resource type is
function
and the unique identifier is the function name with a function version or alias name suffix that is not$LATEST
. Example:function:my-function:prod
orfunction:my-function:1
. - Amazon Keyspaces table - The resource type is
table
and the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable
. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
. - Amazon ElastiCache replication group - The resource type is
replication-group
and the unique identifier is the replication group name. Example:replication-group/mycluster
. - Neptune cluster - The resource type is
cluster
and the unique identifier is the cluster name. Example:cluster:mycluster
.
putScalingPolicy_scalableDimension :: Lens' PutScalingPolicy 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.elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.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 and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
Destructuring the Response
data PutScalingPolicyResponse Source #
See: newPutScalingPolicyResponse
smart constructor.
Instances
newPutScalingPolicyResponse Source #
:: Int | |
-> Text | |
-> PutScalingPolicyResponse |
Create a value of PutScalingPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarms:PutScalingPolicyResponse'
, putScalingPolicyResponse_alarms
- The CloudWatch alarms created for the target tracking scaling policy.
$sel:httpStatus:PutScalingPolicyResponse'
, putScalingPolicyResponse_httpStatus
- The response's http status code.
$sel:policyARN:PutScalingPolicyResponse'
, putScalingPolicyResponse_policyARN
- The Amazon Resource Name (ARN) of the resulting scaling policy.
Response Lenses
putScalingPolicyResponse_alarms :: Lens' PutScalingPolicyResponse (Maybe [Alarm]) Source #
The CloudWatch alarms created for the target tracking scaling policy.
putScalingPolicyResponse_httpStatus :: Lens' PutScalingPolicyResponse Int Source #
The response's http status code.
putScalingPolicyResponse_policyARN :: Lens' PutScalingPolicyResponse Text Source #
The Amazon Resource Name (ARN) of the resulting scaling policy.