@Generated(value="software.amazon.awssdk:codegen") public class DescribeScalableTargetsRequest extends ApplicationAutoScalingRequest implements ToCopyableBuilder<DescribeScalableTargetsRequest.Builder,DescribeScalableTargetsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeScalableTargetsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeScalableTargetsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
maxResults()
The maximum number of scalable target results.
|
String |
nextToken()
The token for the next set of results.
|
List<String> |
resourceIds()
The identifier of the resource associated with the scalable target.
|
ScalableDimension |
scalableDimension()
The scalable dimension associated with the scalable target.
|
String |
scalableDimensionString()
The scalable dimension associated with the scalable target.
|
static Class<? extends DescribeScalableTargetsRequest.Builder> |
serializableBuilderClass() |
ServiceNamespace |
serviceNamespace()
The namespace of the AWS service.
|
String |
serviceNamespaceString()
The namespace of the AWS service.
|
DescribeScalableTargetsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public ServiceNamespace serviceNamespace()
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
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 serviceNamespaceString()
.
ServiceNamespace
public String serviceNamespaceString()
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
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 serviceNamespaceString()
.
ServiceNamespace
public List<String> resourceIds()
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
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 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: 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 resource ID. Example:
table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the
resource ID. 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
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 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: 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 resource ID.
Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is
the resource ID. 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
.
public ScalableDimension scalableDimension()
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
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.
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 scalableDimensionString()
.
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.
ScalableDimension
public String scalableDimensionString()
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
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.
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 scalableDimensionString()
.
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.
ScalableDimension
public Integer maxResults()
The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50.
If this parameter is used, the operation returns up to MaxResults
results at a time, along with a
NextToken
value. To get the next set of results, include the NextToken
value in a
subsequent call. If this parameter is not used, the operation returns up to 50 results and a
NextToken
value, if applicable.
If this parameter is used, the operation returns up to MaxResults
results at a time, along
with a NextToken
value. To get the next set of results, include the NextToken
value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a
NextToken
value, if applicable.
public String nextToken()
The token for the next set of results.
public DescribeScalableTargetsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeScalableTargetsRequest.Builder,DescribeScalableTargetsRequest>
toBuilder
in class ApplicationAutoScalingRequest
public static DescribeScalableTargetsRequest.Builder builder()
public static Class<? extends DescribeScalableTargetsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.