PutScalingPolicyRequest (AWS Java SDK for Auto Scaling 1.12.383 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.autoscaling.model.PutScalingPolicyRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutScalingPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

PutScalingPolicyRequest()

Constructors
Constructor and Description
`PutScalingPolicyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutScalingPolicyRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdjustmentType()` Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
`String`	`getAutoScalingGroupName()` The name of the Auto Scaling group.
`Integer`	`getCooldown()` A cooldown period, in seconds, that applies to a specific simple scaling policy.
`Boolean`	`getEnabled()` Indicates whether the scaling policy is enabled or disabled.
`Integer`	`getEstimatedInstanceWarmup()` Not needed if the default instance warmup is defined for the group.
`String`	`getMetricAggregationType()` The aggregation type for the CloudWatch metrics.
`Integer`	`getMinAdjustmentMagnitude()` The minimum value to scale by when the adjustment type is `PercentChangeInCapacity`.
`Integer`	`getMinAdjustmentStep()` Available for backward compatibility.
`String`	`getPolicyName()` The name of the policy.
`String`	`getPolicyType()` One of the following policy types:
`PredictiveScalingConfiguration`	`getPredictiveScalingConfiguration()` A predictive scaling policy.
`Integer`	`getScalingAdjustment()` The amount by which to scale, based on the specified adjustment type.
`List<StepAdjustment>`	`getStepAdjustments()` A set of adjustments that enable you to scale based on the size of the alarm breach.
`TargetTrackingConfiguration`	`getTargetTrackingConfiguration()` A target tracking scaling policy.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Indicates whether the scaling policy is enabled or disabled.
`void`	`setAdjustmentType(String adjustmentType)` Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
`void`	`setAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group.
`void`	`setCooldown(Integer cooldown)` A cooldown period, in seconds, that applies to a specific simple scaling policy.
`void`	`setEnabled(Boolean enabled)` Indicates whether the scaling policy is enabled or disabled.
`void`	`setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)` Not needed if the default instance warmup is defined for the group.
`void`	`setMetricAggregationType(String metricAggregationType)` The aggregation type for the CloudWatch metrics.
`void`	`setMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)` The minimum value to scale by when the adjustment type is `PercentChangeInCapacity`.
`void`	`setMinAdjustmentStep(Integer minAdjustmentStep)` Available for backward compatibility.
`void`	`setPolicyName(String policyName)` The name of the policy.
`void`	`setPolicyType(String policyType)` One of the following policy types:
`void`	`setPredictiveScalingConfiguration(PredictiveScalingConfiguration predictiveScalingConfiguration)` A predictive scaling policy.
`void`	`setScalingAdjustment(Integer scalingAdjustment)` The amount by which to scale, based on the specified adjustment type.
`void`	`setStepAdjustments(Collection<StepAdjustment> stepAdjustments)` A set of adjustments that enable you to scale based on the size of the alarm breach.
`void`	`setTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)` A target tracking scaling policy.
`String`	`toString()` Returns a string representation of this object.
`PutScalingPolicyRequest`	`withAdjustmentType(String adjustmentType)` Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
`PutScalingPolicyRequest`	`withAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group.
`PutScalingPolicyRequest`	`withCooldown(Integer cooldown)` A cooldown period, in seconds, that applies to a specific simple scaling policy.
`PutScalingPolicyRequest`	`withEnabled(Boolean enabled)` Indicates whether the scaling policy is enabled or disabled.
`PutScalingPolicyRequest`	`withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)` Not needed if the default instance warmup is defined for the group.
`PutScalingPolicyRequest`	`withMetricAggregationType(String metricAggregationType)` The aggregation type for the CloudWatch metrics.
`PutScalingPolicyRequest`	`withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)` The minimum value to scale by when the adjustment type is `PercentChangeInCapacity`.
`PutScalingPolicyRequest`	`withMinAdjustmentStep(Integer minAdjustmentStep)` Available for backward compatibility.
`PutScalingPolicyRequest`	`withPolicyName(String policyName)` The name of the policy.
`PutScalingPolicyRequest`	`withPolicyType(String policyType)` One of the following policy types:
`PutScalingPolicyRequest`	`withPredictiveScalingConfiguration(PredictiveScalingConfiguration predictiveScalingConfiguration)` A predictive scaling policy.
`PutScalingPolicyRequest`	`withScalingAdjustment(Integer scalingAdjustment)` The amount by which to scale, based on the specified adjustment type.
`PutScalingPolicyRequest`	`withStepAdjustments(Collection<StepAdjustment> stepAdjustments)` A set of adjustments that enable you to scale based on the size of the alarm breach.
`PutScalingPolicyRequest`	`withStepAdjustments(StepAdjustment... stepAdjustments)` A set of adjustments that enable you to scale based on the size of the alarm breach.
`PutScalingPolicyRequest`	`withTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)` A target tracking scaling policy.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutScalingPolicyRequest
```
public PutScalingPolicyRequest()
```
- Method Detail
  - setAutoScalingGroupName
```
public void setAutoScalingGroupName(String autoScalingGroupName)
```
    The name of the Auto Scaling group.
    
    Parameters:
    
    autoScalingGroupName - The name of the Auto Scaling group.
  - getAutoScalingGroupName
```
public String getAutoScalingGroupName()
```
    The name of the Auto Scaling group.
    
    Returns:
    
    The name of the Auto Scaling group.
  - withAutoScalingGroupName
```
public PutScalingPolicyRequest withAutoScalingGroupName(String autoScalingGroupName)
```
    The name of the Auto Scaling group.
    
    Parameters:
    
    autoScalingGroupName - The name of the Auto Scaling group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyName
```
public void setPolicyName(String policyName)
```
    The name of the policy.
    
    Parameters:
    
    policyName - The name of the policy.
  - getPolicyName
```
public String getPolicyName()
```
    The name of the policy.
    
    Returns:
    
    The name of the policy.
  - withPolicyName
```
public PutScalingPolicyRequest withPolicyName(String policyName)
```
    The name of the policy.
    
    Parameters:
    
    policyName - The name of the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyType
```
public void setPolicyType(String policyType)
```
    One of the following policy types:
    - TargetTrackingScaling
    - StepScaling
    - SimpleScaling (default)
    - PredictiveScaling
    Parameters:
    policyType - One of the following policy types:
    
    TargetTrackingScaling
    
    StepScaling
    
    SimpleScaling (default)
    
    PredictiveScaling
  - getPolicyType
```
public String getPolicyType()
```
    One of the following policy types:
    - TargetTrackingScaling
    - StepScaling
    - SimpleScaling (default)
    - PredictiveScaling
    Returns:
    One of the following policy types:
    
    TargetTrackingScaling
    
    StepScaling
    
    SimpleScaling (default)
    
    PredictiveScaling
  - withPolicyType
```
public PutScalingPolicyRequest withPolicyType(String policyType)
```
    One of the following policy types:
    - TargetTrackingScaling
    - StepScaling
    - SimpleScaling (default)
    - PredictiveScaling
    Parameters:
    policyType - One of the following policy types:
    
    TargetTrackingScaling
    
    StepScaling
    
    SimpleScaling (default)
    
    PredictiveScaling
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdjustmentType
```
public void setAdjustmentType(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.
    
    Parameters:
    
    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.
  - getAdjustmentType
```
public String getAdjustmentType()
```
    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.
    
    Returns:
    
    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.
  - withAdjustmentType
```
public PutScalingPolicyRequest withAdjustmentType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinAdjustmentStep
```
public void setMinAdjustmentStep(Integer minAdjustmentStep)
```
    Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    
    Parameters:
    
    minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude instead.
  - getMinAdjustmentStep
```
public Integer getMinAdjustmentStep()
```
    Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    
    Returns:
    
    Available for backward compatibility. Use MinAdjustmentMagnitude instead.
  - withMinAdjustmentStep
```
public PutScalingPolicyRequest withMinAdjustmentStep(Integer minAdjustmentStep)
```
    Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    
    Parameters:
    
    minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinAdjustmentMagnitude
```
public void setMinAdjustmentMagnitude(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.
    
    Parameters:
    
    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.
  - getMinAdjustmentMagnitude
```
public Integer getMinAdjustmentMagnitude()
```
    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.
    
    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 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.
  - withMinAdjustmentMagnitude
```
public PutScalingPolicyRequest withMinAdjustmentMagnitude(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScalingAdjustment
```
public void setScalingAdjustment(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.)
    
    Parameters:
    
    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.)
  - getScalingAdjustment
```
public Integer getScalingAdjustment()
```
    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.)
    
    Returns:
    
    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.)
  - withScalingAdjustment
```
public PutScalingPolicyRequest withScalingAdjustment(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.)
    
    Parameters:
    
    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.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCooldown
```
public void setCooldown(Integer cooldown)
```
    A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
    
    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.
    
    Default: None
    
    Parameters:
    
    cooldown - A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
    
    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.
    
    Default: None
  - getCooldown
```
public Integer getCooldown()
```
    A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
    
    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.
    
    Default: None
    
    Returns:
    
    A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
    
    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.
    
    Default: None
  - withCooldown
```
public PutScalingPolicyRequest withCooldown(Integer cooldown)
```
    A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
    
    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.
    
    Default: None
    
    Parameters:
    
    cooldown - A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
    
    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.
    
    Default: None
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricAggregationType
```
public void setMetricAggregationType(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.
    
    Parameters:
    
    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.
  - getMetricAggregationType
```
public String getMetricAggregationType()
```
    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.
    
    Returns:
    
    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.
  - withMetricAggregationType
```
public PutScalingPolicyRequest withMetricAggregationType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStepAdjustments
```
public List<StepAdjustment> getStepAdjustments()
```
    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.)
    
    Returns:
    
    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.)
  - setStepAdjustments
```
public void setStepAdjustments(Collection<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.)
    
    Parameters:
    
    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.)
  - withStepAdjustments
```
public PutScalingPolicyRequest withStepAdjustments(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.)
    
    NOTE: This method appends the values to the existing list (if any). Use setStepAdjustments(java.util.Collection) or withStepAdjustments(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStepAdjustments
```
public PutScalingPolicyRequest withStepAdjustments(Collection<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.)
    
    Parameters:
    
    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.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEstimatedInstanceWarmup
```
public void setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)
```
    Not needed if the default instance warmup is defined for the group.
    
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
    
    Valid only if the policy type is TargetTrackingScaling or StepScaling.
    
    The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.
    
    Parameters:
    
    estimatedInstanceWarmup - Not needed if the default instance warmup is defined for the group.
    
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
    
    Valid only if the policy type is TargetTrackingScaling or StepScaling.
    
    The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.
  - getEstimatedInstanceWarmup
```
public Integer getEstimatedInstanceWarmup()
```
    Not needed if the default instance warmup is defined for the group.
    
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
    
    Valid only if the policy type is TargetTrackingScaling or StepScaling.
    
    The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.
    
    Returns:
    
    Not needed if the default instance warmup is defined for the group.
    
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
    
    Valid only if the policy type is TargetTrackingScaling or StepScaling.
    
    The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.
  - withEstimatedInstanceWarmup
```
public PutScalingPolicyRequest withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)
```
    Not needed if the default instance warmup is defined for the group.
    
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
    
    Valid only if the policy type is TargetTrackingScaling or StepScaling.
    
    The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.
    
    Parameters:
    
    estimatedInstanceWarmup - Not needed if the default instance warmup is defined for the group.
    
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
    
    Valid only if the policy type is TargetTrackingScaling or StepScaling.
    
    The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetTrackingConfiguration
```
public void setTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)
```
    A target tracking scaling policy. Provides support for predefined or custom metrics.
    
    The following predefined metrics are available:
    - ASGAverageCPUUtilization
    - ASGAverageNetworkIn
    - ASGAverageNetworkOut
    - ALBRequestCountPerTarget
    If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is TargetTrackingScaling.
    Parameters:
    targetTrackingConfiguration - A target tracking scaling policy. Provides support for predefined or custom metrics.
    
    The following predefined metrics are available:
    
    ASGAverageCPUUtilization
    
    ASGAverageNetworkIn
    
    ASGAverageNetworkOut
    
    ALBRequestCountPerTarget
    
    If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is TargetTrackingScaling.
  - getTargetTrackingConfiguration
```
public TargetTrackingConfiguration getTargetTrackingConfiguration()
```
    A target tracking scaling policy. Provides support for predefined or custom metrics.
    
    The following predefined metrics are available:
    - ASGAverageCPUUtilization
    - ASGAverageNetworkIn
    - ASGAverageNetworkOut
    - ALBRequestCountPerTarget
    If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is TargetTrackingScaling.
    Returns:
    A target tracking scaling policy. Provides support for predefined or custom metrics.
    
    The following predefined metrics are available:
    
    ASGAverageCPUUtilization
    
    ASGAverageNetworkIn
    
    ASGAverageNetworkOut
    
    ALBRequestCountPerTarget
    
    If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is TargetTrackingScaling.
  - withTargetTrackingConfiguration
```
public PutScalingPolicyRequest withTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)
```
    A target tracking scaling policy. Provides support for predefined or custom metrics.
    
    The following predefined metrics are available:
    - ASGAverageCPUUtilization
    - ASGAverageNetworkIn
    - ASGAverageNetworkOut
    - ALBRequestCountPerTarget
    If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is TargetTrackingScaling.
    Parameters:
    targetTrackingConfiguration - A target tracking scaling policy. Provides support for predefined or custom metrics.
    
    The following predefined metrics are available:
    
    ASGAverageCPUUtilization
    
    ASGAverageNetworkIn
    
    ASGAverageNetworkOut
    
    ALBRequestCountPerTarget
    
    If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is TargetTrackingScaling.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnabled
```
public void setEnabled(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.
    
    Parameters:
    
    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.
  - getEnabled
```
public Boolean getEnabled()
```
    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.
    
    Returns:
    
    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.
  - withEnabled
```
public PutScalingPolicyRequest withEnabled(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    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.
    
    Returns:
    
    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.
  - setPredictiveScalingConfiguration
```
public void setPredictiveScalingConfiguration(PredictiveScalingConfiguration predictiveScalingConfiguration)
```
    A predictive scaling policy. Provides support for predefined and custom metrics.
    
    Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
    
    For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is PredictiveScaling.
    
    Parameters:
    
    predictiveScalingConfiguration - A predictive scaling policy. Provides support for predefined and custom metrics.
    
    Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
    
    For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is PredictiveScaling.
  - getPredictiveScalingConfiguration
```
public PredictiveScalingConfiguration getPredictiveScalingConfiguration()
```
    A predictive scaling policy. Provides support for predefined and custom metrics.
    
    Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
    
    For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is PredictiveScaling.
    
    Returns:
    
    A predictive scaling policy. Provides support for predefined and custom metrics.
    
    Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
    
    For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is PredictiveScaling.
  - withPredictiveScalingConfiguration
```
public PutScalingPolicyRequest withPredictiveScalingConfiguration(PredictiveScalingConfiguration predictiveScalingConfiguration)
```
    A predictive scaling policy. Provides support for predefined and custom metrics.
    
    Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
    
    For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is PredictiveScaling.
    
    Parameters:
    
    predictiveScalingConfiguration - A predictive scaling policy. Provides support for predefined and custom metrics.
    
    Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
    
    For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Required if the policy type is PredictiveScaling.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutScalingPolicyRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class PutScalingPolicyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutScalingPolicyRequest

Method Detail

setAutoScalingGroupName

getAutoScalingGroupName

withAutoScalingGroupName

setPolicyName

getPolicyName

withPolicyName

setPolicyType

getPolicyType

withPolicyType

setAdjustmentType

getAdjustmentType

withAdjustmentType

setMinAdjustmentStep

getMinAdjustmentStep

withMinAdjustmentStep

setMinAdjustmentMagnitude

getMinAdjustmentMagnitude

withMinAdjustmentMagnitude

setScalingAdjustment

getScalingAdjustment

withScalingAdjustment

setCooldown

getCooldown

withCooldown

setMetricAggregationType

getMetricAggregationType

withMetricAggregationType

getStepAdjustments

setStepAdjustments

withStepAdjustments

withStepAdjustments

setEstimatedInstanceWarmup

getEstimatedInstanceWarmup

withEstimatedInstanceWarmup

setTargetTrackingConfiguration

getTargetTrackingConfiguration

withTargetTrackingConfiguration

setEnabled

getEnabled

withEnabled

isEnabled

setPredictiveScalingConfiguration

getPredictiveScalingConfiguration

withPredictiveScalingConfiguration

toString

equals

hashCode

clone