Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension.
After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy
. You can view the scaling policies for a service namespace using DescribeScalableTargets
. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget
.
- registerScalableTarget :: ServiceNamespace -> Text -> ScalableDimension -> RegisterScalableTarget
- data RegisterScalableTarget
- rstMaxCapacity :: Lens' RegisterScalableTarget (Maybe Int)
- rstMinCapacity :: Lens' RegisterScalableTarget (Maybe Int)
- rstRoleARN :: Lens' RegisterScalableTarget (Maybe Text)
- rstServiceNamespace :: Lens' RegisterScalableTarget ServiceNamespace
- rstResourceId :: Lens' RegisterScalableTarget Text
- rstScalableDimension :: Lens' RegisterScalableTarget ScalableDimension
- registerScalableTargetResponse :: Int -> RegisterScalableTargetResponse
- data RegisterScalableTargetResponse
- rstrsResponseStatus :: Lens' RegisterScalableTargetResponse Int
Creating a Request
registerScalableTarget Source #
Creates a value of RegisterScalableTarget
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rstMaxCapacity
- The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target and optional if you are updating one.rstMinCapacity
- The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target and optional if you are updating one.rstRoleARN
- The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. This parameter is required when you register a scalable target and optional when you update one.rstServiceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .rstResourceId
- 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
.rstScalableDimension
- 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.
data RegisterScalableTarget Source #
See: registerScalableTarget
smart constructor.
Request Lenses
rstMaxCapacity :: Lens' RegisterScalableTarget (Maybe Int) Source #
The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target and optional if you are updating one.
rstMinCapacity :: Lens' RegisterScalableTarget (Maybe Int) Source #
The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target and optional if you are updating one.
rstRoleARN :: Lens' RegisterScalableTarget (Maybe Text) Source #
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. This parameter is required when you register a scalable target and optional when you update one.
rstServiceNamespace :: Lens' RegisterScalableTarget ServiceNamespace Source #
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
rstResourceId :: Lens' RegisterScalableTarget 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
.
rstScalableDimension :: Lens' RegisterScalableTarget 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.
Destructuring the Response
registerScalableTargetResponse Source #
Creates a value of RegisterScalableTargetResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rstrsResponseStatus
- -- | The response status code.
data RegisterScalableTargetResponse Source #
See: registerScalableTargetResponse
smart constructor.
Response Lenses
rstrsResponseStatus :: Lens' RegisterScalableTargetResponse Int Source #
- - | The response status code.