Package software.amazon.awscdk.services.emr

Interface CfnCluster.CloudWatchAlarmDefinitionProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnCluster.CloudWatchAlarmDefinitionProperty.Jsii$Proxy
Enclosing class:
CfnCluster
@Stability(Stable) public static interface CfnCluster.CloudWatchAlarmDefinitionProperty extends software.amazon.jsii.JsiiSerializable
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();

  • Method Details

    • getComparisonOperator

      @Stability(Stable) @NotNull String getComparisonOperator()
      Determines how the metric specified by MetricName is compared to the value specified by Threshold .

    • getMetricName

      @Stability(Stable) @NotNull String getMetricName()
      The name of the CloudWatch metric that is watched to determine an alarm condition.

    • getPeriod

      @Stability(Stable) @NotNull Number getPeriod()
      The period, in seconds, over which the statistic is applied.

      CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300 .

    • getThreshold

      @Stability(Stable) @NotNull Number getThreshold()
      The value against which the specified statistic is compared.

    • getDimensions

      @Stability(Stable) @Nullable default Object getDimensions()
      A CloudWatch metric dimension.

    • getEvaluationPeriods

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default String getNamespace()
      The namespace for the CloudWatch metric.

      The default is AWS/ElasticMapReduce .

    • getStatistic

      @Stability(Stable) @Nullable default String getStatistic()
      The statistic to apply to the metric associated with the alarm.

      The default is AVERAGE .

    • getUnit

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) static CfnCluster.CloudWatchAlarmDefinitionProperty.Builder builder()
      Returns:
      a CfnCluster.CloudWatchAlarmDefinitionProperty.Builder of CfnCluster.CloudWatchAlarmDefinitionProperty