autoscaling/aws.sdk.kotlin.services.autoscaling.model/ScalingPolicy

ScalingPolicy

class ScalingPolicy

Describes a scaling policy.

Types

Builder

class Builder

Companion

object Companion

Properties

adjustmentType

val adjustmentType: String?

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

alarms

val alarms: List<Alarm>?

The CloudWatch alarms related to the policy.

autoScalingGroupName

val autoScalingGroupName: String?

The name of the Auto Scaling group.

cooldown

val cooldown: Int?

The duration of the policy's cooldown period, in seconds.

enabled

val enabled: Boolean?

Indicates whether the policy is enabled (true) or disabled (false).

estimatedInstanceWarmup

val estimatedInstanceWarmup: Int?

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

metricAggregationType

val metricAggregationType: String?

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

minAdjustmentMagnitude

val minAdjustmentMagnitude: Int?

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

minAdjustmentStep

val minAdjustmentStep: Int?

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

policyArn

val policyArn: String?

The Amazon Resource Name (ARN) of the policy.

policyName

val policyName: String?

The name of the scaling policy.

policyType

val policyType: String?

One of the following policy types:

predictiveScalingConfiguration

val predictiveScalingConfiguration: PredictiveScalingConfiguration?

A predictive scaling policy.

scalingAdjustment

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

stepAdjustments

val stepAdjustments: List<StepAdjustment>?

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

targetTrackingConfiguration

val targetTrackingConfiguration: TargetTrackingConfiguration?

A target tracking scaling policy.

Functions

copy

inline fun copy(block: ScalingPolicy.Builder.() -> Unit = {}): ScalingPolicy

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String