amazonka-autoscaling-2.0: Amazon Auto Scaling SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AutoScaling.Types.TargetTrackingConfiguration

Description

 
Synopsis

Documentation

data TargetTrackingConfiguration Source #

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

See: newTargetTrackingConfiguration smart constructor.

Constructors

TargetTrackingConfiguration' 

Fields

  • customizedMetricSpecification :: Maybe CustomizedMetricSpecification

    A customized metric. You must specify either a predefined metric or a customized metric.

  • disableScaleIn :: Maybe Bool

    Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false.

  • predefinedMetricSpecification :: Maybe PredefinedMetricSpecification

    A predefined metric. You must specify either a predefined metric or a customized metric.

  • targetValue :: Double

    The target value for the metric.

    Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.

Instances

Instances details
ToQuery TargetTrackingConfiguration Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.TargetTrackingConfiguration

FromXML TargetTrackingConfiguration Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.TargetTrackingConfiguration

Generic TargetTrackingConfiguration Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.TargetTrackingConfiguration

Associated Types

type Rep TargetTrackingConfiguration :: Type -> Type #

Read TargetTrackingConfiguration Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.TargetTrackingConfiguration

Show TargetTrackingConfiguration Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.TargetTrackingConfiguration

NFData TargetTrackingConfiguration Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.TargetTrackingConfiguration

Eq TargetTrackingConfiguration Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.TargetTrackingConfiguration

Hashable TargetTrackingConfiguration Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.TargetTrackingConfiguration

type Rep TargetTrackingConfiguration Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.TargetTrackingConfiguration

type Rep TargetTrackingConfiguration = D1 ('MetaData "TargetTrackingConfiguration" "Amazonka.AutoScaling.Types.TargetTrackingConfiguration" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "TargetTrackingConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customizedMetricSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomizedMetricSpecification)) :*: S1 ('MetaSel ('Just "disableScaleIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "predefinedMetricSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PredefinedMetricSpecification)) :*: S1 ('MetaSel ('Just "targetValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))))

newTargetTrackingConfiguration Source #

Create a value of TargetTrackingConfiguration 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:customizedMetricSpecification:TargetTrackingConfiguration', targetTrackingConfiguration_customizedMetricSpecification - A customized metric. You must specify either a predefined metric or a customized metric.

$sel:disableScaleIn:TargetTrackingConfiguration', targetTrackingConfiguration_disableScaleIn - Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false.

$sel:predefinedMetricSpecification:TargetTrackingConfiguration', targetTrackingConfiguration_predefinedMetricSpecification - A predefined metric. You must specify either a predefined metric or a customized metric.

$sel:targetValue:TargetTrackingConfiguration', targetTrackingConfiguration_targetValue - The target value for the metric.

Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.

targetTrackingConfiguration_customizedMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe CustomizedMetricSpecification) Source #

A customized metric. You must specify either a predefined metric or a customized metric.

targetTrackingConfiguration_disableScaleIn :: Lens' TargetTrackingConfiguration (Maybe Bool) Source #

Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false.

targetTrackingConfiguration_predefinedMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe PredefinedMetricSpecification) Source #

A predefined metric. You must specify either a predefined metric or a customized metric.

targetTrackingConfiguration_targetValue :: Lens' TargetTrackingConfiguration Double Source #

The target value for the metric.

Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.