software.amazon.awssdk.services.applicationautoscaling.model

Class StepScalingPolicyConfiguration

java.lang.Object

software.amazon.awssdk.services.applicationautoscaling.model.StepScalingPolicyConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StepScalingPolicyConfiguration.Builder,StepScalingPolicyConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class StepScalingPolicyConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StepScalingPolicyConfiguration.Builder,StepScalingPolicyConfiguration>

Represents a step scaling policy configuration to use with Application Auto Scaling.

For more information, see Step scaling policies in the Application Auto Scaling User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StepScalingPolicyConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
AdjustmentType	adjustmentType() Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage).
String	adjustmentTypeAsString() Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage).
static StepScalingPolicyConfiguration.Builder	builder()
Integer	cooldown() The amount of time, in seconds, to wait for a previous scaling activity to take effect.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStepAdjustments() For responses, this returns true if the service returned a value for the StepAdjustments property.
MetricAggregationType	metricAggregationType() The aggregation type for the CloudWatch metrics.
String	metricAggregationTypeAsString() The aggregation type for the CloudWatch metrics.
Integer	minAdjustmentMagnitude() The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
List<SdkField<?>>	sdkFields()
static Class<? extends StepScalingPolicyConfiguration.Builder>	serializableBuilderClass()
List<StepAdjustment>	stepAdjustments() A set of adjustments that enable you to scale based on the size of the alarm breach.
StepScalingPolicyConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

adjustmentType

public final AdjustmentType adjustmentType()

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

AdjustmentType is required if you are adding a new step scaling policy configuration.

If the service returns an enum value that is not available in the current SDK version, adjustmentType will return AdjustmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adjustmentTypeAsString().

Returns:

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

AdjustmentType is required if you are adding a new step scaling policy configuration.

See Also:

AdjustmentType

adjustmentTypeAsString

public final String adjustmentTypeAsString()

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

AdjustmentType is required if you are adding a new step scaling policy configuration.

If the service returns an enum value that is not available in the current SDK version, adjustmentType will return AdjustmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adjustmentTypeAsString().

Returns:

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

AdjustmentType is required if you are adding a new step scaling policy configuration.

See Also:

AdjustmentType

hasStepAdjustments

public final boolean hasStepAdjustments()

For responses, this returns true if the service returned a value for the StepAdjustments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

stepAdjustments

public final List<StepAdjustment> stepAdjustments()

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

At least one step adjustment is required if you are adding a new step scaling policy configuration.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStepAdjustments() method.

Returns:

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

At least one step adjustment is required if you are adding a new step scaling policy configuration.

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 Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

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 Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

cooldown

public final Integer cooldown()

The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

Returns:

The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

metricAggregationType

public final MetricAggregationType 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.

If the service returns an enum value that is not available in the current SDK version, metricAggregationType will return MetricAggregationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricAggregationTypeAsString().

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.

See Also:

MetricAggregationType

metricAggregationTypeAsString

public final String metricAggregationTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, metricAggregationType will return MetricAggregationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricAggregationTypeAsString().

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.

See Also:

MetricAggregationType

toBuilder

public StepScalingPolicyConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StepScalingPolicyConfiguration.Builder,StepScalingPolicyConfiguration>

builder

public static StepScalingPolicyConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo