software.amazon.awscdk.services.stepfunctions.tasks

Interface EmrCreateCluster.InstanceGroupConfigProperty

All Known Implementing Classes:

EmrCreateCluster.InstanceGroupConfigProperty.Jsii$Proxy

Enclosing class:

EmrCreateCluster

public static interface EmrCreateCluster.InstanceGroupConfigProperty

Configuration defining a new instance group.

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.*;
 ConfigurationProperty configurationProperty_;
 Size size;
 InstanceGroupConfigProperty instanceGroupConfigProperty = InstanceGroupConfigProperty.builder()
         .instanceCount(123)
         .instanceRole(EmrCreateCluster.getInstanceRoleType().MASTER)
         .instanceType("instanceType")
         // the properties below are optional
         .autoScalingPolicy(AutoScalingPolicyProperty.builder()
                 .constraints(ScalingConstraintsProperty.builder()
                         .maxCapacity(123)
                         .minCapacity(123)
                         .build())
                 .rules(List.of(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()))
                 .build())
         .bidPrice("bidPrice")
         .configurations(List.of(ConfigurationProperty.builder()
                 .classification("classification")
                 .configurations(List.of(configurationProperty_))
                 .properties(Map.of(
                         "propertiesKey", "properties"))
                 .build()))
         .ebsConfiguration(EbsConfigurationProperty.builder()
                 .ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
                         .volumeSpecification(VolumeSpecificationProperty.builder()
                                 .volumeSize(size)
                                 .volumeType(EmrCreateCluster.getEbsBlockDeviceVolumeType().GP2)
                                 // the properties below are optional
                                 .iops(123)
                                 .build())
                         // the properties below are optional
                         .volumesPerInstance(123)
                         .build()))
                 .ebsOptimized(false)
                 .build())
         .market(EmrCreateCluster.getInstanceMarket().ON_DEMAND)
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EmrCreateCluster.InstanceGroupConfigProperty.Builder	builder()
default EmrCreateCluster.AutoScalingPolicyProperty	getAutoScalingPolicy() An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.
default java.lang.String	getBidPrice() The bid price for each EC2 Spot instance type as defined by InstanceType.
default java.util.List<EmrCreateCluster.ConfigurationProperty>	getConfigurations() The list of configurations supplied for an EMR cluster instance group.
default EmrCreateCluster.EbsConfigurationProperty	getEbsConfiguration() EBS configurations that will be attached to each EC2 instance in the instance group.
java.lang.Number	getInstanceCount() Target number of instances for the instance group.
EmrCreateCluster.InstanceRoleType	getInstanceRole() The role of the instance group in the cluster.
java.lang.String	getInstanceType() The EC2 instance type for all instances in the instance group.
default EmrCreateCluster.InstanceMarket	getMarket() Market type of the EC2 instances used to create a cluster node.
default java.lang.String	getName() Friendly name given to the instance group.

Method Detail

getInstanceCount

java.lang.Number getInstanceCount()

Target number of instances for the instance group.

getInstanceRole

EmrCreateCluster.InstanceRoleType getInstanceRole()

The role of the instance group in the cluster.

getInstanceType

java.lang.String getInstanceType()

The EC2 instance type for all instances in the instance group.

getAutoScalingPolicy

default EmrCreateCluster.AutoScalingPolicyProperty getAutoScalingPolicy()

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.

Default: - None

getBidPrice

default java.lang.String getBidPrice()

The bid price for each EC2 Spot instance type as defined by InstanceType.

Expressed in USD.

Default: - None

getConfigurations

default java.util.List<EmrCreateCluster.ConfigurationProperty> getConfigurations()

The list of configurations supplied for an EMR cluster instance group.

Default: - None

getEbsConfiguration

default EmrCreateCluster.EbsConfigurationProperty getEbsConfiguration()

EBS configurations that will be attached to each EC2 instance in the instance group.

Default: - None

getMarket

default EmrCreateCluster.InstanceMarket getMarket()

Market type of the EC2 instances used to create a cluster node.

Default: - EMR selected default

getName

default java.lang.String getName()

Friendly name given to the instance group.

Default: - None

builder

static EmrCreateCluster.InstanceGroupConfigProperty.Builder builder()

Returns:

a EmrCreateCluster.InstanceGroupConfigProperty.Builder of EmrCreateCluster.InstanceGroupConfigProperty