PutScalingPolicyRequest (AWS SDK for Java

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()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getAdjustmentType()` Specifies whether the `ScalingAdjustment` parameter is an absolute number or a percentage of the current capacity.
`String`	`getAutoScalingGroupName()` The name of the Auto Scaling group.
`Integer`	`getCooldown()` The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
`Boolean`	`getEnabled()` Indicates whether the scaling policy is enabled or disabled.
`Integer`	`getEstimatedInstanceWarmup()` The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
`String`	`getMetricAggregationType()` The aggregation type for the CloudWatch metrics.
`Integer`	`getMinAdjustmentMagnitude()` The minimum number of instances to scale.
`Integer`	`getMinAdjustmentStep()` Available for backward compatibility.
`String`	`getPolicyName()` The name of the policy.
`String`	`getPolicyType()` The policy type.
`Integer`	`getScalingAdjustment()` The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach.
`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 whether the `ScalingAdjustment` parameter is an absolute number or a percentage of the current capacity.
`void`	`setAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group.
`void`	`setCooldown(Integer cooldown)` The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
`void`	`setEnabled(Boolean enabled)` Indicates whether the scaling policy is enabled or disabled.
`void`	`setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)` The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
`void`	`setMetricAggregationType(String metricAggregationType)` The aggregation type for the CloudWatch metrics.
`void`	`setMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)` The minimum number of instances to scale.
`void`	`setMinAdjustmentStep(Integer minAdjustmentStep)` Available for backward compatibility.
`void`	`setPolicyName(String policyName)` The name of the policy.
`void`	`setPolicyType(String policyType)` The policy type.
`void`	`setScalingAdjustment(Integer scalingAdjustment)` The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach.
`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 whether the `ScalingAdjustment` parameter is an absolute number or a percentage of the current capacity.
`PutScalingPolicyRequest`	`withAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group.
`PutScalingPolicyRequest`	`withCooldown(Integer cooldown)` The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
`PutScalingPolicyRequest`	`withEnabled(Boolean enabled)` Indicates whether the scaling policy is enabled or disabled.
`PutScalingPolicyRequest`	`withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)` The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
`PutScalingPolicyRequest`	`withMetricAggregationType(String metricAggregationType)` The aggregation type for the CloudWatch metrics.
`PutScalingPolicyRequest`	`withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)` The minimum number of instances to scale.
`PutScalingPolicyRequest`	`withMinAdjustmentStep(Integer minAdjustmentStep)` Available for backward compatibility.
`PutScalingPolicyRequest`	`withPolicyName(String policyName)` The name of the policy.
`PutScalingPolicyRequest`	`withPolicyType(String policyType)` The policy type.
`PutScalingPolicyRequest`	`withScalingAdjustment(Integer scalingAdjustment)` The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach.
`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
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)
```
    The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
    
    Parameters:
    
    policyType - The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
  - getPolicyType
```
public String getPolicyType()
```
    The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
    
    Returns:
    
    The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
  - withPolicyType
```
public PutScalingPolicyRequest withPolicyType(String policyType)
```
    The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
    
    Parameters:
    
    policyType - The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdjustmentType
```
public void setAdjustmentType(String adjustmentType)
```
    Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    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.
    
    Parameters:
    
    adjustmentType - Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    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.
  - getAdjustmentType
```
public String getAdjustmentType()
```
    Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    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.
    
    Returns:
    
    Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    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.
  - withAdjustmentType
```
public PutScalingPolicyRequest withAdjustmentType(String adjustmentType)
```
    Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    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.
    
    Parameters:
    
    adjustmentType - Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    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.
    
    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 number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
    
    This property replaces the MinAdjustmentStep property. 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 SimpleScaling or StepScaling.
    
    Parameters:
    
    minAdjustmentMagnitude - The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError .
    
    This property replaces the MinAdjustmentStep property. 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 SimpleScaling or StepScaling.
  - getMinAdjustmentMagnitude
```
public Integer getMinAdjustmentMagnitude()
```
    The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
    
    This property replaces the MinAdjustmentStep property. 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 SimpleScaling or StepScaling.
    
    Returns:
    
    The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError .
    
    This property replaces the MinAdjustmentStep property. 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 SimpleScaling or StepScaling.
  - withMinAdjustmentMagnitude
```
public PutScalingPolicyRequest withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)
```
    The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
    
    This property replaces the MinAdjustmentStep property. 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 SimpleScaling or StepScaling.
    
    Parameters:
    
    minAdjustmentMagnitude - The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError .
    
    This property replaces the MinAdjustmentStep property. 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 SimpleScaling or StepScaling.
    
    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 a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.
    
    Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
    
    Parameters:
    
    scalingAdjustment - The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.
    
    Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
  - getScalingAdjustment
```
public Integer getScalingAdjustment()
```
    The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.
    
    Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
    
    Returns:
    
    The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.
    
    Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
  - withScalingAdjustment
```
public PutScalingPolicyRequest withScalingAdjustment(Integer scalingAdjustment)
```
    The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.
    
    Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
    
    Parameters:
    
    scalingAdjustment - The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.
    
    Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (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)
```
    The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.
    
    Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
    
    Parameters:
    
    cooldown - The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.
    
    Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
  - getCooldown
```
public Integer getCooldown()
```
    The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.
    
    Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
    
    Returns:
    
    The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.
    
    Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
  - withCooldown
```
public PutScalingPolicyRequest withCooldown(Integer cooldown)
```
    The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.
    
    Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
    
    Parameters:
    
    cooldown - The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.
    
    Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
    
    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.
    
    Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (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.
    
    Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (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.
    
    Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (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.
    
    Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (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.
    
    Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (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.
    
    Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (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.
    
    Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (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.
    
    Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (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)
```
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
    
    Valid only if the policy type is StepScaling or TargetTrackingScaling.
    
    Parameters:
    
    estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
    
    Valid only if the policy type is StepScaling or TargetTrackingScaling.
  - getEstimatedInstanceWarmup
```
public Integer getEstimatedInstanceWarmup()
```
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
    
    Valid only if the policy type is StepScaling or TargetTrackingScaling.
    
    Returns:
    
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
    
    Valid only if the policy type is StepScaling or TargetTrackingScaling.
  - withEstimatedInstanceWarmup
```
public PutScalingPolicyRequest withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)
```
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
    
    Valid only if the policy type is StepScaling or TargetTrackingScaling.
    
    Parameters:
    
    estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
    
    Valid only if the policy type is StepScaling or TargetTrackingScaling.
    
    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. Includes support for predefined or customized metrics.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
    
    Parameters:
    
    targetTrackingConfiguration - A target tracking scaling policy. Includes support for predefined or customized metrics.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
  - getTargetTrackingConfiguration
```
public TargetTrackingConfiguration getTargetTrackingConfiguration()
```
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
    
    Returns:
    
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
  - withTargetTrackingConfiguration
```
public PutScalingPolicyRequest withTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)
```
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
    
    Parameters:
    
    targetTrackingConfiguration - A target tracking scaling policy. Includes support for predefined or customized metrics.
    
    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
    
    Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
    
    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.
  - 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()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

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

toString

equals

hashCode

clone