software.amazon.awscdk.services.stepfunctions.tasks

Interface EmrCreateCluster.ScalingTriggerProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EmrCreateCluster.ScalingTriggerProperty.Jsii$Proxy

Enclosing class:

EmrCreateCluster

@Stability(value=Stable)
public static interface EmrCreateCluster.ScalingTriggerProperty
extends software.amazon.jsii.JsiiSerializable

The conditions that trigger an automatic scaling activity and the definition of a CloudWatch metric alarm.

When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.

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.stepfunctions.tasks.*;
 import software.amazon.awscdk.core.*;
 ScalingTriggerProperty scalingTriggerProperty = ScalingTriggerProperty.builder()
         .cloudWatchAlarmDefinition(CloudWatchAlarmDefinitionProperty.builder()
                 .comparisonOperator(EmrCreateCluster.getCloudWatchAlarmComparisonOperator().GREATER_THAN_OR_EQUAL)
                 .metricName("metricName")
                 .period(Duration.minutes(30))
                 // the properties below are optional
                 .dimensions(List.of(MetricDimensionProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .evaluationPeriods(123)
                 .namespace("namespace")
                 .statistic(EmrCreateCluster.getCloudWatchAlarmStatistic().SAMPLE_COUNT)
                 .threshold(123)
                 .unit(EmrCreateCluster.getCloudWatchAlarmUnit().NONE)
                 .build())
         .build();
 

See Also:

https://docs.aws.amazon.com/emr/latest/APIReference/API_ScalingTrigger.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EmrCreateCluster.ScalingTriggerProperty.Builder	builder()
EmrCreateCluster.CloudWatchAlarmDefinitionProperty	getCloudWatchAlarmDefinition() The definition of a CloudWatch metric alarm.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCloudWatchAlarmDefinition

@Stability(value=Stable)
 @NotNull
EmrCreateCluster.CloudWatchAlarmDefinitionProperty getCloudWatchAlarmDefinition()

The definition of a CloudWatch metric alarm.

When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.

builder

@Stability(value=Stable)
static EmrCreateCluster.ScalingTriggerProperty.Builder builder()

Returns:

a EmrCreateCluster.ScalingTriggerProperty.Builder of EmrCreateCluster.ScalingTriggerProperty