Amazonka.EMR.Types.CloudWatchAlarmDefinition

Documentation

data CloudWatchAlarmDefinition

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

See: newCloudWatchAlarmDefinition smart constructor.

Constructors

CloudWatchAlarmDefinition'

Fields

• dimensions :: Maybe [MetricDimension]

  A CloudWatch metric dimension.

• evaluationPeriods :: Maybe Int

  The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

• namespace :: Maybe Text

  The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

• statistic :: Maybe Statistic

  The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

• unit :: Maybe Unit

  The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

• comparisonOperator :: ComparisonOperator

  Determines how the metric specified by MetricName is compared to the value specified by Threshold.

• metricName :: Text

  The name of the CloudWatch metric that is watched to determine an alarm condition.

• period :: Int

  The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

• threshold :: Double

  The value against which the specified statistic is compared.

Instances

FromJSON CloudWatchAlarmDefinition

Defined in Amazonka.EMR.Types.CloudWatchAlarmDefinition

Methods

parseJSON :: Value -> Parser CloudWatchAlarmDefinition

parseJSONList :: Value -> Parser [CloudWatchAlarmDefinition]

ToJSON CloudWatchAlarmDefinition

Defined in Amazonka.EMR.Types.CloudWatchAlarmDefinition

Methods

toJSON :: CloudWatchAlarmDefinition -> Value

toEncoding :: CloudWatchAlarmDefinition -> Encoding

toJSONList :: [CloudWatchAlarmDefinition] -> Value

toEncodingList :: [CloudWatchAlarmDefinition] -> Encoding

Generic CloudWatchAlarmDefinition

Defined in Amazonka.EMR.Types.CloudWatchAlarmDefinition

Associated Types

type Rep CloudWatchAlarmDefinition :: Type -> Type

Methods

from :: CloudWatchAlarmDefinition -> Rep CloudWatchAlarmDefinition x

to :: Rep CloudWatchAlarmDefinition x -> CloudWatchAlarmDefinition

Read CloudWatchAlarmDefinition

Defined in Amazonka.EMR.Types.CloudWatchAlarmDefinition

Methods

readsPrec :: Int -> ReadS CloudWatchAlarmDefinition

readList :: ReadS [CloudWatchAlarmDefinition]

readPrec :: ReadPrec CloudWatchAlarmDefinition

readListPrec :: ReadPrec [CloudWatchAlarmDefinition]

Show CloudWatchAlarmDefinition

Defined in Amazonka.EMR.Types.CloudWatchAlarmDefinition

Methods

showsPrec :: Int -> CloudWatchAlarmDefinition -> ShowS

show :: CloudWatchAlarmDefinition -> String

showList :: [CloudWatchAlarmDefinition] -> ShowS

NFData CloudWatchAlarmDefinition

Defined in Amazonka.EMR.Types.CloudWatchAlarmDefinition

Methods

rnf :: CloudWatchAlarmDefinition -> ()

Eq CloudWatchAlarmDefinition

Defined in Amazonka.EMR.Types.CloudWatchAlarmDefinition

Methods

(==) :: CloudWatchAlarmDefinition -> CloudWatchAlarmDefinition -> Bool

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

Hashable CloudWatchAlarmDefinition

Defined in Amazonka.EMR.Types.CloudWatchAlarmDefinition

Methods

hashWithSalt :: Int -> CloudWatchAlarmDefinition -> Int

hash :: CloudWatchAlarmDefinition -> Int

type Rep CloudWatchAlarmDefinition

Defined in Amazonka.EMR.Types.CloudWatchAlarmDefinition

type Rep CloudWatchAlarmDefinition = D1 ('MetaData "CloudWatchAlarmDefinition" "Amazonka.EMR.Types.CloudWatchAlarmDefinition" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "CloudWatchAlarmDefinition'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDimension])) :*: S1 ('MetaSel ('Just "evaluationPeriods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statistic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Statistic)))) :*: ((S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Unit)) :*: S1 ('MetaSel ('Just "comparisonOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ComparisonOperator)) :*: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "threshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))))))

newCloudWatchAlarmDefinition

Arguments

:: ComparisonOperator

$sel:comparisonOperator:CloudWatchAlarmDefinition'

-> Text

$sel:metricName:CloudWatchAlarmDefinition'

-> Int

$sel:period:CloudWatchAlarmDefinition'

-> Double

$sel:threshold:CloudWatchAlarmDefinition'

-> CloudWatchAlarmDefinition

Create a value of CloudWatchAlarmDefinition 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:dimensions:CloudWatchAlarmDefinition', cloudWatchAlarmDefinition_dimensions - A CloudWatch metric dimension.

$sel:evaluationPeriods:CloudWatchAlarmDefinition', cloudWatchAlarmDefinition_evaluationPeriods - The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

$sel:namespace:CloudWatchAlarmDefinition', cloudWatchAlarmDefinition_namespace - The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

$sel:statistic:CloudWatchAlarmDefinition', cloudWatchAlarmDefinition_statistic - The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

$sel:unit:CloudWatchAlarmDefinition', cloudWatchAlarmDefinition_unit - The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

$sel:comparisonOperator:CloudWatchAlarmDefinition', cloudWatchAlarmDefinition_comparisonOperator - Determines how the metric specified by MetricName is compared to the value specified by Threshold.

$sel:metricName:CloudWatchAlarmDefinition', cloudWatchAlarmDefinition_metricName - The name of the CloudWatch metric that is watched to determine an alarm condition.

$sel:period:CloudWatchAlarmDefinition', cloudWatchAlarmDefinition_period - The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

$sel:threshold:CloudWatchAlarmDefinition', cloudWatchAlarmDefinition_threshold - The value against which the specified statistic is compared.

cloudWatchAlarmDefinition_dimensions :: Lens' CloudWatchAlarmDefinition (Maybe [MetricDimension])

A CloudWatch metric dimension.

cloudWatchAlarmDefinition_evaluationPeriods :: Lens' CloudWatchAlarmDefinition (Maybe Int)

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

cloudWatchAlarmDefinition_namespace :: Lens' CloudWatchAlarmDefinition (Maybe Text)

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

cloudWatchAlarmDefinition_statistic :: Lens' CloudWatchAlarmDefinition (Maybe Statistic)

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

cloudWatchAlarmDefinition_unit :: Lens' CloudWatchAlarmDefinition (Maybe Unit)

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

cloudWatchAlarmDefinition_comparisonOperator :: Lens' CloudWatchAlarmDefinition ComparisonOperator

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

cloudWatchAlarmDefinition_metricName :: Lens' CloudWatchAlarmDefinition Text

The name of the CloudWatch metric that is watched to determine an alarm condition.

cloudWatchAlarmDefinition_period :: Lens' CloudWatchAlarmDefinition Int

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

cloudWatchAlarmDefinition_threshold :: Lens' CloudWatchAlarmDefinition Double

The value against which the specified statistic is compared.