@Generated(value="software.amazon.awssdk:codegen") public final class PutScalingPolicyRequest extends AutoScalingRequest implements ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
PutScalingPolicyRequest.Builder |
| 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.
|
overrideConfigurationcopypublic final String autoScalingGroupName()
The name of the Auto Scaling group.
public final String policyName()
The name of the policy.
public final String policyType()
One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling (default)
TargetTrackingScaling
StepScaling
SimpleScaling (default)
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.
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.
public final Integer minAdjustmentStep()
Available for backward compatibility. Use MinAdjustmentMagnitude instead.
MinAdjustmentMagnitude instead.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.
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.
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.)
Required if the policy type is SimpleScaling. (Not used with any other policy type.)
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.
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.
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.
Minimum,
Maximum, and Average. If the aggregation type is null, the value is treated as
Average.
Valid only if the policy type is StepScaling.
public final boolean hasStepAdjustments()
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.
Required if the policy type is StepScaling. (Not used with any other policy type.)
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.
Valid only if the policy type is TargetTrackingScaling or StepScaling.
public final 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.
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.
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.
public PutScalingPolicyRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>toBuilder in class AutoScalingRequestpublic static PutScalingPolicyRequest.Builder builder()
public static Class<? extends PutScalingPolicyRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.