libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AutoScaling.EnableMetricsCollection

Description

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Synopsis

Creating a Request

data EnableMetricsCollection Source #

See: newEnableMetricsCollection smart constructor.

Constructors

EnableMetricsCollection' 

Fields

  • metrics :: Maybe [Text]

    Specifies which group-level metrics to start collecting. You can specify one or more of the following metrics:

    • GroupMinSize
    • GroupMaxSize
    • GroupDesiredCapacity
    • GroupInServiceInstances
    • GroupPendingInstances
    • GroupStandbyInstances
    • GroupTerminatingInstances
    • GroupTotalInstances

    The instance weighting feature supports the following additional metrics:

    • GroupInServiceCapacity
    • GroupPendingCapacity
    • GroupStandbyCapacity
    • GroupTerminatingCapacity
    • GroupTotalCapacity

    The warm pools feature supports the following additional metrics:

    • WarmPoolDesiredCapacity
    • WarmPoolWarmedCapacity
    • WarmPoolPendingCapacity
    • WarmPoolTerminatingCapacity
    • WarmPoolTotalCapacity
    • GroupAndWarmPoolDesiredCapacity
    • GroupAndWarmPoolTotalCapacity

    If you omit this parameter, all metrics are enabled.

  • autoScalingGroupName :: Text

    The name of the Auto Scaling group.

  • granularity :: Text

    The granularity to associate with the metrics to collect. The only valid value is 1Minute.

Instances

Instances details
Eq EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

Read EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

Show EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

Generic EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

Associated Types

type Rep EnableMetricsCollection :: Type -> Type #

NFData EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

Methods

rnf :: EnableMetricsCollection -> () #

Hashable EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

AWSRequest EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

ToHeaders EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

ToPath EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

ToQuery EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

type Rep EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

type Rep EnableMetricsCollection = D1 ('MetaData "EnableMetricsCollection" "Amazonka.AutoScaling.EnableMetricsCollection" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "EnableMetricsCollection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "granularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse EnableMetricsCollection Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

newEnableMetricsCollection Source #

Create a value of EnableMetricsCollection 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:metrics:EnableMetricsCollection', enableMetricsCollection_metrics - Specifies which group-level metrics to start collecting. You can specify one or more of the following metrics:

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances

The instance weighting feature supports the following additional metrics:

  • GroupInServiceCapacity
  • GroupPendingCapacity
  • GroupStandbyCapacity
  • GroupTerminatingCapacity
  • GroupTotalCapacity

The warm pools feature supports the following additional metrics:

  • WarmPoolDesiredCapacity
  • WarmPoolWarmedCapacity
  • WarmPoolPendingCapacity
  • WarmPoolTerminatingCapacity
  • WarmPoolTotalCapacity
  • GroupAndWarmPoolDesiredCapacity
  • GroupAndWarmPoolTotalCapacity

If you omit this parameter, all metrics are enabled.

$sel:autoScalingGroupName:EnableMetricsCollection', enableMetricsCollection_autoScalingGroupName - The name of the Auto Scaling group.

$sel:granularity:EnableMetricsCollection', enableMetricsCollection_granularity - The granularity to associate with the metrics to collect. The only valid value is 1Minute.

Request Lenses

enableMetricsCollection_metrics :: Lens' EnableMetricsCollection (Maybe [Text]) Source #

Specifies which group-level metrics to start collecting. You can specify one or more of the following metrics:

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances

The instance weighting feature supports the following additional metrics:

  • GroupInServiceCapacity
  • GroupPendingCapacity
  • GroupStandbyCapacity
  • GroupTerminatingCapacity
  • GroupTotalCapacity

The warm pools feature supports the following additional metrics:

  • WarmPoolDesiredCapacity
  • WarmPoolWarmedCapacity
  • WarmPoolPendingCapacity
  • WarmPoolTerminatingCapacity
  • WarmPoolTotalCapacity
  • GroupAndWarmPoolDesiredCapacity
  • GroupAndWarmPoolTotalCapacity

If you omit this parameter, all metrics are enabled.

enableMetricsCollection_granularity :: Lens' EnableMetricsCollection Text Source #

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

Destructuring the Response

data EnableMetricsCollectionResponse Source #

See: newEnableMetricsCollectionResponse smart constructor.

Instances

Instances details
Eq EnableMetricsCollectionResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

Read EnableMetricsCollectionResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

Show EnableMetricsCollectionResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

Generic EnableMetricsCollectionResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

Associated Types

type Rep EnableMetricsCollectionResponse :: Type -> Type #

NFData EnableMetricsCollectionResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

type Rep EnableMetricsCollectionResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnableMetricsCollection

type Rep EnableMetricsCollectionResponse = D1 ('MetaData "EnableMetricsCollectionResponse" "Amazonka.AutoScaling.EnableMetricsCollection" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "EnableMetricsCollectionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newEnableMetricsCollectionResponse :: EnableMetricsCollectionResponse Source #

Create a value of EnableMetricsCollectionResponse with all optional fields omitted.

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