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();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnCluster.CloudWatchAlarmDefinitionProperty
static final class
An implementation forCfnCluster.CloudWatchAlarmDefinitionProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Determines how the metric specified byMetricName
is compared to the value specified byThreshold
.default Object
A CloudWatch metric dimension.default Number
The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity.The name of the CloudWatch metric that is watched to determine an alarm condition.default String
The namespace for the CloudWatch metric.The period, in seconds, over which the statistic is applied.default String
The statistic to apply to the metric associated with the alarm.The value against which the specified statistic is compared.default String
getUnit()
The unit of measure associated with the CloudWatch metric being watched.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComparisonOperator
Determines how the metric specified byMetricName
is compared to the value specified byThreshold
.- See Also:
-
getMetricName
The name of the CloudWatch metric that is watched to determine an alarm condition.- See Also:
-
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
.- See Also:
-
getThreshold
The value against which the specified statistic is compared.- See Also:
-
getDimensions
A CloudWatch metric dimension.- See Also:
-
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
.- See Also:
-
getNamespace
The namespace for the CloudWatch metric.The default is
AWS/ElasticMapReduce
.- See Also:
-
getStatistic
The statistic to apply to the metric associated with the alarm.The default is
AVERAGE
.- See Also:
-
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.- See Also:
-
builder
-