software.amazon.awscdk.services.emr

Interface CfnInstanceGroupConfig.ScalingRuleProperty

All Known Implementing Classes:

CfnInstanceGroupConfig.ScalingRuleProperty.Jsii$Proxy

Enclosing class:

CfnInstanceGroupConfig

public static interface CfnInstanceGroupConfig.ScalingRuleProperty

`ScalingRule` is a subproperty of the `AutoScalingPolicy` property type.

ScalingRule defines the scale-in or scale-out rules for scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getAction

java.lang.Object getAction()

The conditions that trigger an automatic scaling activity.

getName

java.lang.String getName()

The name used to identify an automatic scaling rule.

Rule names must be unique within a scaling policy.

getTrigger

java.lang.Object getTrigger()

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

getDescription

default java.lang.String getDescription()

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

builder

static CfnInstanceGroupConfig.ScalingRuleProperty.Builder builder()

Returns:

a CfnInstanceGroupConfig.ScalingRuleProperty.Builder of CfnInstanceGroupConfig.ScalingRuleProperty