com.amazonaws.services.applicationautoscaling.model.StepScalingPolicyConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-applicationautoscaling Show documentation
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.applicationautoscaling.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Represents a step scaling policy configuration to use with Application Auto Scaling.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StepScalingPolicyConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment
* is interpreted.
*
*/
private String adjustmentType;
/**
*
* A set of adjustments that enable you to scale based on the size of the alarm breach.
*
*/
private java.util.List stepAdjustments;
/**
*
* 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.
*
*
* 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.
*
*/
private Integer minAdjustmentMagnitude;
/**
*
* 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.
*
*/
private Integer cooldown;
/**
*
* 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.
*
*/
private String metricAggregationType;
/**
*
* The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment
* is interpreted.
*
*
* @param adjustmentType
* The adjustment type, which specifies how the ScalingAdjustment parameter in a
* StepAdjustment is interpreted.
* @see AdjustmentType
*/
public void setAdjustmentType(String adjustmentType) {
this.adjustmentType = adjustmentType;
}
/**
*
* The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment
* is interpreted.
*
*
* @return The adjustment type, which specifies how the ScalingAdjustment parameter in a
* StepAdjustment is interpreted.
* @see AdjustmentType
*/
public String getAdjustmentType() {
return this.adjustmentType;
}
/**
*
* The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment
* is interpreted.
*
*
* @param adjustmentType
* The adjustment type, which specifies how the ScalingAdjustment parameter in a
* StepAdjustment is interpreted.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AdjustmentType
*/
public StepScalingPolicyConfiguration withAdjustmentType(String adjustmentType) {
setAdjustmentType(adjustmentType);
return this;
}
/**
*
* The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment
* is interpreted.
*
*
* @param adjustmentType
* The adjustment type, which specifies how the ScalingAdjustment parameter in a
* StepAdjustment is interpreted.
* @see AdjustmentType
*/
public void setAdjustmentType(AdjustmentType adjustmentType) {
withAdjustmentType(adjustmentType);
}
/**
*
* The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment
* is interpreted.
*
*
* @param adjustmentType
* The adjustment type, which specifies how the ScalingAdjustment parameter in a
* StepAdjustment is interpreted.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AdjustmentType
*/
public StepScalingPolicyConfiguration withAdjustmentType(AdjustmentType adjustmentType) {
this.adjustmentType = adjustmentType.toString();
return this;
}
/**
*
* A set of adjustments that enable you to scale based on the size of the alarm breach.
*
*
* @return A set of adjustments that enable you to scale based on the size of the alarm breach.
*/
public java.util.List getStepAdjustments() {
return stepAdjustments;
}
/**
*
* A set of adjustments that enable you to scale based on the size of the alarm breach.
*
*
* @param stepAdjustments
* A set of adjustments that enable you to scale based on the size of the alarm breach.
*/
public void setStepAdjustments(java.util.Collection stepAdjustments) {
if (stepAdjustments == null) {
this.stepAdjustments = null;
return;
}
this.stepAdjustments = new java.util.ArrayList(stepAdjustments);
}
/**
*
* A set of adjustments that enable you to scale based on the size of the alarm breach.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setStepAdjustments(java.util.Collection)} or {@link #withStepAdjustments(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param stepAdjustments
* A set of adjustments that enable you to scale based on the size of the alarm breach.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepScalingPolicyConfiguration withStepAdjustments(StepAdjustment... stepAdjustments) {
if (this.stepAdjustments == null) {
setStepAdjustments(new java.util.ArrayList(stepAdjustments.length));
}
for (StepAdjustment ele : stepAdjustments) {
this.stepAdjustments.add(ele);
}
return this;
}
/**
*
* A set of adjustments that enable you to scale based on the size of the alarm breach.
*
*
* @param stepAdjustments
* A set of adjustments that enable you to scale based on the size of the alarm breach.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepScalingPolicyConfiguration withStepAdjustments(java.util.Collection stepAdjustments) {
setStepAdjustments(stepAdjustments);
return this;
}
/**
*
* 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.
*
*
* 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.
*
*
* @param 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.
*
* 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.
*/
public void setMinAdjustmentMagnitude(Integer minAdjustmentMagnitude) {
this.minAdjustmentMagnitude = 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.
*
*
* 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.
*
*
* @return 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.
*
* 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.
*/
public Integer getMinAdjustmentMagnitude() {
return this.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.
*
*
* 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.
*
*
* @param 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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepScalingPolicyConfiguration withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude) {
setMinAdjustmentMagnitude(minAdjustmentMagnitude);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setCooldown(Integer cooldown) {
this.cooldown = 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.
*
*
* @return 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.
*/
public Integer getCooldown() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StepScalingPolicyConfiguration withCooldown(Integer cooldown) {
setCooldown(cooldown);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see MetricAggregationType
*/
public void setMetricAggregationType(String metricAggregationType) {
this.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.
*
*
* @return 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 MetricAggregationType
*/
public String getMetricAggregationType() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricAggregationType
*/
public StepScalingPolicyConfiguration withMetricAggregationType(String metricAggregationType) {
setMetricAggregationType(metricAggregationType);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see MetricAggregationType
*/
public void setMetricAggregationType(MetricAggregationType metricAggregationType) {
withMetricAggregationType(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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricAggregationType
*/
public StepScalingPolicyConfiguration withMetricAggregationType(MetricAggregationType metricAggregationType) {
this.metricAggregationType = metricAggregationType.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAdjustmentType() != null)
sb.append("AdjustmentType: ").append(getAdjustmentType()).append(",");
if (getStepAdjustments() != null)
sb.append("StepAdjustments: ").append(getStepAdjustments()).append(",");
if (getMinAdjustmentMagnitude() != null)
sb.append("MinAdjustmentMagnitude: ").append(getMinAdjustmentMagnitude()).append(",");
if (getCooldown() != null)
sb.append("Cooldown: ").append(getCooldown()).append(",");
if (getMetricAggregationType() != null)
sb.append("MetricAggregationType: ").append(getMetricAggregationType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StepScalingPolicyConfiguration == false)
return false;
StepScalingPolicyConfiguration other = (StepScalingPolicyConfiguration) obj;
if (other.getAdjustmentType() == null ^ this.getAdjustmentType() == null)
return false;
if (other.getAdjustmentType() != null && other.getAdjustmentType().equals(this.getAdjustmentType()) == false)
return false;
if (other.getStepAdjustments() == null ^ this.getStepAdjustments() == null)
return false;
if (other.getStepAdjustments() != null && other.getStepAdjustments().equals(this.getStepAdjustments()) == false)
return false;
if (other.getMinAdjustmentMagnitude() == null ^ this.getMinAdjustmentMagnitude() == null)
return false;
if (other.getMinAdjustmentMagnitude() != null && other.getMinAdjustmentMagnitude().equals(this.getMinAdjustmentMagnitude()) == false)
return false;
if (other.getCooldown() == null ^ this.getCooldown() == null)
return false;
if (other.getCooldown() != null && other.getCooldown().equals(this.getCooldown()) == false)
return false;
if (other.getMetricAggregationType() == null ^ this.getMetricAggregationType() == null)
return false;
if (other.getMetricAggregationType() != null && other.getMetricAggregationType().equals(this.getMetricAggregationType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAdjustmentType() == null) ? 0 : getAdjustmentType().hashCode());
hashCode = prime * hashCode + ((getStepAdjustments() == null) ? 0 : getStepAdjustments().hashCode());
hashCode = prime * hashCode + ((getMinAdjustmentMagnitude() == null) ? 0 : getMinAdjustmentMagnitude().hashCode());
hashCode = prime * hashCode + ((getCooldown() == null) ? 0 : getCooldown().hashCode());
hashCode = prime * hashCode + ((getMetricAggregationType() == null) ? 0 : getMetricAggregationType().hashCode());
return hashCode;
}
@Override
public StepScalingPolicyConfiguration clone() {
try {
return (StepScalingPolicyConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.applicationautoscaling.model.transform.StepScalingPolicyConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}