Copyright	(c) 2013-2021 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

Amazonka.ApplicationAutoScaling.RegisterScalableTarget

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers or updates a scalable target.

A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.

When you register a new scalable target, you must specify values for minimum and maximum capacity. Current capacity will be adjusted within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of this range.

After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.

To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.

If you call the RegisterScalableTarget API to update an existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it is below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it within these bounds, even if you don't include the MinCapacity or MaxCapacity request parameters.

Synopsis

Creating a Request

data RegisterScalableTarget Source #

See: newRegisterScalableTarget smart constructor.

Constructors

RegisterScalableTarget'

Fields

suspendedState :: Maybe SuspendedState
An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
Suspension Outcomes
- For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
- For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
- For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide.
maxCapacity :: Maybe Int
The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference.
minCapacity :: Maybe Int
The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target.
For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
roleARN :: Maybe Text
This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see Application Auto Scaling IAM roles.
serviceNamespace :: ServiceNamespace
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
resourceId :: Text
The identifier of the resource that is 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: service/default/sample-webapp.
- Spot Fleet - 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: instancegroup/j-2EEZNYKUA1NTV/ig-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 table name. Example: table/my-table.
- DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
- Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
- SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
- Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
- Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
- Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
- Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
- Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
- Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
- Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
- Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
scalableDimension :: 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.
- elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
- ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
- 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 and Aurora PostgreSQL-compatible edition.
- sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.
- custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
- comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
- comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
- lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
- cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
- cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
- kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
- elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
- elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
- neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

Instances

Instances details

Eq RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods (==) :: RegisterScalableTarget -> RegisterScalableTarget -> Bool # (/=) :: RegisterScalableTarget -> RegisterScalableTarget -> Bool #
Read RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods readsPrec :: Int -> ReadS RegisterScalableTarget # readList :: ReadS [RegisterScalableTarget] # readPrec :: ReadPrec RegisterScalableTarget # readListPrec :: ReadPrec [RegisterScalableTarget] #
Show RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods showsPrec :: Int -> RegisterScalableTarget -> ShowS # show :: RegisterScalableTarget -> String # showList :: [RegisterScalableTarget] -> ShowS #
Generic RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Associated Types type Rep RegisterScalableTarget :: Type -> Type # Methods from :: RegisterScalableTarget -> Rep RegisterScalableTarget x # to :: Rep RegisterScalableTarget x -> RegisterScalableTarget #
NFData RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods rnf :: RegisterScalableTarget -> () #
Hashable RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods hashWithSalt :: Int -> RegisterScalableTarget -> Int # hash :: RegisterScalableTarget -> Int #
ToJSON RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods toJSON :: RegisterScalableTarget -> Value # toEncoding :: RegisterScalableTarget -> Encoding # toJSONList :: [RegisterScalableTarget] -> Value # toEncodingList :: [RegisterScalableTarget] -> Encoding #
AWSRequest RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Associated Types type AWSResponse RegisterScalableTarget # Methods request :: RegisterScalableTarget -> Request RegisterScalableTarget # response :: MonadResource m => Logger -> Service -> Proxy RegisterScalableTarget -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterScalableTarget))) #
ToHeaders RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods toHeaders :: RegisterScalableTarget -> [Header] #
ToPath RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods toPath :: RegisterScalableTarget -> ByteString #
ToQuery RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods toQuery :: RegisterScalableTarget -> QueryString #
type Rep RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget type Rep RegisterScalableTarget = D1 ('MetaData "RegisterScalableTarget" "Amazonka.ApplicationAutoScaling.RegisterScalableTarget" "libZSservicesZSamazonka-application-autoscalingZSamazonka-application-autoscaling" 'False) (C1 ('MetaCons "RegisterScalableTarget'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "suspendedState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuspendedState)) :: (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "minCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceNamespace)) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "scalableDimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScalableDimension)))))
type AWSResponse RegisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget type AWSResponse RegisterScalableTarget = RegisterScalableTargetResponse

newRegisterScalableTarget Source #

Arguments

:: ServiceNamespace	`$sel:serviceNamespace:RegisterScalableTarget'`
-> Text	`$sel:resourceId:RegisterScalableTarget'`
-> ScalableDimension	`$sel:scalableDimension:RegisterScalableTarget'`
-> RegisterScalableTarget

Create a value of RegisterScalableTarget with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:suspendedState:RegisterScalableTarget', registerScalableTarget_suspendedState - An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.

Suspension Outcomes

For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.

For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide.

$sel:maxCapacity:RegisterScalableTarget', registerScalableTarget_maxCapacity - The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target.

Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference.

$sel:minCapacity:RegisterScalableTarget', registerScalableTarget_minCapacity - The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target.

For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.

$sel:roleARN:RegisterScalableTarget', registerScalableTarget_roleARN - This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see Application Auto Scaling IAM roles.

$sel:serviceNamespace:RegisterScalableTarget', registerScalableTarget_serviceNamespace - The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

$sel:resourceId:RegisterScalableTarget', registerScalableTarget_resourceId - The identifier of the resource that is 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: service/default/sample-webapp.
Spot Fleet - 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: instancegroup/j-2EEZNYKUA1NTV/ig-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 table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

$sel:scalableDimension:RegisterScalableTarget', 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.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
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 and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

Request Lenses

registerScalableTarget_suspendedState :: Lens' RegisterScalableTarget (Maybe SuspendedState) Source #

An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.

Suspension Outcomes

For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.

For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide.

registerScalableTarget_maxCapacity :: Lens' RegisterScalableTarget (Maybe Int) Source #

The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target.

Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference.

registerScalableTarget_minCapacity :: Lens' RegisterScalableTarget (Maybe Int) Source #

The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target.

For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.

registerScalableTarget_roleARN :: Lens' RegisterScalableTarget (Maybe Text) Source #

This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see Application Auto Scaling IAM roles.

registerScalableTarget_serviceNamespace :: Lens' RegisterScalableTarget ServiceNamespace Source #

The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

registerScalableTarget_resourceId :: Lens' RegisterScalableTarget Text Source #

The identifier of the resource that is 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: service/default/sample-webapp.
Spot Fleet - 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: instancegroup/j-2EEZNYKUA1NTV/ig-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 table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

registerScalableTarget_scalableDimension :: 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.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
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 and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

Destructuring the Response

data RegisterScalableTargetResponse Source #

See: newRegisterScalableTargetResponse smart constructor.

Constructors

RegisterScalableTargetResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq RegisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods (==) :: RegisterScalableTargetResponse -> RegisterScalableTargetResponse -> Bool # (/=) :: RegisterScalableTargetResponse -> RegisterScalableTargetResponse -> Bool #
Read RegisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods readsPrec :: Int -> ReadS RegisterScalableTargetResponse # readList :: ReadS [RegisterScalableTargetResponse] # readPrec :: ReadPrec RegisterScalableTargetResponse # readListPrec :: ReadPrec [RegisterScalableTargetResponse] #
Show RegisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods showsPrec :: Int -> RegisterScalableTargetResponse -> ShowS # show :: RegisterScalableTargetResponse -> String # showList :: [RegisterScalableTargetResponse] -> ShowS #
Generic RegisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Associated Types type Rep RegisterScalableTargetResponse :: Type -> Type # Methods from :: RegisterScalableTargetResponse -> Rep RegisterScalableTargetResponse x # to :: Rep RegisterScalableTargetResponse x -> RegisterScalableTargetResponse #
NFData RegisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget Methods rnf :: RegisterScalableTargetResponse -> () #
type Rep RegisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.RegisterScalableTarget type Rep RegisterScalableTargetResponse = D1 ('MetaData "RegisterScalableTargetResponse" "Amazonka.ApplicationAutoScaling.RegisterScalableTarget" "libZSservicesZSamazonka-application-autoscalingZSamazonka-application-autoscaling" 'False) (C1 ('MetaCons "RegisterScalableTargetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterScalableTargetResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterScalableTargetResponse'`
-> RegisterScalableTargetResponse

Create a value of RegisterScalableTargetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:RegisterScalableTargetResponse', registerScalableTargetResponse_httpStatus - The response's http status code.

Response Lenses

registerScalableTargetResponse_httpStatus :: Lens' RegisterScalableTargetResponse Int Source #

The response's http status code.