com.amazonaws.services.applicationautoscaling.model

Class ScalableTarget

java.lang.Object

com.amazonaws.services.applicationautoscaling.model.ScalableTarget

All Implemented Interfaces:

Serializable, Cloneable

public class ScalableTarget
extends Object
implements Serializable, Cloneable

An object representing a scalable target.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScalableTarget()

Method Summary

Modifier and Type	Method and Description
ScalableTarget	clone()
boolean	equals(Object obj)
Date	getCreationTime() The Unix timestamp for when the scalable target was created.
Integer	getMaxCapacity() The maximum value for this scalable target to scale out to in response to scaling activities.
Integer	getMinCapacity() The minimum value for this scalable target to scale in to in response to scaling activities.
String	getResourceId() The resource type and unique identifier string for the resource associated with the scalable target.
String	getRoleARN() The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.
String	getScalableDimension() The scalable dimension associated with the scalable target.
String	getServiceNamespace() The namespace for the AWS service that the scalable target is associated with.
int	hashCode()
void	setCreationTime(Date creationTime) The Unix timestamp for when the scalable target was created.
void	setMaxCapacity(Integer maxCapacity) The maximum value for this scalable target to scale out to in response to scaling activities.
void	setMinCapacity(Integer minCapacity) The minimum value for this scalable target to scale in to in response to scaling activities.
void	setResourceId(String resourceId) The resource type and unique identifier string for the resource associated with the scalable target.
void	setRoleARN(String roleARN) The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.
void	setScalableDimension(ScalableDimension scalableDimension) The scalable dimension associated with the scalable target.
void	setScalableDimension(String scalableDimension) The scalable dimension associated with the scalable target.
void	setServiceNamespace(ServiceNamespace serviceNamespace) The namespace for the AWS service that the scalable target is associated with.
void	setServiceNamespace(String serviceNamespace) The namespace for the AWS service that the scalable target is associated with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ScalableTarget	withCreationTime(Date creationTime) The Unix timestamp for when the scalable target was created.
ScalableTarget	withMaxCapacity(Integer maxCapacity) The maximum value for this scalable target to scale out to in response to scaling activities.
ScalableTarget	withMinCapacity(Integer minCapacity) The minimum value for this scalable target to scale in to in response to scaling activities.
ScalableTarget	withResourceId(String resourceId) The resource type and unique identifier string for the resource associated with the scalable target.
ScalableTarget	withRoleARN(String roleARN) The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.
ScalableTarget	withScalableDimension(ScalableDimension scalableDimension) The scalable dimension associated with the scalable target.
ScalableTarget	withScalableDimension(String scalableDimension) The scalable dimension associated with the scalable target.
ScalableTarget	withServiceNamespace(ServiceNamespace serviceNamespace) The namespace for the AWS service that the scalable target is associated with.
ScalableTarget	withServiceNamespace(String serviceNamespace) The namespace for the AWS service that the scalable target is associated with.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScalableTarget

public ScalableTarget()

Method Detail

setServiceNamespace

public void setServiceNamespace(String serviceNamespace)

The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

See Also:

ServiceNamespace

getServiceNamespace

public String getServiceNamespace()

The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

See Also:

ServiceNamespace

withServiceNamespace

public ScalableTarget withServiceNamespace(String serviceNamespace)

The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace

setServiceNamespace

public void setServiceNamespace(ServiceNamespace serviceNamespace)

The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

See Also:

ServiceNamespace

withServiceNamespace

public ScalableTarget withServiceNamespace(ServiceNamespace serviceNamespace)

The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace

setResourceId

public void setResourceId(String resourceId)

The resource type and unique identifier string for the resource associated with the scalable target. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

Parameters:

resourceId - The resource type and unique identifier string for the resource associated with the scalable target. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

getResourceId

public String getResourceId()

The resource type and unique identifier string for the resource associated with the scalable target. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

Returns:

The resource type and unique identifier string for the resource associated with the scalable target. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

withResourceId

public ScalableTarget withResourceId(String resourceId)

The resource type and unique identifier string for the resource associated with the scalable target. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

Parameters:

resourceId - The resource type and unique identifier string for the resource associated with the scalable target. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScalableDimension

public void setScalableDimension(String scalableDimension)

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

Parameters:

scalableDimension - The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

See Also:

ScalableDimension

getScalableDimension

public String getScalableDimension()

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

Returns:

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

See Also:

ScalableDimension

withScalableDimension

public ScalableTarget withScalableDimension(String scalableDimension)

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

Parameters:

scalableDimension - The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension

setScalableDimension

public void setScalableDimension(ScalableDimension scalableDimension)

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

Parameters:

scalableDimension - The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

See Also:

ScalableDimension

withScalableDimension

public ScalableTarget withScalableDimension(ScalableDimension scalableDimension)

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

Parameters:

scalableDimension - The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension

setMinCapacity

public void setMinCapacity(Integer minCapacity)

The minimum value for this scalable target to scale in to in response to scaling activities.

Parameters:

minCapacity - The minimum value for this scalable target to scale in to in response to scaling activities.

getMinCapacity

public Integer getMinCapacity()

The minimum value for this scalable target to scale in to in response to scaling activities.

Returns:

The minimum value for this scalable target to scale in to in response to scaling activities.

withMinCapacity

public ScalableTarget withMinCapacity(Integer minCapacity)

The minimum value for this scalable target to scale in to in response to scaling activities.

Parameters:

minCapacity - The minimum value for this scalable target to scale in to in response to scaling activities.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxCapacity

public void setMaxCapacity(Integer maxCapacity)

The maximum value for this scalable target to scale out to in response to scaling activities.

Parameters:

maxCapacity - The maximum value for this scalable target to scale out to in response to scaling activities.

getMaxCapacity

public Integer getMaxCapacity()

The maximum value for this scalable target to scale out to in response to scaling activities.

Returns:

The maximum value for this scalable target to scale out to in response to scaling activities.

withMaxCapacity

public ScalableTarget withMaxCapacity(Integer maxCapacity)

The maximum value for this scalable target to scale out to in response to scaling activities.

Parameters:

maxCapacity - The maximum value for this scalable target to scale out to in response to scaling activities.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRoleARN

public void setRoleARN(String roleARN)

The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.

Parameters:

roleARN - The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.

getRoleARN

public String getRoleARN()

The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.

Returns:

The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.

withRoleARN

public ScalableTarget withRoleARN(String roleARN)

The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.

Parameters:

roleARN - The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCreationTime

public void setCreationTime(Date creationTime)

The Unix timestamp for when the scalable target was created.

Parameters:

creationTime - The Unix timestamp for when the scalable target was created.

getCreationTime

public Date getCreationTime()

The Unix timestamp for when the scalable target was created.

Returns:

The Unix timestamp for when the scalable target was created.

withCreationTime

public ScalableTarget withCreationTime(Date creationTime)

The Unix timestamp for when the scalable target was created.

Parameters:

creationTime - The Unix timestamp for when the scalable target was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ScalableTarget clone()

Overrides:

clone in class Object