Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AutoScaling.EnableMetricsCollection

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Enables group metrics collection for the specified Auto Scaling group.

You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Creating a Request

data EnableMetricsCollection Source #

See: newEnableMetricsCollection smart constructor.

Constructors

EnableMetricsCollection'

Fields

metrics :: Maybe [Text]

Identifies the metrics to enable.

You can specify one or more of the following metrics:

```
GroupMinSize
```
```
GroupMaxSize
```
```
GroupDesiredCapacity
```
```
GroupInServiceInstances
```
```
GroupPendingInstances
```
```
GroupStandbyInstances
```
```
GroupTerminatingInstances
```
```
GroupTotalInstances
```
```
GroupInServiceCapacity
```
```
GroupPendingCapacity
```
```
GroupStandbyCapacity
```
```
GroupTerminatingCapacity
```
```
GroupTotalCapacity
```
```
WarmPoolDesiredCapacity
```
```
WarmPoolWarmedCapacity
```
```
WarmPoolPendingCapacity
```
```
WarmPoolTerminatingCapacity
```
```
WarmPoolTotalCapacity
```
```
GroupAndWarmPoolDesiredCapacity
```
```
GroupAndWarmPoolTotalCapacity
```

If you specify Granularity and don't specify any metrics, all metrics are enabled.

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

autoScalingGroupName :: Text
The name of the Auto Scaling group.
granularity :: Text
The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute.

Instances

Instances details

ToHeaders EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods toHeaders :: EnableMetricsCollection -> [Header] #
ToPath EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods toPath :: EnableMetricsCollection -> ByteString #
ToQuery EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods toQuery :: EnableMetricsCollection -> QueryString #
AWSRequest EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Associated Types type AWSResponse EnableMetricsCollection # Methods request :: (Service -> Service) -> EnableMetricsCollection -> Request EnableMetricsCollection # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy EnableMetricsCollection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableMetricsCollection))) #
Generic EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Associated Types type Rep EnableMetricsCollection :: Type -> Type # Methods from :: EnableMetricsCollection -> Rep EnableMetricsCollection x # to :: Rep EnableMetricsCollection x -> EnableMetricsCollection #
Read EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods readsPrec :: Int -> ReadS EnableMetricsCollection # readList :: ReadS [EnableMetricsCollection] # readPrec :: ReadPrec EnableMetricsCollection # readListPrec :: ReadPrec [EnableMetricsCollection] #
Show EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods showsPrec :: Int -> EnableMetricsCollection -> ShowS # show :: EnableMetricsCollection -> String # showList :: [EnableMetricsCollection] -> ShowS #
NFData EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods rnf :: EnableMetricsCollection -> () #
Eq EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods (==) :: EnableMetricsCollection -> EnableMetricsCollection -> Bool # (/=) :: EnableMetricsCollection -> EnableMetricsCollection -> Bool #
Hashable EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods hashWithSalt :: Int -> EnableMetricsCollection -> Int # hash :: EnableMetricsCollection -> Int #
type AWSResponse EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection type AWSResponse EnableMetricsCollection = EnableMetricsCollectionResponse
type Rep EnableMetricsCollection Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection type Rep EnableMetricsCollection = D1 ('MetaData "EnableMetricsCollection" "Amazonka.AutoScaling.EnableMetricsCollection" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" '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))))

newEnableMetricsCollection Source #

Arguments

:: Text	`EnableMetricsCollection`
-> Text	`EnableMetricsCollection`
-> EnableMetricsCollection

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:

EnableMetricsCollection, enableMetricsCollection_metrics - Identifies the metrics to enable.

You can specify one or more of the following metrics:

```
GroupMinSize
```
```
GroupMaxSize
```
```
GroupDesiredCapacity
```
```
GroupInServiceInstances
```
```
GroupPendingInstances
```
```
GroupStandbyInstances
```
```
GroupTerminatingInstances
```
```
GroupTotalInstances
```
```
GroupInServiceCapacity
```
```
GroupPendingCapacity
```
```
GroupStandbyCapacity
```
```
GroupTerminatingCapacity
```
```
GroupTotalCapacity
```
```
WarmPoolDesiredCapacity
```
```
WarmPoolWarmedCapacity
```
```
WarmPoolPendingCapacity
```
```
WarmPoolTerminatingCapacity
```
```
WarmPoolTotalCapacity
```
```
GroupAndWarmPoolDesiredCapacity
```
```
GroupAndWarmPoolTotalCapacity
```

If you specify Granularity and don't specify any metrics, all metrics are enabled.

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

EnableMetricsCollection, enableMetricsCollection_autoScalingGroupName - The name of the Auto Scaling group.

EnableMetricsCollection, enableMetricsCollection_granularity - The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute.

Request Lenses

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

Identifies the metrics to enable.

You can specify one or more of the following metrics:

```
GroupMinSize
```
```
GroupMaxSize
```
```
GroupDesiredCapacity
```
```
GroupInServiceInstances
```
```
GroupPendingInstances
```
```
GroupStandbyInstances
```
```
GroupTerminatingInstances
```
```
GroupTotalInstances
```
```
GroupInServiceCapacity
```
```
GroupPendingCapacity
```
```
GroupStandbyCapacity
```
```
GroupTerminatingCapacity
```
```
GroupTotalCapacity
```
```
WarmPoolDesiredCapacity
```
```
WarmPoolWarmedCapacity
```
```
WarmPoolPendingCapacity
```
```
WarmPoolTerminatingCapacity
```
```
WarmPoolTotalCapacity
```
```
GroupAndWarmPoolDesiredCapacity
```
```
GroupAndWarmPoolTotalCapacity
```

If you specify Granularity and don't specify any metrics, all metrics are enabled.

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

enableMetricsCollection_autoScalingGroupName :: Lens' EnableMetricsCollection Text Source #

The name of the Auto Scaling group.

enableMetricsCollection_granularity :: Lens' EnableMetricsCollection Text Source #

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute.

Destructuring the Response

data EnableMetricsCollectionResponse Source #

See: newEnableMetricsCollectionResponse smart constructor.

Constructors

EnableMetricsCollectionResponse'

Instances

Instances details

Generic EnableMetricsCollectionResponse Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Associated Types type Rep EnableMetricsCollectionResponse :: Type -> Type # Methods from :: EnableMetricsCollectionResponse -> Rep EnableMetricsCollectionResponse x # to :: Rep EnableMetricsCollectionResponse x -> EnableMetricsCollectionResponse #
Read EnableMetricsCollectionResponse Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods readsPrec :: Int -> ReadS EnableMetricsCollectionResponse # readList :: ReadS [EnableMetricsCollectionResponse] # readPrec :: ReadPrec EnableMetricsCollectionResponse # readListPrec :: ReadPrec [EnableMetricsCollectionResponse] #
Show EnableMetricsCollectionResponse Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods showsPrec :: Int -> EnableMetricsCollectionResponse -> ShowS # show :: EnableMetricsCollectionResponse -> String # showList :: [EnableMetricsCollectionResponse] -> ShowS #
NFData EnableMetricsCollectionResponse Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods rnf :: EnableMetricsCollectionResponse -> () #
Eq EnableMetricsCollectionResponse Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection Methods (==) :: EnableMetricsCollectionResponse -> EnableMetricsCollectionResponse -> Bool # (/=) :: EnableMetricsCollectionResponse -> EnableMetricsCollectionResponse -> Bool #
type Rep EnableMetricsCollectionResponse Source #
Instance details Defined in Amazonka.AutoScaling.EnableMetricsCollection type Rep EnableMetricsCollectionResponse = D1 ('MetaData "EnableMetricsCollectionResponse" "Amazonka.AutoScaling.EnableMetricsCollection" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" '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.