Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon EMR Resource Types Reference » AWS::EMR::Cluster » Amazon EMR Cluster CloudWatchAlarmDefinition

Amazon EMR Cluster CloudWatchAlarmDefinition

CloudWatchAlarmDefinition is a subproperty of the Amazon EMR Cluster ScalingTrigger property, which determines when to trigger an automatic scaling activity. Scaling activity begins when you satisfy the defined alarm conditions.

Syntax

JSON

{
  "ComparisonOperator" : String,
  "Dimensions" : [ MetricDimension, ... ],
  "EvaluationPeriods" : Integer,
  "MetricName" : String,
  "Namespace" : String,
  "Period" : Integer,
  "Statistic" : String,
  "Threshold" : Double,
  "Unit" : String
}

YAML


  ComparisonOperator: String
  Dimensions: 
    - MetricDimension
  EvaluationPeriods: Integer
  MetricName: String
  Namespace: String
  Period: Integer
  Statistic: String
  Threshold: Double
  Unit: String

Properties

ComparisonOperator

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

Valid values: GREATER_THAN_OR_EQUAL, GREATER_THAN, LESS_THAN, or LESS_THAN_OR_EQUAL.

Required: Yes

Type: String

Dimensions

A list of CloudWatch metric dimensions.

Required: No

Type: List of Amazon EMR Cluster MetricDimension

EvaluationPeriods

The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

Required: No

Type: Integer

MetricName

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

Required: Yes

Type: String

Namespace

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

Required: No

Type: String

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.

Required: Yes

Type: Integer

Statistic

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

Valid values: SAMPLE_COUNT, AVERAGE, SUM, MINIMUM, or MAXIMUM.

Required: No

Type: String

Threshold

The value against which the specified statistic is compared.

Required: Yes

Type: Double

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.

For more information, see CloudWatchAlarmDefinition in the Amazon Elastic MapReduce Documentation API Reference.

Required: No

Type: String

On this page: