pulumi-aws-native-kotlin/com.pulumi.awsnative.autoscaling.kotlin.outputs/GetScalingPolicyResult

GetScalingPolicyResult

data class GetScalingPolicyResult(val adjustmentType: String? = null, val arn: String? = null, val cooldown: String? = null, val estimatedInstanceWarmup: Int? = null, val metricAggregationType: String? = null, val minAdjustmentMagnitude: Int? = null, val policyName: String? = null, val policyType: String? = null, val predictiveScalingConfiguration: ScalingPolicyPredictiveScalingConfiguration? = null, val scalingAdjustment: Int? = null, val stepAdjustments: List<ScalingPolicyStepAdjustment>? = null, val targetTrackingConfiguration: ScalingPolicyTargetTrackingConfiguration? = null)

Constructors

fun GetScalingPolicyResult(adjustmentType: String? = null, arn: String? = null, cooldown: String? = null, estimatedInstanceWarmup: Int? = null, metricAggregationType: String? = null, minAdjustmentMagnitude: Int? = null, policyName: String? = null, policyType: String? = null, predictiveScalingConfiguration: ScalingPolicyPredictiveScalingConfiguration? = null, scalingAdjustment: Int? = null, stepAdjustments: List<ScalingPolicyStepAdjustment>? = null, targetTrackingConfiguration: ScalingPolicyTargetTrackingConfiguration? = null)

Types

Companion

object Companion

Properties

adjustmentType

val adjustmentType: String? = null

Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

arn

val arn: String? = null

The ARN of the AutoScaling scaling policy

cooldown

val cooldown: String? = null

The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.

estimatedInstanceWarmup

val estimatedInstanceWarmup: Int? = null

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.

metricAggregationType

val metricAggregationType: String? = null

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.

minAdjustmentMagnitude

val minAdjustmentMagnitude: Int? = null

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.

policyName

val policyName: String? = null

policyType

val policyType: String? = null

One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling

predictiveScalingConfiguration

val predictiveScalingConfiguration: ScalingPolicyPredictiveScalingConfiguration? = null

A predictive scaling policy. Includes support for predefined metrics only.

scalingAdjustment

val scalingAdjustment: Int? = null

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.)

stepAdjustments

val stepAdjustments: List<ScalingPolicyStepAdjustment>? = null

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.)

targetTrackingConfiguration

val targetTrackingConfiguration: ScalingPolicyTargetTrackingConfiguration? = null

A target tracking scaling policy. Includes support for predefined or customized metrics.