RegisterScalableTargetRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.applicationautoscaling.model.ApplicationAutoScalingRequest
    - - software.amazon.awssdk.services.applicationautoscaling.model.RegisterScalableTargetRequest

All Implemented Interfaces:: ToCopyableBuilder<RegisterScalableTargetRequest.Builder,RegisterScalableTargetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RegisterScalableTargetRequest
extends ApplicationAutoScalingRequest
implements ToCopyableBuilder<RegisterScalableTargetRequest.Builder,RegisterScalableTargetRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RegisterScalableTargetRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RegisterScalableTargetRequest.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`	`maxCapacity()` The maximum value to scale to in response to a scale out event.
`Integer`	`minCapacity()` The minimum value to scale to in response to a scale in event.
`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.
`static Class<? extends RegisterScalableTargetRequest.Builder>`	`serializableBuilderClass()`
`ServiceNamespace`	`serviceNamespace()` The namespace of the AWS service.
`String`	`serviceNamespaceAsString()` The namespace of the AWS service.
`RegisterScalableTargetRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

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

- Method Detail
  - serviceNamespace
```
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 serviceNamespaceAsString().
    
    Returns:
    
    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    
    See Also:
    
    ServiceNamespace
  - serviceNamespaceAsString
```
public String serviceNamespaceAsString()
```
    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 serviceNamespaceAsString().
    
    Returns:
    
    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    
    See Also:
    
    ServiceNamespace
  - resourceId
```
public 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 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.
    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 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.
  - scalableDimension
```
public 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.
    - 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 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.
    
    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.
    See Also:
    
    ScalableDimension
  - scalableDimensionAsString
```
public 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.
    - 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 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.
    
    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.
    See Also:
    
    ScalableDimension
  - minCapacity
```
public Integer minCapacity()
```
    The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target and optional if you are updating one.
    
    Returns:
    
    The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target and optional if you are updating one.
  - maxCapacity
```
public Integer maxCapacity()
```
    The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target and optional if you are updating one.
    
    Returns:
    
    The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target and optional if you are updating one.
  - roleARN
```
public String roleARN()
```
    The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
    
    With Amazon RDS resources, permissions are granted using a service-linked role. For more information, see Service-Linked Roles for Application Auto Scaling.
    
    For resources that are not supported using a service-linked role, this parameter is required when you register a scalable target and optional when you update one.
    
    Returns:
    
    The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
    
    With Amazon RDS resources, permissions are granted using a service-linked role. For more information, see Service-Linked Roles for Application Auto Scaling.
    
    For resources that are not supported using a service-linked role, this parameter is required when you register a scalable target and optional when you update one.
  - toBuilder
```
public RegisterScalableTargetRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegisterScalableTargetRequest.Builder,RegisterScalableTargetRequest>
    
    Specified by:
    
    toBuilder in class ApplicationAutoScalingRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static RegisterScalableTargetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterScalableTargetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class RegisterScalableTargetRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField