com.amazonaws.services.applicationautoscaling.model

Class RegisterScalableTargetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.applicationautoscaling.model.RegisterScalableTargetRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RegisterScalableTargetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterScalableTargetRequest()

Method Summary

Modifier and Type	Method and Description
RegisterScalableTargetRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
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 to associate 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	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 to associate 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.
RegisterScalableTargetRequest	withMaxCapacity(Integer maxCapacity) The maximum value for this scalable target to scale out to in response to scaling activities.
RegisterScalableTargetRequest	withMinCapacity(Integer minCapacity) The minimum value for this scalable target to scale in to in response to scaling activities.
RegisterScalableTargetRequest	withResourceId(String resourceId) The resource type and unique identifier string for the resource to associate with the scalable target.
RegisterScalableTargetRequest	withRoleARN(String roleARN) The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.
RegisterScalableTargetRequest	withScalableDimension(ScalableDimension scalableDimension) The scalable dimension associated with the scalable target.
RegisterScalableTargetRequest	withScalableDimension(String scalableDimension) The scalable dimension associated with the scalable target.
RegisterScalableTargetRequest	withServiceNamespace(ServiceNamespace serviceNamespace) The namespace for the AWS service that the scalable target is associated with.
RegisterScalableTargetRequest	withServiceNamespace(String serviceNamespace) The namespace for the AWS service that the scalable target is associated with.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterScalableTargetRequest

public RegisterScalableTargetRequest()

Method Detail

setServiceNamespace

public void setServiceNamespace(String serviceNamespace)

The namespace for the AWS service that the scalable target is associated with. For Amazon ECS services, the namespace value is ecs. 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 Amazon ECS services, the namespace value is ecs. 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 Amazon ECS services, the namespace value is ecs. 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 Amazon ECS services, the namespace value is ecs. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

See Also:

ServiceNamespace

withServiceNamespace

public RegisterScalableTargetRequest withServiceNamespace(String serviceNamespace)

The namespace for the AWS service that the scalable target is associated with. For Amazon ECS services, the namespace value is ecs. 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 Amazon ECS services, the namespace value is ecs. 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 Amazon ECS services, the namespace value is ecs. 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 Amazon ECS services, the namespace value is ecs. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

See Also:

ServiceNamespace

withServiceNamespace

public RegisterScalableTargetRequest withServiceNamespace(ServiceNamespace serviceNamespace)

The namespace for the AWS service that the scalable target is associated with. For Amazon ECS services, the namespace value is ecs. 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 Amazon ECS services, the namespace value is ecs. 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 to associate 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 to associate 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 to associate 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 to associate 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 RegisterScalableTargetRequest withResourceId(String resourceId)

The resource type and unique identifier string for the resource to associate 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 to associate 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 RegisterScalableTargetRequest 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 RegisterScalableTargetRequest 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. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

Parameters:

minCapacity - The minimum value for this scalable target to scale in to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

getMinCapacity

public Integer getMinCapacity()

The minimum value for this scalable target to scale in to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

Returns:

The minimum value for this scalable target to scale in to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

withMinCapacity

public RegisterScalableTargetRequest withMinCapacity(Integer minCapacity)

The minimum value for this scalable target to scale in to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

Parameters:

minCapacity - The minimum value for this scalable target to scale in to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

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. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

Parameters:

maxCapacity - The maximum value for this scalable target to scale out to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

getMaxCapacity

public Integer getMaxCapacity()

The maximum value for this scalable target to scale out to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

Returns:

The maximum value for this scalable target to scale out to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

withMaxCapacity

public RegisterScalableTargetRequest withMaxCapacity(Integer maxCapacity)

The maximum value for this scalable target to scale out to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

Parameters:

maxCapacity - The maximum value for this scalable target to scale out to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

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. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

Parameters:

roleARN - The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

getRoleARN

public String getRoleARN()

The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

Returns:

The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

withRoleARN

public RegisterScalableTargetRequest withRoleARN(String roleARN)

The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

Parameters:

roleARN - The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

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 RegisterScalableTargetRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()