@Generated(value="software.amazon.awssdk:codegen") public class StepScalingPolicyConfiguration extends Object implements StructuredPojo, ToCopyableBuilder<StepScalingPolicyConfiguration.Builder,StepScalingPolicyConfiguration>
Represents a step scaling policy configuration.
Modifier and Type | Class and Description |
---|---|
static interface |
StepScalingPolicyConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
AdjustmentType |
adjustmentType()
The adjustment type, which specifies how the
ScalingAdjustment parameter in a StepAdjustment
is interpreted. |
String |
adjustmentTypeString()
The adjustment type, which specifies how the
ScalingAdjustment parameter in a StepAdjustment
is interpreted. |
static StepScalingPolicyConfiguration.Builder |
builder() |
Integer |
cooldown()
The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling
activities can influence future scaling events.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
MetricAggregationType |
metricAggregationType()
The aggregation type for the CloudWatch metrics.
|
String |
metricAggregationTypeString()
The aggregation type for the CloudWatch metrics.
|
Integer |
minAdjustmentMagnitude()
The minimum number to adjust your scalable dimension as a result of a scaling activity.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public AdjustmentType adjustmentType()
The adjustment type, which specifies how the ScalingAdjustment
parameter in a StepAdjustment
is interpreted.
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 adjustmentTypeString()
.
ScalingAdjustment
parameter in a
StepAdjustment is interpreted.AdjustmentType
public String adjustmentTypeString()
The adjustment type, which specifies how the ScalingAdjustment
parameter in a StepAdjustment
is interpreted.
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 adjustmentTypeString()
.
ScalingAdjustment
parameter in a
StepAdjustment is interpreted.AdjustmentType
public List<StepAdjustment> stepAdjustments()
A set of adjustments that enable you to scale based on the size of the alarm breach.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Integer minAdjustmentMagnitude()
The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is
PercentChangeInCapacity
, the scaling policy changes the scalable dimension of the scalable target by
this amount.
PercentChangeInCapacity
, the scaling policy changes the scalable dimension of the
scalable target by this amount.public Integer cooldown()
The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.
For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.
For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
public MetricAggregationType metricAggregationType()
The aggregation type for the CloudWatch metrics. Valid values are Minimum
, Maximum
, and
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 metricAggregationTypeString()
.
Minimum
,
Maximum
, and Average
.MetricAggregationType
public String metricAggregationTypeString()
The aggregation type for the CloudWatch metrics. Valid values are Minimum
, Maximum
, and
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 metricAggregationTypeString()
.
Minimum
,
Maximum
, and Average
.MetricAggregationType
public StepScalingPolicyConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StepScalingPolicyConfiguration.Builder,StepScalingPolicyConfiguration>
public static StepScalingPolicyConfiguration.Builder builder()
public static Class<? extends StepScalingPolicyConfiguration.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.