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)
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)
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:
PredictiveScalingConfiguration	predictiveScalingConfiguration() A predictive scaling policy.
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()
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

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

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

copy

Method Detail

autoScalingGroupName

public final String autoScalingGroupName()

The name of the Auto Scaling group.

Returns:

The name of the Auto Scaling group.

policyName

public final String policyName()

The name of the policy.

Returns:

The name of the policy.

policyType

public final String policyType()

One of the following policy types:

• TargetTrackingScaling

• StepScaling

• SimpleScaling (default)

• PredictiveScaling

Returns:

One of the following policy types:

• TargetTrackingScaling

• StepScaling

• SimpleScaling (default)

• PredictiveScaling

adjustmentType

public final 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 final Integer minAdjustmentStep()

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Returns:

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

minAdjustmentMagnitude

public final 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 final 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 final 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 final 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 final 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 final 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 final 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 final TargetTrackingConfiguration targetTrackingConfiguration()

A target tracking scaling policy. Provides 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. Provides 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 final 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.

predictiveScalingConfiguration

public final PredictiveScalingConfiguration predictiveScalingConfiguration()

A predictive scaling policy. Provides support for only predefined metrics.

Predictive scaling works with CPU utilization, network in/out, and the Application Load Balancer request count.

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

Required if the policy type is PredictiveScaling.

Returns:

A predictive scaling policy. Provides support for only predefined metrics.

Predictive scaling works with CPU utilization, network in/out, and the Application Load Balancer request count.

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

Required if the policy type is PredictiveScaling.

toBuilder

public PutScalingPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

Specified by:

toBuilder in class AutoScalingRequest

builder

public static PutScalingPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutScalingPolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo