software.amazon.awssdk.services.autoscaling.model

Class PutScalingPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutScalingPolicyRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	adjustmentType() Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
String	autoScalingGroupName() The name of the Auto Scaling group.
static PutScalingPolicyRequest.Builder	builder()
Integer	cooldown() The duration of the policy's cooldown period, in seconds.
Boolean	enabled() Indicates whether the scaling policy is enabled or disabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Integer	estimatedInstanceWarmup() The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasStepAdjustments() Returns true if the StepAdjustments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	metricAggregationType() The aggregation type for the CloudWatch metrics.
Integer	minAdjustmentMagnitude() The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
Integer	minAdjustmentStep() Available for backward compatibility.
String	policyName() The name of the policy.
String	policyType() One of the following policy types:
Integer	scalingAdjustment() The amount by which to scale, based on the specified adjustment type.
List<SdkField<?>>	sdkFields()
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.
TargetTrackingConfiguration	targetTrackingConfiguration() A target tracking scaling policy.
PutScalingPolicyRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

autoScalingGroupName

public String autoScalingGroupName()

The name of the Auto Scaling group.

Returns:

The name of the Auto Scaling group.

policyName

public String policyName()

The name of the policy.

Returns:

The name of the policy.

policyType

public String policyType()

One of the following policy types:

• TargetTrackingScaling

• StepScaling

• SimpleScaling (default)

Returns:

One of the following policy types:

• TargetTrackingScaling

• StepScaling

• SimpleScaling (default)

adjustmentType

public String adjustmentType()

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.

Returns:

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 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 value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

Returns:

The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

cooldown

public Integer cooldown()

The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.

Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Returns:

The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.

Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

metricAggregationType

public String metricAggregationType()

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Returns:

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

hasStepAdjustments

public boolean hasStepAdjustments()

Returns true if the StepAdjustments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

stepAdjustments

public List<StepAdjustment> stepAdjustments()

A set of adjustments that enable you to scale based on the size of the alarm breach.

Required if the policy type is StepScaling. (Not used with any other policy type.)

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasStepAdjustments() to see if a value was sent in this field.

Returns:

A set of adjustments that enable you to scale based on the size of the alarm breach.

Required if the policy type is StepScaling. (Not used with any other policy type.)

estimatedInstanceWarmup

public Integer estimatedInstanceWarmup()

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.

Valid only if the policy type is TargetTrackingScaling or StepScaling.

Returns:

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.

Valid only if the policy type is TargetTrackingScaling or StepScaling.

targetTrackingConfiguration

public TargetTrackingConfiguration targetTrackingConfiguration()

A target tracking scaling policy. Includes support for predefined or customized metrics.

The following predefined metrics are available:

• ASGAverageCPUUtilization

• ASGAverageNetworkIn

• ASGAverageNetworkOut

• ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel parameter with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

Returns:

A target tracking scaling policy. Includes support for predefined or customized metrics.

The following predefined metrics are available:

• ASGAverageCPUUtilization

• ASGAverageNetworkIn

• ASGAverageNetworkOut

• ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel parameter with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

enabled

public Boolean enabled()

Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a Scaling Policy for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Returns:

Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a Scaling Policy for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

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>

Specified by:

toBuilder in class AutoScalingRequest

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 AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.