com.amazonaws.services.autoscaling.model

Class SetDesiredCapacityRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.SetDesiredCapacityRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SetDesiredCapacityRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the SetDesiredCapacity operation.

Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Auto Scaling? in the Auto Scaling Developer Guide .

See Also:

AmazonAutoScaling.setDesiredCapacity(SetDesiredCapacityRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetDesiredCapacityRequest()

Method Summary

Methods

Modifier and Type	Method and Description
SetDesiredCapacityRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the Auto Scaling group.
Integer	getDesiredCapacity() The number of EC2 instances that should be running in the Auto Scaling group.
Boolean	getHonorCooldown() By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group.
int	hashCode()
Boolean	isHonorCooldown() By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group.
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
void	setDesiredCapacity(Integer desiredCapacity) The number of EC2 instances that should be running in the Auto Scaling group.
void	setHonorCooldown(Boolean honorCooldown) By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetDesiredCapacityRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
SetDesiredCapacityRequest	withDesiredCapacity(Integer desiredCapacity) The number of EC2 instances that should be running in the Auto Scaling group.
SetDesiredCapacityRequest	withHonorCooldown(Boolean honorCooldown) By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

SetDesiredCapacityRequest

public SetDesiredCapacityRequest()

Method Detail

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The name of the Auto Scaling group.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

withAutoScalingGroupName

public SetDesiredCapacityRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

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

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

A reference to this updated object so that method calls can be chained together.

getDesiredCapacity

public Integer getDesiredCapacity()

The number of EC2 instances that should be running in the Auto Scaling group.

Returns:

The number of EC2 instances that should be running in the Auto Scaling group.

setDesiredCapacity

public void setDesiredCapacity(Integer desiredCapacity)

The number of EC2 instances that should be running in the Auto Scaling group.

Parameters:

desiredCapacity - The number of EC2 instances that should be running in the Auto Scaling group.

withDesiredCapacity

public SetDesiredCapacityRequest withDesiredCapacity(Integer desiredCapacity)

The number of EC2 instances that should be running in the Auto Scaling group.

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

Parameters:

desiredCapacity - The number of EC2 instances that should be running in the Auto Scaling group.

Returns:

A reference to this updated object so that method calls can be chained together.

isHonorCooldown

public Boolean isHonorCooldown()

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

Returns:

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

setHonorCooldown

public void setHonorCooldown(Boolean honorCooldown)

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

Parameters:

honorCooldown - By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

withHonorCooldown

public SetDesiredCapacityRequest withHonorCooldown(Boolean honorCooldown)

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

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

Parameters:

honorCooldown - By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

Returns:

A reference to this updated object so that method calls can be chained together.

getHonorCooldown

public Boolean getHonorCooldown()

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

Returns:

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public SetDesiredCapacityRequest 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()