software.amazon.awscdk.services.stepfunctions.tasks

Interface EmrCreateCluster.ScalingRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EmrCreateCluster.ScalingRuleProperty.Jsii$Proxy

Enclosing class:

EmrCreateCluster

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

A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments.

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.*;
 ScalingRuleProperty scalingRuleProperty = ScalingRuleProperty.builder()
         .action(ScalingActionProperty.builder()
                 .simpleScalingPolicyConfiguration(SimpleScalingPolicyConfigurationProperty.builder()
                         .scalingAdjustment(123)
                         // the properties below are optional
                         .adjustmentType(EmrCreateCluster.getScalingAdjustmentType().CHANGE_IN_CAPACITY)
                         .coolDown(123)
                         .build())
                 // the properties below are optional
                 .market(EmrCreateCluster.getInstanceMarket().ON_DEMAND)
                 .build())
         .name("name")
         .trigger(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())
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EmrCreateCluster.ScalingRuleProperty.Builder	builder()
EmrCreateCluster.ScalingActionProperty	getAction() The conditions that trigger an automatic scaling activity.
default String	getDescription() A friendly, more verbose description of the automatic scaling rule.
String	getName() The name used to identify an automatic scaling rule.
EmrCreateCluster.ScalingTriggerProperty	getTrigger() The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAction

@Stability(value=Stable)
 @NotNull
EmrCreateCluster.ScalingActionProperty getAction()

The conditions that trigger an automatic scaling activity.

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name used to identify an automatic scaling rule.

Rule names must be unique within a scaling policy.

getTrigger

@Stability(value=Stable)
 @NotNull
EmrCreateCluster.ScalingTriggerProperty getTrigger()

The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A friendly, more verbose description of the automatic scaling rule.

Default: - None

builder

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

Returns:

a EmrCreateCluster.ScalingRuleProperty.Builder of EmrCreateCluster.ScalingRuleProperty