public class PutScalingPolicyRequest extends AmazonWebServiceRequest implements java.io.Serializable
Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.
Constructor and Description |
---|
PutScalingPolicyRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAdjustmentType()
The adjustment type.
|
java.lang.String |
getAutoScalingGroupName()
The name or ARN of the group.
|
java.lang.Integer |
getCooldown()
The amount of time, in seconds, after a scaling activity completes and
before the next scaling activity can start.
|
java.lang.Integer |
getEstimatedInstanceWarmup()
The estimated time, in seconds, until a newly launched instance can
contribute to the CloudWatch metrics.
|
java.lang.String |
getMetricAggregationType()
The aggregation type for the CloudWatch metrics.
|
java.lang.Integer |
getMinAdjustmentMagnitude()
The minimum number of instances to scale.
|
java.lang.Integer |
getMinAdjustmentStep()
Available for backward compatibility.
|
java.lang.String |
getPolicyName()
The name of the policy.
|
java.lang.String |
getPolicyType()
The policy type.
|
java.lang.Integer |
getScalingAdjustment()
The amount by which to scale, based on the specified adjustment type.
|
java.util.List<StepAdjustment> |
getStepAdjustments()
A set of adjustments that enable you to scale based on the size of the
alarm breach.
|
int |
hashCode() |
void |
setAdjustmentType(java.lang.String adjustmentType)
The adjustment type.
|
void |
setAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name or ARN of the group.
|
void |
setCooldown(java.lang.Integer cooldown)
The amount of time, in seconds, after a scaling activity completes and
before the next scaling activity can start.
|
void |
setEstimatedInstanceWarmup(java.lang.Integer estimatedInstanceWarmup)
The estimated time, in seconds, until a newly launched instance can
contribute to the CloudWatch metrics.
|
void |
setMetricAggregationType(java.lang.String metricAggregationType)
The aggregation type for the CloudWatch metrics.
|
void |
setMinAdjustmentMagnitude(java.lang.Integer minAdjustmentMagnitude)
The minimum number of instances to scale.
|
void |
setMinAdjustmentStep(java.lang.Integer minAdjustmentStep)
Available for backward compatibility.
|
void |
setPolicyName(java.lang.String policyName)
The name of the policy.
|
void |
setPolicyType(java.lang.String policyType)
The policy type.
|
void |
setScalingAdjustment(java.lang.Integer scalingAdjustment)
The amount by which to scale, based on the specified adjustment type.
|
void |
setStepAdjustments(java.util.Collection<StepAdjustment> stepAdjustments)
A set of adjustments that enable you to scale based on the size of the
alarm breach.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PutScalingPolicyRequest |
withAdjustmentType(java.lang.String adjustmentType)
The adjustment type.
|
PutScalingPolicyRequest |
withAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name or ARN of the group.
|
PutScalingPolicyRequest |
withCooldown(java.lang.Integer cooldown)
The amount of time, in seconds, after a scaling activity completes and
before the next scaling activity can start.
|
PutScalingPolicyRequest |
withEstimatedInstanceWarmup(java.lang.Integer estimatedInstanceWarmup)
The estimated time, in seconds, until a newly launched instance can
contribute to the CloudWatch metrics.
|
PutScalingPolicyRequest |
withMetricAggregationType(java.lang.String metricAggregationType)
The aggregation type for the CloudWatch metrics.
|
PutScalingPolicyRequest |
withMinAdjustmentMagnitude(java.lang.Integer minAdjustmentMagnitude)
The minimum number of instances to scale.
|
PutScalingPolicyRequest |
withMinAdjustmentStep(java.lang.Integer minAdjustmentStep)
Available for backward compatibility.
|
PutScalingPolicyRequest |
withPolicyName(java.lang.String policyName)
The name of the policy.
|
PutScalingPolicyRequest |
withPolicyType(java.lang.String policyType)
The policy type.
|
PutScalingPolicyRequest |
withScalingAdjustment(java.lang.Integer scalingAdjustment)
The amount by which to scale, based on the specified adjustment type.
|
PutScalingPolicyRequest |
withStepAdjustments(java.util.Collection<StepAdjustment> stepAdjustments)
A set of adjustments that enable you to scale based on the size of the
alarm breach.
|
PutScalingPolicyRequest |
withStepAdjustments(StepAdjustment... stepAdjustments)
A set of adjustments that enable you to scale based on the size of the
alarm breach.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getAutoScalingGroupName()
The name or ARN of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
The name or ARN of the group.
public void setAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name or ARN of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name or ARN of the group.
public PutScalingPolicyRequest withAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name or ARN of the group.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name or ARN of the group.
public java.lang.String getPolicyName()
The name of the policy.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
The name of the policy.
public void setPolicyName(java.lang.String policyName)
The name of the policy.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
policyName
- The name of the policy.
public PutScalingPolicyRequest withPolicyName(java.lang.String policyName)
The name of the policy.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
policyName
- The name of the policy.
public java.lang.String getPolicyType()
The policy type. Valid values are SimpleScaling
and
StepScaling
. If the policy type is null, the value is
treated as SimpleScaling
.
Constraints:
Length: 1 - 64
Pattern: [ --�𐀀-\r\n\t]*
The policy type. Valid values are SimpleScaling
and
StepScaling
. If the policy type is null, the value
is treated as SimpleScaling
.
public void setPolicyType(java.lang.String policyType)
The policy type. Valid values are SimpleScaling
and
StepScaling
. If the policy type is null, the value is
treated as SimpleScaling
.
Constraints:
Length: 1 - 64
Pattern: [ --�𐀀-\r\n\t]*
policyType
-
The policy type. Valid values are SimpleScaling
and StepScaling
. If the policy type is null, the
value is treated as SimpleScaling
.
public PutScalingPolicyRequest withPolicyType(java.lang.String policyType)
The policy type. Valid values are SimpleScaling
and
StepScaling
. If the policy type is null, the value is
treated as SimpleScaling
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [ --�𐀀-\r\n\t]*
policyType
-
The policy type. Valid values are SimpleScaling
and StepScaling
. If the policy type is null, the
value is treated as SimpleScaling
.
public java.lang.String getAdjustmentType()
The adjustment type. Valid values are ChangeInCapacity
,
ExactCapacity
, and PercentChangeInCapacity
.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
The adjustment type. Valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
public void setAdjustmentType(java.lang.String adjustmentType)
The adjustment type. Valid values are ChangeInCapacity
,
ExactCapacity
, and PercentChangeInCapacity
.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
adjustmentType
-
The adjustment type. Valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
public PutScalingPolicyRequest withAdjustmentType(java.lang.String adjustmentType)
The adjustment type. Valid values are ChangeInCapacity
,
ExactCapacity
, and PercentChangeInCapacity
.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
adjustmentType
-
The adjustment type. Valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
public java.lang.Integer getMinAdjustmentStep()
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.
public void setMinAdjustmentStep(java.lang.Integer minAdjustmentStep)
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.
minAdjustmentStep
-
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.
public PutScalingPolicyRequest withMinAdjustmentStep(java.lang.Integer minAdjustmentStep)
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.
Returns a reference to this object so that method calls can be chained together.
minAdjustmentStep
-
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.
public java.lang.Integer getMinAdjustmentMagnitude()
The minimum number of instances to scale. If the value of
AdjustmentType
is PercentChangeInCapacity
, the
scaling policy changes the DesiredCapacity
of the Auto
Scaling group by at least this many instances. Otherwise, the error is
ValidationError
.
The minimum number of instances to scale. If the value of
AdjustmentType
is
PercentChangeInCapacity
, the scaling policy changes
the DesiredCapacity
of the Auto Scaling group by at
least this many instances. Otherwise, the error is
ValidationError
.
public void setMinAdjustmentMagnitude(java.lang.Integer minAdjustmentMagnitude)
The minimum number of instances to scale. If the value of
AdjustmentType
is PercentChangeInCapacity
, the
scaling policy changes the DesiredCapacity
of the Auto
Scaling group by at least this many instances. Otherwise, the error is
ValidationError
.
minAdjustmentMagnitude
-
The minimum number of instances to scale. If the value of
AdjustmentType
is
PercentChangeInCapacity
, the scaling policy
changes the DesiredCapacity
of the Auto Scaling
group by at least this many instances. Otherwise, the error is
ValidationError
.
public PutScalingPolicyRequest withMinAdjustmentMagnitude(java.lang.Integer minAdjustmentMagnitude)
The minimum number of instances to scale. If the value of
AdjustmentType
is PercentChangeInCapacity
, the
scaling policy changes the DesiredCapacity
of the Auto
Scaling group by at least this many instances. Otherwise, the error is
ValidationError
.
Returns a reference to this object so that method calls can be chained together.
minAdjustmentMagnitude
-
The minimum number of instances to scale. If the value of
AdjustmentType
is
PercentChangeInCapacity
, the scaling policy
changes the DesiredCapacity
of the Auto Scaling
group by at least this many instances. Otherwise, the error is
ValidationError
.
public java.lang.Integer getScalingAdjustment()
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
This parameter is required if the policy type is
SimpleScaling
and not supported otherwise.
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
This parameter is required if the policy type is
SimpleScaling
and not supported otherwise.
public void setScalingAdjustment(java.lang.Integer scalingAdjustment)
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
This parameter is required if the policy type is
SimpleScaling
and not supported otherwise.
scalingAdjustment
- The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
This parameter is required if the policy type is
SimpleScaling
and not supported otherwise.
public PutScalingPolicyRequest withScalingAdjustment(java.lang.Integer scalingAdjustment)
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
This parameter is required if the policy type is
SimpleScaling
and not supported otherwise.
Returns a reference to this object so that method calls can be chained together.
scalingAdjustment
- The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
This parameter is required if the policy type is
SimpleScaling
and not supported otherwise.
public java.lang.Integer getCooldown()
The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is not supported unless the policy type is
SimpleScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is not supported unless the policy type is
SimpleScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
public void setCooldown(java.lang.Integer cooldown)
The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is not supported unless the policy type is
SimpleScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
cooldown
- The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is not supported unless the policy type is
SimpleScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
public PutScalingPolicyRequest withCooldown(java.lang.Integer cooldown)
The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is not supported unless the policy type is
SimpleScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
Returns a reference to this object so that method calls can be chained together.
cooldown
- The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is not supported unless the policy type is
SimpleScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
public java.lang.String getMetricAggregationType()
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
, Maximum
, and Average
. If
the aggregation type is null, the value is treated as
Average
.
This parameter is not supported if the policy type is
SimpleScaling
.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
, Maximum
, and
Average
. If the aggregation type is null, the value
is treated as Average
.
This parameter is not supported if the policy type is
SimpleScaling
.
public void setMetricAggregationType(java.lang.String metricAggregationType)
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
, Maximum
, and Average
. If
the aggregation type is null, the value is treated as
Average
.
This parameter is not supported if the policy type is
SimpleScaling
.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
metricAggregationType
-
The aggregation type for the CloudWatch metrics. Valid values
are Minimum
, Maximum
, and
Average
. If the aggregation type is null, the
value is treated as Average
.
This parameter is not supported if the policy type is
SimpleScaling
.
public PutScalingPolicyRequest withMetricAggregationType(java.lang.String metricAggregationType)
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
, Maximum
, and Average
. If
the aggregation type is null, the value is treated as
Average
.
This parameter is not supported if the policy type is
SimpleScaling
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
metricAggregationType
-
The aggregation type for the CloudWatch metrics. Valid values
are Minimum
, Maximum
, and
Average
. If the aggregation type is null, the
value is treated as Average
.
This parameter is not supported if the policy type is
SimpleScaling
.
public java.util.List<StepAdjustment> getStepAdjustments()
A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is
StepScaling
and not supported otherwise.
public void setStepAdjustments(java.util.Collection<StepAdjustment> stepAdjustments)
A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
stepAdjustments
- A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is
StepScaling
and not supported otherwise.
public PutScalingPolicyRequest withStepAdjustments(StepAdjustment... stepAdjustments)
A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
Returns a reference to this object so that method calls can be chained together.
stepAdjustments
- A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is
StepScaling
and not supported otherwise.
public PutScalingPolicyRequest withStepAdjustments(java.util.Collection<StepAdjustment> stepAdjustments)
A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
Returns a reference to this object so that method calls can be chained together.
stepAdjustments
- A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is
StepScaling
and not supported otherwise.
public java.lang.Integer getEstimatedInstanceWarmup()
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is not supported if the policy type is
SimpleScaling
.
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is not supported if the policy type is
SimpleScaling
.
public void setEstimatedInstanceWarmup(java.lang.Integer estimatedInstanceWarmup)
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is not supported if the policy type is
SimpleScaling
.
estimatedInstanceWarmup
- The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is not supported if the policy type is
SimpleScaling
.
public PutScalingPolicyRequest withEstimatedInstanceWarmup(java.lang.Integer estimatedInstanceWarmup)
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is not supported if the policy type is
SimpleScaling
.
Returns a reference to this object so that method calls can be chained together.
estimatedInstanceWarmup
- The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is not supported if the policy type is
SimpleScaling
.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.