autoscaling/aws.sdk.kotlin.services.autoscaling.model/PutScalingPolicyRequest/Builder

Builder

Properties

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

autoScalingGroupName

var autoScalingGroupName: String?

The name of the Auto Scaling group.

cooldown

var cooldown: Int?

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.

enabled

var enabled: Boolean?

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.

estimatedInstanceWarmup

var estimatedInstanceWarmup: Int?

Not needed if the default instance warmup is defined for the group.

metricAggregationType

var metricAggregationType: String?

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.

minAdjustmentMagnitude

var minAdjustmentMagnitude: Int?

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.

minAdjustmentStep

var minAdjustmentStep: Int?

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

policyName

var policyName: String?

The name of the policy.

policyType

var policyType: String?

One of the following policy types:

predictiveScalingConfiguration

var predictiveScalingConfiguration: PredictiveScalingConfiguration?

A predictive scaling policy. Provides support for predefined and custom metrics.

scalingAdjustment

var scalingAdjustment: Int?

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 non-negative value.

stepAdjustments

var stepAdjustments: List<StepAdjustment>?

A set of adjustments that enable you to scale based on the size of the alarm breach.

targetTrackingConfiguration

var targetTrackingConfiguration: TargetTrackingConfiguration?

A target tracking scaling policy. Provides support for predefined or custom metrics.

Functions

predictiveScalingConfiguration

fun predictiveScalingConfiguration(block: PredictiveScalingConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.autoscaling.model.PredictiveScalingConfiguration inside the given block

targetTrackingConfiguration

fun targetTrackingConfiguration(block: TargetTrackingConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.autoscaling.model.TargetTrackingConfiguration inside the given block