public static final class CfnScalingPolicy.Builder
extends java.lang.Object
CfnScalingPolicy
.Modifier and Type | Method and Description |
---|---|
CfnScalingPolicy.Builder |
adjustmentType(java.lang.String adjustmentType)
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
|
CfnScalingPolicy.Builder |
autoScalingGroupName(java.lang.String autoScalingGroupName)
The name of the Auto Scaling group.
|
CfnScalingPolicy |
build() |
CfnScalingPolicy.Builder |
cooldown(java.lang.String cooldown)
A cooldown period, in seconds, that applies to a specific simple scaling policy.
|
static CfnScalingPolicy.Builder |
create(Construct scope,
java.lang.String id) |
CfnScalingPolicy.Builder |
estimatedInstanceWarmup(java.lang.Number estimatedInstanceWarmup)
*Not needed if the default instance warmup is defined for the group.*.
|
CfnScalingPolicy.Builder |
metricAggregationType(java.lang.String metricAggregationType)
The aggregation type for the CloudWatch metrics.
|
CfnScalingPolicy.Builder |
minAdjustmentMagnitude(java.lang.Number minAdjustmentMagnitude)
The minimum value to scale by when the adjustment type is `PercentChangeInCapacity` .
|
CfnScalingPolicy.Builder |
policyType(java.lang.String policyType)
One of the following policy types:.
|
CfnScalingPolicy.Builder |
predictiveScalingConfiguration(CfnScalingPolicy.PredictiveScalingConfigurationProperty predictiveScalingConfiguration)
A predictive scaling policy.
|
CfnScalingPolicy.Builder |
predictiveScalingConfiguration(IResolvable predictiveScalingConfiguration)
A predictive scaling policy.
|
CfnScalingPolicy.Builder |
scalingAdjustment(java.lang.Number scalingAdjustment)
The amount by which to scale, based on the specified adjustment type.
|
CfnScalingPolicy.Builder |
stepAdjustments(IResolvable stepAdjustments)
A set of adjustments that enable you to scale based on the size of the alarm breach.
|
CfnScalingPolicy.Builder |
stepAdjustments(java.util.List<? extends java.lang.Object> stepAdjustments)
A set of adjustments that enable you to scale based on the size of the alarm breach.
|
CfnScalingPolicy.Builder |
targetTrackingConfiguration(CfnScalingPolicy.TargetTrackingConfigurationProperty targetTrackingConfiguration)
A target tracking scaling policy.
|
CfnScalingPolicy.Builder |
targetTrackingConfiguration(IResolvable targetTrackingConfiguration)
A target tracking scaling policy.
|
public static CfnScalingPolicy.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnScalingPolicy.CustomizedMetricSpecificationProperty.Builder
.public CfnScalingPolicy.Builder autoScalingGroupName(java.lang.String autoScalingGroupName)
autoScalingGroupName
- The name of the Auto Scaling group. This parameter is required.this
public CfnScalingPolicy.Builder adjustmentType(java.lang.String adjustmentType)
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 .
adjustmentType
- Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). This parameter is required.this
public CfnScalingPolicy.Builder cooldown(java.lang.String cooldown)
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
cooldown
- A cooldown period, in seconds, that applies to a specific simple scaling policy. This parameter is required.this
public CfnScalingPolicy.Builder estimatedInstanceWarmup(java.lang.Number estimatedInstanceWarmup)
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.
estimatedInstanceWarmup
- *Not needed if the default instance warmup is defined for the group.*. This parameter is required.this
public CfnScalingPolicy.Builder metricAggregationType(java.lang.String metricAggregationType)
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
.
metricAggregationType
- The aggregation type for the CloudWatch metrics. This parameter is required.this
public CfnScalingPolicy.Builder minAdjustmentMagnitude(java.lang.Number minAdjustmentMagnitude)
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.
minAdjustmentMagnitude
- The minimum value to scale by when the adjustment type is `PercentChangeInCapacity` . This parameter is required.this
public CfnScalingPolicy.Builder policyType(java.lang.String policyType)
TargetTrackingScaling
StepScaling
SimpleScaling
(default)PredictiveScaling
policyType
- One of the following policy types:. This parameter is required.this
public CfnScalingPolicy.Builder predictiveScalingConfiguration(IResolvable predictiveScalingConfiguration)
Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
Required if the policy type is PredictiveScaling
.
predictiveScalingConfiguration
- A predictive scaling policy. Provides support for predefined and custom metrics. This parameter is required.this
public CfnScalingPolicy.Builder predictiveScalingConfiguration(CfnScalingPolicy.PredictiveScalingConfigurationProperty predictiveScalingConfiguration)
Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
Required if the policy type is PredictiveScaling
.
predictiveScalingConfiguration
- A predictive scaling policy. Provides support for predefined and custom metrics. This parameter is required.this
public CfnScalingPolicy.Builder scalingAdjustment(java.lang.Number scalingAdjustment)
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.)
scalingAdjustment
- The amount by which to scale, based on the specified adjustment type. This parameter is required.this
public CfnScalingPolicy.Builder stepAdjustments(IResolvable stepAdjustments)
Required if the policy type is StepScaling
. (Not used with any other policy type.)
stepAdjustments
- A set of adjustments that enable you to scale based on the size of the alarm breach. This parameter is required.this
public CfnScalingPolicy.Builder stepAdjustments(java.util.List<? extends java.lang.Object> stepAdjustments)
Required if the policy type is StepScaling
. (Not used with any other policy type.)
stepAdjustments
- A set of adjustments that enable you to scale based on the size of the alarm breach. This parameter is required.this
public CfnScalingPolicy.Builder targetTrackingConfiguration(IResolvable targetTrackingConfiguration)
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
.
Required if the policy type is TargetTrackingScaling
.
targetTrackingConfiguration
- A target tracking scaling policy. Provides support for predefined or custom metrics. This parameter is required.this
public CfnScalingPolicy.Builder targetTrackingConfiguration(CfnScalingPolicy.TargetTrackingConfigurationProperty targetTrackingConfiguration)
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
.
Required if the policy type is TargetTrackingScaling
.
targetTrackingConfiguration
- A target tracking scaling policy. Provides support for predefined or custom metrics. This parameter is required.this
public CfnScalingPolicy build()