Package software.amazon.awssdk.services.autoscaling.model

Class PutScalingPolicyRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.autoscaling.model.PutScalingPolicyRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutScalingPolicyRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	adjustmentType()	The adjustment type.
String	autoScalingGroupName()	The name or ARN of the group.
static PutScalingPolicyRequest.Builder	builder()
Integer	cooldown()	The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
boolean	equals(Object obj)
Integer	estimatedInstanceWarmup()	The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
int	hashCode()
String	metricAggregationType()	The aggregation type for the CloudWatch metrics.
Integer	minAdjustmentMagnitude()	The minimum number of instances to scale.
Integer	minAdjustmentStep()	Available for backward compatibility.
String	policyName()	The name of the policy.
String	policyType()	The policy type.
Integer	scalingAdjustment()	The amount by which to scale, based on the specified adjustment type.
static Class<? extends PutScalingPolicyRequest.Builder>	serializableBuilderClass()
List<StepAdjustment>	stepAdjustments()	A set of adjustments that enable you to scale based on the size of the alarm breach.
PutScalingPolicyRequest.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 software.amazon.awssdk.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

autoScalingGroupName

public String autoScalingGroupName()

The name or ARN of the group.

Returns:

The name or ARN of the group.

policyName

public String policyName()

The name of the policy.

Returns:

The name of the policy.

policyType

public String policyType()

The policy type. Valid values are SimpleScaling and StepScaling. If the policy type is null, the value is treated as SimpleScaling.

Returns:

The policy type. Valid values are SimpleScaling and StepScaling. If the policy type is null, the value is treated as SimpleScaling.

adjustmentType

public String adjustmentType()

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling User Guide.

Returns:

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling User Guide.

minAdjustmentStep

public Integer minAdjustmentStep()

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Returns:

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

minAdjustmentMagnitude

public 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:

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.

scalingAdjustment

public 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:

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.

cooldown

public 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 User Guide.

Returns:

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 User Guide.

metricAggregationType

public 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:

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.

stepAdjustments

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

estimatedInstanceWarmup

public 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:

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.

toBuilder

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

Returns:

a builder for type T

builder

public static PutScalingPolicyRequest.Builder builder()

serializableBuilderClass

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