Amazonka.AutoScaling.Types.ScalingPolicy

Documentation

data ScalingPolicy

Describes a scaling policy.

See: newScalingPolicy smart constructor.

Constructors

ScalingPolicy'

Fields

• adjustmentType :: Maybe Text

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

• alarms :: Maybe [Alarm]

  The CloudWatch alarms related to the policy.

• autoScalingGroupName :: Maybe Text

  The name of the Auto Scaling group.

• cooldown :: Maybe Int

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

• enabled :: Maybe Bool

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

• estimatedInstanceWarmup :: Maybe Int

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

• metricAggregationType :: Maybe Text

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

• minAdjustmentMagnitude :: Maybe Int

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

• minAdjustmentStep :: Maybe Int

  Available for backward compatibility. Use MinAdjustmentMagnitude instead.

• policyARN :: Maybe Text

  The Amazon Resource Name (ARN) of the policy.

• policyName :: Maybe Text

  The name of the scaling policy.

• policyType :: Maybe Text

  One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

  • PredictiveScaling

  For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

• predictiveScalingConfiguration :: Maybe PredictiveScalingConfiguration

  A predictive scaling policy.

• scalingAdjustment :: Maybe 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 :: Maybe [StepAdjustment]

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

• targetTrackingConfiguration :: Maybe TargetTrackingConfiguration

  A target tracking scaling policy.

Instances

FromXML ScalingPolicy

Defined in Amazonka.AutoScaling.Types.ScalingPolicy

Methods

parseXML :: [Node] -> Either String ScalingPolicy

Generic ScalingPolicy

Defined in Amazonka.AutoScaling.Types.ScalingPolicy

Associated Types

type Rep ScalingPolicy :: Type -> Type

Methods

from :: ScalingPolicy -> Rep ScalingPolicy x

to :: Rep ScalingPolicy x -> ScalingPolicy

Read ScalingPolicy

Defined in Amazonka.AutoScaling.Types.ScalingPolicy

Methods

readsPrec :: Int -> ReadS ScalingPolicy

readList :: ReadS [ScalingPolicy]

readPrec :: ReadPrec ScalingPolicy

readListPrec :: ReadPrec [ScalingPolicy]

Show ScalingPolicy

Defined in Amazonka.AutoScaling.Types.ScalingPolicy

Methods

showsPrec :: Int -> ScalingPolicy -> ShowS

show :: ScalingPolicy -> String

showList :: [ScalingPolicy] -> ShowS

NFData ScalingPolicy

Defined in Amazonka.AutoScaling.Types.ScalingPolicy

Methods

rnf :: ScalingPolicy -> ()

Eq ScalingPolicy

Defined in Amazonka.AutoScaling.Types.ScalingPolicy

Methods

(==) :: ScalingPolicy -> ScalingPolicy -> Bool

(/=) :: ScalingPolicy -> ScalingPolicy -> Bool

Hashable ScalingPolicy

Defined in Amazonka.AutoScaling.Types.ScalingPolicy

Methods

hashWithSalt :: Int -> ScalingPolicy -> Int

hash :: ScalingPolicy -> Int

type Rep ScalingPolicy

Defined in Amazonka.AutoScaling.Types.ScalingPolicy

type Rep ScalingPolicy = D1 ('MetaData "ScalingPolicy" "Amazonka.AutoScaling.Types.ScalingPolicy" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "ScalingPolicy'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "adjustmentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alarms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Alarm]))) :*: (S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cooldown") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "estimatedInstanceWarmup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "metricAggregationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "minAdjustmentMagnitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: (((S1 ('MetaSel ('Just "minAdjustmentStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "policyARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "policyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "predictiveScalingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PredictiveScalingConfiguration)) :*: S1 ('MetaSel ('Just "scalingAdjustment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "stepAdjustments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StepAdjustment])) :*: S1 ('MetaSel ('Just "targetTrackingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetTrackingConfiguration)))))))

newScalingPolicy :: ScalingPolicy

Create a value of ScalingPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:adjustmentType:ScalingPolicy', scalingPolicy_adjustmentType - Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

$sel:alarms:ScalingPolicy', scalingPolicy_alarms - The CloudWatch alarms related to the policy.

$sel:autoScalingGroupName:ScalingPolicy', scalingPolicy_autoScalingGroupName - The name of the Auto Scaling group.

$sel:cooldown:ScalingPolicy', scalingPolicy_cooldown - The duration of the policy's cooldown period, in seconds.

$sel:enabled:ScalingPolicy', scalingPolicy_enabled - Indicates whether the policy is enabled (true) or disabled (false).

$sel:estimatedInstanceWarmup:ScalingPolicy', scalingPolicy_estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

$sel:metricAggregationType:ScalingPolicy', scalingPolicy_metricAggregationType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

$sel:minAdjustmentMagnitude:ScalingPolicy', scalingPolicy_minAdjustmentMagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

$sel:minAdjustmentStep:ScalingPolicy', scalingPolicy_minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude instead.

$sel:policyARN:ScalingPolicy', scalingPolicy_policyARN - The Amazon Resource Name (ARN) of the policy.

$sel:policyName:ScalingPolicy', scalingPolicy_policyName - The name of the scaling policy.

$sel:policyType:ScalingPolicy', scalingPolicy_policyType - One of the following policy types:

• TargetTrackingScaling

• StepScaling

• SimpleScaling (default)

• PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

$sel:predictiveScalingConfiguration:ScalingPolicy', scalingPolicy_predictiveScalingConfiguration - A predictive scaling policy.

ScalingPolicy, scalingPolicy_scalingAdjustment - 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.

$sel:stepAdjustments:ScalingPolicy', scalingPolicy_stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.

$sel:targetTrackingConfiguration:ScalingPolicy', scalingPolicy_targetTrackingConfiguration - A target tracking scaling policy.

scalingPolicy_adjustmentType :: Lens' ScalingPolicy (Maybe Text)

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

scalingPolicy_alarms :: Lens' ScalingPolicy (Maybe [Alarm])

The CloudWatch alarms related to the policy.

scalingPolicy_autoScalingGroupName :: Lens' ScalingPolicy (Maybe Text)

The name of the Auto Scaling group.

scalingPolicy_cooldown :: Lens' ScalingPolicy (Maybe Int)

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

scalingPolicy_enabled :: Lens' ScalingPolicy (Maybe Bool)

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

scalingPolicy_estimatedInstanceWarmup :: Lens' ScalingPolicy (Maybe Int)

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

scalingPolicy_metricAggregationType :: Lens' ScalingPolicy (Maybe Text)

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

scalingPolicy_minAdjustmentMagnitude :: Lens' ScalingPolicy (Maybe Int)

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

scalingPolicy_minAdjustmentStep :: Lens' ScalingPolicy (Maybe Int)

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

scalingPolicy_policyARN :: Lens' ScalingPolicy (Maybe Text)

The Amazon Resource Name (ARN) of the policy.

scalingPolicy_policyName :: Lens' ScalingPolicy (Maybe Text)

The name of the scaling policy.

scalingPolicy_policyType :: Lens' ScalingPolicy (Maybe Text)

One of the following policy types:

• TargetTrackingScaling

• StepScaling

• SimpleScaling (default)

• PredictiveScaling

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

scalingPolicy_predictiveScalingConfiguration :: Lens' ScalingPolicy (Maybe PredictiveScalingConfiguration)

A predictive scaling policy.

scalingPolicy_scalingAdjustment :: Lens' ScalingPolicy (Maybe 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.

scalingPolicy_stepAdjustments :: Lens' ScalingPolicy (Maybe [StepAdjustment])

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

scalingPolicy_targetTrackingConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingConfiguration)

A target tracking scaling policy.