ScalableTarget (AWS Java SDK :: Services :: AWS Application Auto Scaling 2.20.103 API)

java.lang.Object
- software.amazon.awssdk.services.applicationautoscaling.model.ScalableTarget

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ScalableTarget.Builder,ScalableTarget>

@Generated(value="software.amazon.awssdk:codegen")
public final class ScalableTarget
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScalableTarget.Builder,ScalableTarget>

Represents a scalable target.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ScalableTarget.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ScalableTarget.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ScalableTarget.Builder`	`builder()`
`Instant`	`creationTime()` The Unix timestamp for when the scalable target was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxCapacity()` The maximum value to scale to in response to a scale-out activity.
`Integer`	`minCapacity()` The minimum value to scale to in response to a scale-in activity.
`String`	`resourceId()` The identifier of the resource associated with the scalable target.
`String`	`roleARN()` 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.
`String`	`scalableTargetARN()` The ARN of the scalable target.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ScalableTarget.Builder>`	`serializableBuilderClass()`
`ServiceNamespace`	`serviceNamespace()` The namespace of the Amazon Web Services service that provides the resource, or a `custom-resource`.
`String`	`serviceNamespaceAsString()` The namespace of the Amazon Web Services service that provides the resource, or a `custom-resource`.
`SuspendedState`	`suspendedState()` Specifies whether the scaling activities for a scalable target are in a suspended state.
`ScalableTarget.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - serviceNamespace
```
public final ServiceNamespace serviceNamespace()
```
    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
    
    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().
    
    Returns:
    
    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
    
    See Also:
    
    ServiceNamespace
  - serviceNamespaceAsString
```
public final String serviceNamespaceAsString()
```
    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
    
    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().
    
    Returns:
    
    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
    
    See Also:
    
    ServiceNamespace
  - resourceId
```
public final String resourceId()
```
    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: 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.
    Returns:
    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: 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.
  - scalableDimension
```
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().
    Returns:
    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.
    See Also:
    
    ScalableDimension
  - scalableDimensionAsString
```
public 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().
    Returns:
    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.
    See Also:
    
    ScalableDimension
  - minCapacity
```
public final Integer minCapacity()
```
    The minimum value to scale to in response to a scale-in activity.
    
    Returns:
    
    The minimum value to scale to in response to a scale-in activity.
  - maxCapacity
```
public final Integer maxCapacity()
```
    The maximum value to scale to in response to a scale-out activity.
    
    Returns:
    
    The maximum value to scale to in response to a scale-out activity.
  - roleARN
```
public final String roleARN()
```
    The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
    
    Returns:
    
    The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
  - creationTime
```
public final Instant creationTime()
```
    The Unix timestamp for when the scalable target was created.
    
    Returns:
    
    The Unix timestamp for when the scalable target was created.
  - suspendedState
```
public final SuspendedState suspendedState()
```
    Specifies whether the scaling activities for a scalable target are in a suspended state.
    
    Returns:
    
    Specifies whether the scaling activities for a scalable target are in a suspended state.
  - scalableTargetARN
```
public final String scalableTargetARN()
```
    The ARN of the scalable target.
    
    Returns:
    
    The ARN of the scalable target.
  - toBuilder
```
public ScalableTarget.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScalableTarget.Builder,ScalableTarget>
  - builder
```
public static ScalableTarget.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScalableTarget.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ScalableTarget

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

serviceNamespace

serviceNamespaceAsString

resourceId

scalableDimension

scalableDimensionAsString

minCapacity

maxCapacity

roleARN

creationTime

suspendedState

scalableTargetARN

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields