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 |
Creates or updates a 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 register the scalable target using RegisterScalableTarget
.
To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.
You can view the scaling policies for a service namespace using DescribeScalingPolicies
. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy
.
Synopsis
- putScalingPolicy :: Text -> ServiceNamespace -> Text -> ScalableDimension -> PutScalingPolicy
- data PutScalingPolicy
- pspPolicyType :: Lens' PutScalingPolicy (Maybe PolicyType)
- pspTargetTrackingScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration)
- pspStepScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe StepScalingPolicyConfiguration)
- pspPolicyName :: Lens' PutScalingPolicy Text
- pspServiceNamespace :: Lens' PutScalingPolicy ServiceNamespace
- pspResourceId :: Lens' PutScalingPolicy Text
- pspScalableDimension :: Lens' PutScalingPolicy ScalableDimension
- putScalingPolicyResponse :: Int -> Text -> PutScalingPolicyResponse
- data PutScalingPolicyResponse
- psprsAlarms :: Lens' PutScalingPolicyResponse [Alarm]
- psprsResponseStatus :: Lens' PutScalingPolicyResponse Int
- psprsPolicyARN :: Lens' PutScalingPolicyResponse Text
Creating a Request
:: Text | |
-> ServiceNamespace | |
-> Text | |
-> ScalableDimension | |
-> PutScalingPolicy |
Creates a value of PutScalingPolicy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pspPolicyType
- The policy type. This parameter is required if you are creating a policy. For DynamoDB, onlyTargetTrackingScaling
is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, bothStepScaling
andTargetTrackingScaling
are supported. For any other service, onlyStepScaling
is supported.pspTargetTrackingScalingPolicyConfiguration
- A target tracking policy. This parameter is required if you are creating a policy and the policy type isTargetTrackingScaling
.pspStepScalingPolicyConfiguration
- A step scaling policy. This parameter is required if you are creating a policy and the policy type isStepScaling
.pspPolicyName
- The name of the scaling policy.pspServiceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .pspResourceId
- 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
.pspScalableDimension
- 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.
data PutScalingPolicy Source #
See: putScalingPolicy
smart constructor.
Instances
Request Lenses
pspPolicyType :: Lens' PutScalingPolicy (Maybe PolicyType) Source #
The policy type. This parameter is required if you are creating a policy. For DynamoDB, only TargetTrackingScaling
is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling
and TargetTrackingScaling
are supported. For any other service, only StepScaling
is supported.
pspTargetTrackingScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration) Source #
A target tracking policy. This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling
.
pspStepScalingPolicyConfiguration :: 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
.
pspPolicyName :: Lens' PutScalingPolicy Text Source #
The name of the scaling policy.
pspServiceNamespace :: Lens' PutScalingPolicy ServiceNamespace Source #
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
pspResourceId :: 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: 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
.
pspScalableDimension :: 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. * 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.
Destructuring the Response
putScalingPolicyResponse Source #
Creates a value of PutScalingPolicyResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psprsAlarms
- The CloudWatch alarms created for the target tracking policy.psprsResponseStatus
- -- | The response status code.psprsPolicyARN
- The Amazon Resource Name (ARN) of the resulting scaling policy.
data PutScalingPolicyResponse Source #
See: putScalingPolicyResponse
smart constructor.
Instances
Response Lenses
psprsAlarms :: Lens' PutScalingPolicyResponse [Alarm] Source #
The CloudWatch alarms created for the target tracking policy.
psprsResponseStatus :: Lens' PutScalingPolicyResponse Int Source #
- - | The response status code.
psprsPolicyARN :: Lens' PutScalingPolicyResponse Text Source #
The Amazon Resource Name (ARN) of the resulting scaling policy.