Package software.amazon.awssdk.services.applicationautoscaling.model

Class ScalableTarget

java.lang.Object

software.amazon.awssdk.services.applicationautoscaling.model.ScalableTarget

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ScalableTarget.Builder,ScalableTarget>

@Generated("software.amazon.awssdk:codegen")
public class ScalableTarget
extends Object
implements StructuredPojo, ToCopyableBuilder<ScalableTarget.Builder,ScalableTarget>

Represents a scalable target.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScalableTarget.Builder

Method Summary

Modifier and Type	Method	Description
static ScalableTarget.Builder	builder()
Date	creationTime()	The Unix timestamp for when the scalable target was created.
boolean	equals(Object obj)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
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.
String	scalableDimension()	The scalable dimension associated with the scalable target.
static Class<? extends ScalableTarget.Builder>	serializableBuilderClass()
String	serviceNamespace()	The namespace of the AWS service.
ScalableTarget.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

serviceNamespace

public String serviceNamespace()

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

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.

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.

scalableDimension

public String 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.

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.

See Also:

ScalableDimension

minCapacity

public Integer minCapacity()

The minimum value to scale to in response to a scale in event.

Returns:

The minimum value to scale to in response to a scale in event.

maxCapacity

public Integer maxCapacity()

The maximum value to scale to in response to a scale out event.

Returns:

The maximum value to scale to in response to a scale out event.

roleARN

public 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 Date creationTime()

The Unix timestamp for when the scalable target was created.

Returns:

The Unix timestamp for when the scalable target was created.

toBuilder

public ScalableTarget.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<ScalableTarget.Builder,ScalableTarget>

Returns:

a builder for type T

builder

public static ScalableTarget.Builder builder()

serializableBuilderClass

public static Class<? extends ScalableTarget.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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.