Network.AWS.ApplicationAutoScaling.RegisterScalableTarget

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 its 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 no longer need a scalable target, you can deregister it using 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 - The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target.
• 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.
• rstRoleARN - Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling . For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
• 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 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 .
• 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. * 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 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

Hashable RegisterScalableTarget

Methods

hashWithSalt :: Int -> RegisterScalableTarget -> Int

hash :: RegisterScalableTarget -> Int

ToJSON RegisterScalableTarget

Methods

toJSON :: RegisterScalableTarget -> Value

toEncoding :: RegisterScalableTarget -> Encoding

toJSONList :: [RegisterScalableTarget] -> Value

toEncodingList :: [RegisterScalableTarget] -> Encoding

NFData RegisterScalableTarget

Methods

rnf :: RegisterScalableTarget -> ()

AWSRequest RegisterScalableTarget

Associated Types

type Rs RegisterScalableTarget :: *

Methods

request :: RegisterScalableTarget -> Request RegisterScalableTarget

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

ToHeaders RegisterScalableTarget

Methods

toHeaders :: RegisterScalableTarget -> [Header]

ToPath RegisterScalableTarget

Methods

toPath :: RegisterScalableTarget -> ByteString

ToQuery RegisterScalableTarget

Methods

toQuery :: RegisterScalableTarget -> QueryString

type Rep RegisterScalableTarget

type Rep RegisterScalableTarget = D1 * (MetaData "RegisterScalableTarget" "Network.AWS.ApplicationAutoScaling.RegisterScalableTarget" "amazonka-application-autoscaling-1.6.0-3HluNhWY524EGALWNNupSJ" 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 to scale to in response to a scale out event. This parameter is required if you are registering a scalable target.

rstMinCapacity :: Lens' RegisterScalableTarget (Maybe Int)

The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target.

rstRoleARN :: Lens' RegisterScalableTarget (Maybe Text)

Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling . For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

rstServiceNamespace :: Lens' RegisterScalableTarget ServiceNamespace

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .

rstResourceId :: Lens' RegisterScalableTarget Text

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 . * 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 .

rstScalableDimension :: Lens' RegisterScalableTarget ScalableDimension

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. * 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

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 - -- | The response status code.

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.6.0-3HluNhWY524EGALWNNupSJ" 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.