Class StepScalingPolicyConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AdjustmentType
Specifies how theScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage).final String
Specifies how theScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage).builder()
final Integer
cooldown()
The amount of time, in seconds, to wait for a previous scaling activity to take effect.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StepAdjustments property.final MetricAggregationType
The aggregation type for the CloudWatch metrics.final String
The aggregation type for the CloudWatch metrics.final Integer
The minimum value to scale by when the adjustment type isPercentChangeInCapacity
.static Class
<? extends StepScalingPolicyConfiguration.Builder> final List
<StepAdjustment> A set of adjustments that enable you to scale based on the size of the alarm breach.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
adjustmentType
Specifies how the
ScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.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 returnAdjustmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromadjustmentTypeAsString()
.- Returns:
- Specifies how the
ScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.AdjustmentType
is required if you are adding a new step scaling policy configuration. - See Also:
-
adjustmentTypeAsString
Specifies how the
ScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.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 returnAdjustmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromadjustmentTypeAsString()
.- Returns:
- Specifies how the
ScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.AdjustmentType
is required if you are adding a new step scaling policy configuration. - See Also:
-
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 theisEmpty()
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
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
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 aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
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 aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Application Auto Scaling scales out the service by 2 tasks.
-
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
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
.If the service returns an enum value that is not available in the current SDK version,
metricAggregationType
will returnMetricAggregationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricAggregationTypeAsString()
.- Returns:
- The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
. - See Also:
-
metricAggregationTypeAsString
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
.If the service returns an enum value that is not available in the current SDK version,
metricAggregationType
will returnMetricAggregationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricAggregationTypeAsString()
.- Returns:
- The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
. - See Also:
-
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 interfaceToCopyableBuilder<StepScalingPolicyConfiguration.Builder,
StepScalingPolicyConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-