@Generated(value="software.amazon.awssdk:codegen") public final class RegisterScalableTargetRequest extends ApplicationAutoScalingRequest implements ToCopyableBuilder<RegisterScalableTargetRequest.Builder,RegisterScalableTargetRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
RegisterScalableTargetRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static RegisterScalableTargetRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
Integer |
maxCapacity()
The maximum value that you plan to scale out to.
|
Integer |
minCapacity()
The minimum value that you plan to scale in to.
|
String |
resourceId()
The identifier of the resource that is associated with the scalable target.
|
String |
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.
|
ScalableDimension |
scalableDimension()
The scalable dimension associated with the scalable target.
|
String |
scalableDimensionAsString()
The scalable dimension associated with the scalable target.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends RegisterScalableTargetRequest.Builder> |
serializableBuilderClass() |
ServiceNamespace |
serviceNamespace()
The namespace of the Amazon Web Services service that provides the resource.
|
String |
serviceNamespaceAsString()
The namespace of the Amazon Web Services service that provides the resource.
|
SuspendedState |
suspendedState()
An embedded object that contains attributes and attribute values that are used to suspend and resume automatic
scaling.
|
Map<String,String> |
tags()
Assigns one or more tags to the scalable target.
|
RegisterScalableTargetRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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.
If the service returns an enum value that is not available in the current SDK version, serviceNamespace
will return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from serviceNamespaceAsString().
custom-resource instead.ServiceNamespacepublic final String serviceNamespaceAsString()
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.
If the service returns an enum value that is not available in the current SDK version, serviceNamespace
will return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from serviceNamespaceAsString().
custom-resource instead.ServiceNamespacepublic final String 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.
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the
resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
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.
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is
the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
public final 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 a 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.
sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
Serverless endpoint.
If the service returns an enum value that is not available in the current SDK version, scalableDimension
will return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from scalableDimensionAsString().
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 a 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.
sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a
SageMaker Serverless endpoint.
ScalableDimensionpublic final String scalableDimensionAsString()
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 a 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.
sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
Serverless endpoint.
If the service returns an enum value that is not available in the current SDK version, scalableDimension
will return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from scalableDimensionAsString().
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 a 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.
sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a
SageMaker Serverless endpoint.
ScalableDimensionpublic final Integer 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 the following resources, the minimum value allowed is 0.
AppStream 2.0 fleets
Aurora DB clusters
ECS services
EMR clusters
Lambda provisioned concurrency
SageMaker endpoint variants
SageMaker Serverless endpoint provisioned concurrency
Spot Fleets
custom resources
It's strongly recommended that you specify a value greater than 0. A value greater than 0 means that data points are continuously reported to CloudWatch that scaling policies can use to scale on a metric like average CPU utilization.
For all other resources, the minimum allowed value depends on the type of resource that you are using. If you provide a value that is lower than what a resource can accept, an error occurs. In which case, the error message will provide the minimum value that the resource can accept.
For the following resources, the minimum value allowed is 0.
AppStream 2.0 fleets
Aurora DB clusters
ECS services
EMR clusters
Lambda provisioned concurrency
SageMaker endpoint variants
SageMaker Serverless endpoint provisioned concurrency
Spot Fleets
custom resources
It's strongly recommended that you specify a value greater than 0. A value greater than 0 means that data points are continuously reported to CloudWatch that scaling policies can use to scale on a metric like average CPU utilization.
For all other resources, the minimum allowed value depends on the type of resource that you are using. If you provide a value that is lower than what a resource can accept, an error occurs. In which case, the error message will provide the minimum value that the resource can accept.
public final Integer 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 might 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.
Although you can specify a large maximum capacity, note that service quotas might 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.
public final String 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.
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.
public final SuspendedState 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.
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.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final Map<String,String> tags()
Assigns one or more tags to the scalable target. Use this parameter to tag the scalable target when it is created. To tag an existing scalable target, use the TagResource operation.
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required. You cannot have more than one tag on a scalable target with the same tag key.
Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required. You cannot have more than one tag on a scalable target with the same tag key.
Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
public RegisterScalableTargetRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<RegisterScalableTargetRequest.Builder,RegisterScalableTargetRequest>toBuilder in class ApplicationAutoScalingRequestpublic static RegisterScalableTargetRequest.Builder builder()
public static Class<? extends RegisterScalableTargetRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.