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 can be scaled up or down with Application Auto Scaling. After you have registered a scalable target, you can use this command to update the minimum and maximum values for your scalable dimension.
At this time, Application Auto Scaling only supports scaling Amazon ECS services.
After you register a scalable target with Application Auto Scaling, you can create and apply scaling policies to it with PutScalingPolicy. You can view the existing scaling policies for a service namespace with DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it with 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:
data RegisterScalableTarget Source #
See: registerScalableTarget
smart constructor.
Request Lenses
rstMaxCapacity :: Lens' RegisterScalableTarget (Maybe Int) Source #
The maximum value for this scalable target to scale out to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.
rstMinCapacity :: Lens' RegisterScalableTarget (Maybe Int) Source #
The minimum value for this scalable target to scale in to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.
rstRoleARN :: Lens' RegisterScalableTarget (Maybe Text) Source #
The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.
rstServiceNamespace :: Lens' RegisterScalableTarget ServiceNamespace Source #
The namespace for the AWS service that the scalable target is associated with. For Amazon ECS services, the namespace value is ecs
. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
rstResourceId :: Lens' RegisterScalableTarget Text Source #
The unique identifier string for the resource to associate with the scalable target. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as 'service\/default\/sample-webapp'.
rstScalableDimension :: Lens' RegisterScalableTarget ScalableDimension Source #
The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as 'ecs:service:DesiredCount' for the desired task count of an Amazon ECS service.
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:
data RegisterScalableTargetResponse Source #
See: registerScalableTargetResponse
smart constructor.
Response Lenses
rstrsResponseStatus :: Lens' RegisterScalableTargetResponse Int Source #
The response status code.