software.amazon.awscdk.services.emr

Interface CfnCluster.CloudWatchAlarmDefinitionProperty

All Known Implementing Classes:

CfnCluster.CloudWatchAlarmDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnCluster

public static interface CfnCluster.CloudWatchAlarmDefinitionProperty

`CloudWatchAlarmDefinition` is a subproperty of the `ScalingTrigger` property, which determines when to trigger an automatic scaling activity.

Scaling activity begins when you satisfy the defined alarm conditions.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.emr.*;
 CloudWatchAlarmDefinitionProperty cloudWatchAlarmDefinitionProperty = CloudWatchAlarmDefinitionProperty.builder()
         .comparisonOperator("comparisonOperator")
         .metricName("metricName")
         .period(123)
         .threshold(123)
         // the properties below are optional
         .dimensions(List.of(MetricDimensionProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .evaluationPeriods(123)
         .namespace("namespace")
         .statistic("statistic")
         .unit("unit")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCluster.CloudWatchAlarmDefinitionProperty.Builder A builder for CfnCluster.CloudWatchAlarmDefinitionProperty
static class	CfnCluster.CloudWatchAlarmDefinitionProperty.Jsii$Proxy An implementation for CfnCluster.CloudWatchAlarmDefinitionProperty

Method Summary

Modifier and Type	Method and Description
static CfnCluster.CloudWatchAlarmDefinitionProperty.Builder	builder()
java.lang.String	getComparisonOperator() Determines how the metric specified by `MetricName` is compared to the value specified by `Threshold` .
default java.lang.Object	getDimensions() A CloudWatch metric dimension.
default java.lang.Number	getEvaluationPeriods() The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity.
java.lang.String	getMetricName() The name of the CloudWatch metric that is watched to determine an alarm condition.
default java.lang.String	getNamespace() The namespace for the CloudWatch metric.
java.lang.Number	getPeriod() The period, in seconds, over which the statistic is applied.
default java.lang.String	getStatistic() The statistic to apply to the metric associated with the alarm.
java.lang.Number	getThreshold() The value against which the specified statistic is compared.
default java.lang.String	getUnit() The unit of measure associated with the CloudWatch metric being watched.

Method Detail

getComparisonOperator

java.lang.String getComparisonOperator()

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

getMetricName

java.lang.String getMetricName()

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

getPeriod

java.lang.Number getPeriod()

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 .

getThreshold

java.lang.Number getThreshold()

The value against which the specified statistic is compared.

getDimensions

default java.lang.Object getDimensions()

A CloudWatch metric dimension.

getEvaluationPeriods

default java.lang.Number getEvaluationPeriods()

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 .

getNamespace

default java.lang.String getNamespace()

The namespace for the CloudWatch metric.

The default is AWS/ElasticMapReduce .

getStatistic

default java.lang.String getStatistic()

The statistic to apply to the metric associated with the alarm.

The default is AVERAGE .

getUnit

default java.lang.String getUnit()

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.

builder

static CfnCluster.CloudWatchAlarmDefinitionProperty.Builder builder()

Returns:

a CfnCluster.CloudWatchAlarmDefinitionProperty.Builder of CfnCluster.CloudWatchAlarmDefinitionProperty