Network.AWS.ApplicationAutoScaling.RegisterScalableTarget

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.

Creating a Request

registerScalableTarget

Arguments

:: ServiceNamespace

rstServiceNamespace

-> Text

rstResourceId

-> ScalableDimension

rstScalableDimension

-> RegisterScalableTarget

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
• rstMinCapacity
• rstRoleARN
• rstServiceNamespace
• rstResourceId
• rstScalableDimension

data RegisterScalableTarget

See: registerScalableTarget smart constructor.

Instances

Eq RegisterScalableTarget

Methods

(==) :: RegisterScalableTarget -> RegisterScalableTarget -> Bool

(/=) :: RegisterScalableTarget -> RegisterScalableTarget -> Bool

Data RegisterScalableTarget

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterScalableTarget -> c RegisterScalableTarget

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterScalableTarget

toConstr :: RegisterScalableTarget -> Constr

dataTypeOf :: RegisterScalableTarget -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterScalableTarget)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterScalableTarget)

gmapT :: (forall b. Data b => b -> b) -> RegisterScalableTarget -> RegisterScalableTarget

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterScalableTarget -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterScalableTarget -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterScalableTarget -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterScalableTarget -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterScalableTarget -> m RegisterScalableTarget

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterScalableTarget -> m RegisterScalableTarget

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterScalableTarget -> m RegisterScalableTarget

Read RegisterScalableTarget

Methods

readsPrec :: Int -> ReadS RegisterScalableTarget

readList :: ReadS [RegisterScalableTarget]

readPrec :: ReadPrec RegisterScalableTarget

readListPrec :: ReadPrec [RegisterScalableTarget]

Show RegisterScalableTarget

Methods

showsPrec :: Int -> RegisterScalableTarget -> ShowS

show :: RegisterScalableTarget -> String

showList :: [RegisterScalableTarget] -> ShowS

Generic RegisterScalableTarget

Associated Types

type Rep RegisterScalableTarget :: * -> *

Methods

from :: RegisterScalableTarget -> Rep RegisterScalableTarget x

to :: Rep RegisterScalableTarget x -> RegisterScalableTarget

ToJSON RegisterScalableTarget

Methods

toJSON :: RegisterScalableTarget -> Value

toEncoding :: RegisterScalableTarget -> Encoding

Hashable RegisterScalableTarget

Methods

hashWithSalt :: Int -> RegisterScalableTarget -> Int

hash :: RegisterScalableTarget -> Int

NFData RegisterScalableTarget

Methods

rnf :: RegisterScalableTarget -> ()

AWSRequest RegisterScalableTarget

Associated Types

type Rs RegisterScalableTarget :: *

Methods

request :: RegisterScalableTarget -> Request RegisterScalableTarget

response :: MonadResource m => Logger -> Service -> Proxy * RegisterScalableTarget -> ClientResponse -> m (Response RegisterScalableTarget)

ToPath RegisterScalableTarget

Methods

toPath :: RegisterScalableTarget -> ByteString

ToHeaders RegisterScalableTarget

Methods

toHeaders :: RegisterScalableTarget -> [Header]

ToQuery RegisterScalableTarget

Methods

toQuery :: RegisterScalableTarget -> QueryString

type Rep RegisterScalableTarget

type Rep RegisterScalableTarget = D1 (MetaData "RegisterScalableTarget" "Network.AWS.ApplicationAutoScaling.RegisterScalableTarget" "amazonka-application-autoscaling-1.4.3-AN6n0v3PjFC88P4FkDV0Y6" False) (C1 (MetaCons "RegisterScalableTarget'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rstMaxCapacity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_rstMinCapacity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_rstRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_rstServiceNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ServiceNamespace)) ((:*:) (S1 (MetaSel (Just Symbol "_rstResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rstScalableDimension") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ScalableDimension))))))

type Rs RegisterScalableTarget

type Rs RegisterScalableTarget = RegisterScalableTargetResponse

Request Lenses

rstMaxCapacity :: Lens' RegisterScalableTarget (Maybe Int)

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)

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)

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

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

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

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

Arguments

:: Int

rstrsResponseStatus

-> RegisterScalableTargetResponse

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

data RegisterScalableTargetResponse

See: registerScalableTargetResponse smart constructor.

Instances

Eq RegisterScalableTargetResponse

Methods

(==) :: RegisterScalableTargetResponse -> RegisterScalableTargetResponse -> Bool

(/=) :: RegisterScalableTargetResponse -> RegisterScalableTargetResponse -> Bool

Data RegisterScalableTargetResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterScalableTargetResponse -> c RegisterScalableTargetResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterScalableTargetResponse

toConstr :: RegisterScalableTargetResponse -> Constr

dataTypeOf :: RegisterScalableTargetResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterScalableTargetResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterScalableTargetResponse)

gmapT :: (forall b. Data b => b -> b) -> RegisterScalableTargetResponse -> RegisterScalableTargetResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterScalableTargetResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterScalableTargetResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterScalableTargetResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterScalableTargetResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterScalableTargetResponse -> m RegisterScalableTargetResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterScalableTargetResponse -> m RegisterScalableTargetResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterScalableTargetResponse -> m RegisterScalableTargetResponse

Read RegisterScalableTargetResponse

Methods

readsPrec :: Int -> ReadS RegisterScalableTargetResponse

readList :: ReadS [RegisterScalableTargetResponse]

readPrec :: ReadPrec RegisterScalableTargetResponse

readListPrec :: ReadPrec [RegisterScalableTargetResponse]

Show RegisterScalableTargetResponse

Methods

showsPrec :: Int -> RegisterScalableTargetResponse -> ShowS

show :: RegisterScalableTargetResponse -> String

showList :: [RegisterScalableTargetResponse] -> ShowS

Generic RegisterScalableTargetResponse

Associated Types

type Rep RegisterScalableTargetResponse :: * -> *

Methods

from :: RegisterScalableTargetResponse -> Rep RegisterScalableTargetResponse x

to :: Rep RegisterScalableTargetResponse x -> RegisterScalableTargetResponse

NFData RegisterScalableTargetResponse

Methods

rnf :: RegisterScalableTargetResponse -> ()

type Rep RegisterScalableTargetResponse

type Rep RegisterScalableTargetResponse = D1 (MetaData "RegisterScalableTargetResponse" "Network.AWS.ApplicationAutoScaling.RegisterScalableTarget" "amazonka-application-autoscaling-1.4.3-AN6n0v3PjFC88P4FkDV0Y6" True) (C1 (MetaCons "RegisterScalableTargetResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_rstrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

rstrsResponseStatus :: Lens' RegisterScalableTargetResponse Int

The response status code.