Package software.amazon.awscdk.services.emr

Class CfnCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.emr.CfnCluster

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.546Z")
@Stability(Stable)
public class CfnCluster
extends CfnResource
implements IInspectable

A CloudFormation AWS::EMR::Cluster.

The AWS::EMR::Cluster resource specifies an Amazon EMR cluster. This cluster is a collection of Amazon EC2 instances that run open source big data frameworks and applications to process and analyze vast amounts of data. For more information, see the Amazon EMR Management Guide .

Amazon EMR now supports launching task instance groups and task instance fleets as part of the AWS::EMR::Cluster resource. This can be done by using the JobFlowInstancesConfig property type's TaskInstanceGroups and TaskInstanceFleets subproperties. Using these subproperties reduces delays in provisioning task nodes compared to specifying task nodes with the AWS::EMR::InstanceGroupConfig and AWS::EMR::InstanceFleetConfig resources. Please refer to the examples at the bottom of this page to learn how to use these subproperties.

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.*;
 Object additionalInfo;
 ConfigurationProperty configurationProperty_;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .instances(JobFlowInstancesConfigProperty.builder()
                 .additionalMasterSecurityGroups(List.of("additionalMasterSecurityGroups"))
                 .additionalSlaveSecurityGroups(List.of("additionalSlaveSecurityGroups"))
                 .coreInstanceFleet(InstanceFleetConfigProperty.builder()
                         .instanceTypeConfigs(List.of(InstanceTypeConfigProperty.builder()
                                 .instanceType("instanceType")
                                 // the properties below are optional
                                 .bidPrice("bidPrice")
                                 .bidPriceAsPercentageOfOnDemandPrice(123)
                                 .configurations(List.of(ConfigurationProperty.builder()
                                         .classification("classification")
                                         .configurationProperties(Map.of(
                                                 "configurationPropertiesKey", "configurationProperties"))
                                         .configurations(List.of(configurationProperty_))
                                         .build()))
                                 .customAmiId("customAmiId")
                                 .ebsConfiguration(EbsConfigurationProperty.builder()
                                         .ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
                                                 .volumeSpecification(VolumeSpecificationProperty.builder()
                                                         .sizeInGb(123)
                                                         .volumeType("volumeType")
                                                         // the properties below are optional
                                                         .iops(123)
                                                         .build())
                                                 // the properties below are optional
                                                 .volumesPerInstance(123)
                                                 .build()))
                                         .ebsOptimized(false)
                                         .build())
                                 .weightedCapacity(123)
                                 .build()))
                         .launchSpecifications(InstanceFleetProvisioningSpecificationsProperty.builder()
                                 .onDemandSpecification(OnDemandProvisioningSpecificationProperty.builder()
                                         .allocationStrategy("allocationStrategy")
                                         .build())
                                 .spotSpecification(SpotProvisioningSpecificationProperty.builder()
                                         .timeoutAction("timeoutAction")
                                         .timeoutDurationMinutes(123)
                                         // the properties below are optional
                                         .allocationStrategy("allocationStrategy")
                                         .blockDurationMinutes(123)
                                         .build())
                                 .build())
                         .name("name")
                         .targetOnDemandCapacity(123)
                         .targetSpotCapacity(123)
                         .build())
                 .coreInstanceGroup(InstanceGroupConfigProperty.builder()
                         .instanceCount(123)
                         .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("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()))
                                 .build())
                         .bidPrice("bidPrice")
                         .configurations(List.of(ConfigurationProperty.builder()
                                 .classification("classification")
                                 .configurationProperties(Map.of(
                                         "configurationPropertiesKey", "configurationProperties"))
                                 .configurations(List.of(configurationProperty_))
                                 .build()))
                         .customAmiId("customAmiId")
                         .ebsConfiguration(EbsConfigurationProperty.builder()
                                 .ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
                                         .volumeSpecification(VolumeSpecificationProperty.builder()
                                                 .sizeInGb(123)
                                                 .volumeType("volumeType")
                                                 // the properties below are optional
                                                 .iops(123)
                                                 .build())
                                         // the properties below are optional
                                         .volumesPerInstance(123)
                                         .build()))
                                 .ebsOptimized(false)
                                 .build())
                         .market("market")
                         .name("name")
                         .build())
                 .ec2KeyName("ec2KeyName")
                 .ec2SubnetId("ec2SubnetId")
                 .ec2SubnetIds(List.of("ec2SubnetIds"))
                 .emrManagedMasterSecurityGroup("emrManagedMasterSecurityGroup")
                 .emrManagedSlaveSecurityGroup("emrManagedSlaveSecurityGroup")
                 .hadoopVersion("hadoopVersion")
                 .keepJobFlowAliveWhenNoSteps(false)
                 .masterInstanceFleet(InstanceFleetConfigProperty.builder()
                         .instanceTypeConfigs(List.of(InstanceTypeConfigProperty.builder()
                                 .instanceType("instanceType")
                                 // the properties below are optional
                                 .bidPrice("bidPrice")
                                 .bidPriceAsPercentageOfOnDemandPrice(123)
                                 .configurations(List.of(ConfigurationProperty.builder()
                                         .classification("classification")
                                         .configurationProperties(Map.of(
                                                 "configurationPropertiesKey", "configurationProperties"))
                                         .configurations(List.of(configurationProperty_))
                                         .build()))
                                 .customAmiId("customAmiId")
                                 .ebsConfiguration(EbsConfigurationProperty.builder()
                                         .ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
                                                 .volumeSpecification(VolumeSpecificationProperty.builder()
                                                         .sizeInGb(123)
                                                         .volumeType("volumeType")
                                                         // the properties below are optional
                                                         .iops(123)
                                                         .build())
                                                 // the properties below are optional
                                                 .volumesPerInstance(123)
                                                 .build()))
                                         .ebsOptimized(false)
                                         .build())
                                 .weightedCapacity(123)
                                 .build()))
                         .launchSpecifications(InstanceFleetProvisioningSpecificationsProperty.builder()
                                 .onDemandSpecification(OnDemandProvisioningSpecificationProperty.builder()
                                         .allocationStrategy("allocationStrategy")
                                         .build())
                                 .spotSpecification(SpotProvisioningSpecificationProperty.builder()
                                         .timeoutAction("timeoutAction")
                                         .timeoutDurationMinutes(123)
                                         // the properties below are optional
                                         .allocationStrategy("allocationStrategy")
                                         .blockDurationMinutes(123)
                                         .build())
                                 .build())
                         .name("name")
                         .targetOnDemandCapacity(123)
                         .targetSpotCapacity(123)
                         .build())
                 .masterInstanceGroup(InstanceGroupConfigProperty.builder()
                         .instanceCount(123)
                         .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("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()))
                                 .build())
                         .bidPrice("bidPrice")
                         .configurations(List.of(ConfigurationProperty.builder()
                                 .classification("classification")
                                 .configurationProperties(Map.of(
                                         "configurationPropertiesKey", "configurationProperties"))
                                 .configurations(List.of(configurationProperty_))
                                 .build()))
                         .customAmiId("customAmiId")
                         .ebsConfiguration(EbsConfigurationProperty.builder()
                                 .ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
                                         .volumeSpecification(VolumeSpecificationProperty.builder()
                                                 .sizeInGb(123)
                                                 .volumeType("volumeType")
                                                 // the properties below are optional
                                                 .iops(123)
                                                 .build())
                                         // the properties below are optional
                                         .volumesPerInstance(123)
                                         .build()))
                                 .ebsOptimized(false)
                                 .build())
                         .market("market")
                         .name("name")
                         .build())
                 .placement(PlacementTypeProperty.builder()
                         .availabilityZone("availabilityZone")
                         .build())
                 .serviceAccessSecurityGroup("serviceAccessSecurityGroup")
                 .taskInstanceFleets(List.of(InstanceFleetConfigProperty.builder()
                         .instanceTypeConfigs(List.of(InstanceTypeConfigProperty.builder()
                                 .instanceType("instanceType")
                                 // the properties below are optional
                                 .bidPrice("bidPrice")
                                 .bidPriceAsPercentageOfOnDemandPrice(123)
                                 .configurations(List.of(ConfigurationProperty.builder()
                                         .classification("classification")
                                         .configurationProperties(Map.of(
                                                 "configurationPropertiesKey", "configurationProperties"))
                                         .configurations(List.of(configurationProperty_))
                                         .build()))
                                 .customAmiId("customAmiId")
                                 .ebsConfiguration(EbsConfigurationProperty.builder()
                                         .ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
                                                 .volumeSpecification(VolumeSpecificationProperty.builder()
                                                         .sizeInGb(123)
                                                         .volumeType("volumeType")
                                                         // the properties below are optional
                                                         .iops(123)
                                                         .build())
                                                 // the properties below are optional
                                                 .volumesPerInstance(123)
                                                 .build()))
                                         .ebsOptimized(false)
                                         .build())
                                 .weightedCapacity(123)
                                 .build()))
                         .launchSpecifications(InstanceFleetProvisioningSpecificationsProperty.builder()
                                 .onDemandSpecification(OnDemandProvisioningSpecificationProperty.builder()
                                         .allocationStrategy("allocationStrategy")
                                         .build())
                                 .spotSpecification(SpotProvisioningSpecificationProperty.builder()
                                         .timeoutAction("timeoutAction")
                                         .timeoutDurationMinutes(123)
                                         // the properties below are optional
                                         .allocationStrategy("allocationStrategy")
                                         .blockDurationMinutes(123)
                                         .build())
                                 .build())
                         .name("name")
                         .targetOnDemandCapacity(123)
                         .targetSpotCapacity(123)
                         .build()))
                 .taskInstanceGroups(List.of(InstanceGroupConfigProperty.builder()
                         .instanceCount(123)
                         .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("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()))
                                 .build())
                         .bidPrice("bidPrice")
                         .configurations(List.of(ConfigurationProperty.builder()
                                 .classification("classification")
                                 .configurationProperties(Map.of(
                                         "configurationPropertiesKey", "configurationProperties"))
                                 .configurations(List.of(configurationProperty_))
                                 .build()))
                         .customAmiId("customAmiId")
                         .ebsConfiguration(EbsConfigurationProperty.builder()
                                 .ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
                                         .volumeSpecification(VolumeSpecificationProperty.builder()
                                                 .sizeInGb(123)
                                                 .volumeType("volumeType")
                                                 // the properties below are optional
                                                 .iops(123)
                                                 .build())
                                         // the properties below are optional
                                         .volumesPerInstance(123)
                                         .build()))
                                 .ebsOptimized(false)
                                 .build())
                         .market("market")
                         .name("name")
                         .build()))
                 .terminationProtected(false)
                 .build())
         .jobFlowRole("jobFlowRole")
         .name("name")
         .serviceRole("serviceRole")
         // the properties below are optional
         .additionalInfo(additionalInfo)
         .applications(List.of(ApplicationProperty.builder()
                 .additionalInfo(Map.of(
                         "additionalInfoKey", "additionalInfo"))
                 .args(List.of("args"))
                 .name("name")
                 .version("version")
                 .build()))
         .autoScalingRole("autoScalingRole")
         .autoTerminationPolicy(AutoTerminationPolicyProperty.builder()
                 .idleTimeout(123)
                 .build())
         .bootstrapActions(List.of(BootstrapActionConfigProperty.builder()
                 .name("name")
                 .scriptBootstrapAction(ScriptBootstrapActionConfigProperty.builder()
                         .path("path")
                         // the properties below are optional
                         .args(List.of("args"))
                         .build())
                 .build()))
         .configurations(List.of(ConfigurationProperty.builder()
                 .classification("classification")
                 .configurationProperties(Map.of(
                         "configurationPropertiesKey", "configurationProperties"))
                 .configurations(List.of(configurationProperty_))
                 .build()))
         .customAmiId("customAmiId")
         .ebsRootVolumeSize(123)
         .kerberosAttributes(KerberosAttributesProperty.builder()
                 .kdcAdminPassword("kdcAdminPassword")
                 .realm("realm")
                 // the properties below are optional
                 .adDomainJoinPassword("adDomainJoinPassword")
                 .adDomainJoinUser("adDomainJoinUser")
                 .crossRealmTrustPrincipalPassword("crossRealmTrustPrincipalPassword")
                 .build())
         .logEncryptionKmsKeyId("logEncryptionKmsKeyId")
         .logUri("logUri")
         .managedScalingPolicy(ManagedScalingPolicyProperty.builder()
                 .computeLimits(ComputeLimitsProperty.builder()
                         .maximumCapacityUnits(123)
                         .minimumCapacityUnits(123)
                         .unitType("unitType")
                         // the properties below are optional
                         .maximumCoreCapacityUnits(123)
                         .maximumOnDemandCapacityUnits(123)
                         .build())
                 .build())
         .osReleaseLabel("osReleaseLabel")
         .releaseLabel("releaseLabel")
         .scaleDownBehavior("scaleDownBehavior")
         .securityConfiguration("securityConfiguration")
         .stepConcurrencyLevel(123)
         .steps(List.of(StepConfigProperty.builder()
                 .hadoopJarStep(HadoopJarStepConfigProperty.builder()
                         .jar("jar")
                         // the properties below are optional
                         .args(List.of("args"))
                         .mainClass("mainClass")
                         .stepProperties(List.of(KeyValueProperty.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build())
                 .name("name")
                 // the properties below are optional
                 .actionOnFailure("actionOnFailure")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .visibleToAllUsers(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnCluster.ApplicationProperty	Application is a property of AWS::EMR::Cluster .
static interface	CfnCluster.AutoScalingPolicyProperty	AutoScalingPolicy is a subproperty of InstanceGroupConfig .
static interface	CfnCluster.AutoTerminationPolicyProperty	Example:
static interface	CfnCluster.BootstrapActionConfigProperty	BootstrapActionConfig is a property of AWS::EMR::Cluster that can be used to run bootstrap actions on EMR clusters.
static final class	CfnCluster.Builder	A fluent builder for CfnCluster.
static interface	CfnCluster.CloudWatchAlarmDefinitionProperty	CloudWatchAlarmDefinition is a subproperty of the ScalingTrigger property, which determines when to trigger an automatic scaling activity.
static interface	CfnCluster.ComputeLimitsProperty	The Amazon EC2 unit limits for a managed scaling policy.
static interface	CfnCluster.ConfigurationProperty
static interface	CfnCluster.EbsBlockDeviceConfigProperty	EbsBlockDeviceConfig is a subproperty of the EbsConfiguration property type.
static interface	CfnCluster.EbsConfigurationProperty	EbsConfiguration is a subproperty of InstanceFleetConfig or InstanceGroupConfig .
static interface	CfnCluster.HadoopJarStepConfigProperty	The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed.
static interface	CfnCluster.InstanceFleetConfigProperty	Use InstanceFleetConfig to define instance fleets for an EMR cluster.
static interface	CfnCluster.InstanceFleetProvisioningSpecificationsProperty	InstanceFleetProvisioningSpecification is a subproperty of InstanceFleetConfig .
static interface	CfnCluster.InstanceGroupConfigProperty	Use InstanceGroupConfig to define instance groups for an EMR cluster.
static interface	CfnCluster.InstanceTypeConfigProperty
static interface	CfnCluster.JobFlowInstancesConfigProperty	JobFlowInstancesConfig is a property of the AWS::EMR::Cluster resource.
static interface	CfnCluster.KerberosAttributesProperty	KerberosAttributes is a property of the AWS::EMR::Cluster resource.
static interface	CfnCluster.KeyValueProperty	KeyValue is a subproperty of the HadoopJarStepConfig property type.
static interface	CfnCluster.ManagedScalingPolicyProperty	Managed scaling policy for an Amazon EMR cluster.
static interface	CfnCluster.MetricDimensionProperty	MetricDimension is a subproperty of the CloudWatchAlarmDefinition property type.
static interface	CfnCluster.OnDemandProvisioningSpecificationProperty	The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
static interface	CfnCluster.PlacementTypeProperty	PlacementType is a property of the AWS::EMR::Cluster resource.
static interface	CfnCluster.ScalingActionProperty	ScalingAction is a subproperty of the ScalingRule property type.
static interface	CfnCluster.ScalingConstraintsProperty	ScalingConstraints is a subproperty of the AutoScalingPolicy property type.
static interface	CfnCluster.ScalingRuleProperty	ScalingRule is a subproperty of the AutoScalingPolicy property type.
static interface	CfnCluster.ScalingTriggerProperty	ScalingTrigger is a subproperty of the ScalingRule property type.
static interface	CfnCluster.ScriptBootstrapActionConfigProperty	ScriptBootstrapActionConfig is a subproperty of the BootstrapActionConfig property type.
static interface	CfnCluster.SimpleScalingPolicyConfigurationProperty	SimpleScalingPolicyConfiguration is a subproperty of the ScalingAction property type.
static interface	CfnCluster.SpotProvisioningSpecificationProperty	SpotProvisioningSpecification is a subproperty of the InstanceFleetProvisioningSpecifications property type.
static interface	CfnCluster.StepConfigProperty	StepConfig is a property of the AWS::EMR::Cluster resource.
static interface	CfnCluster.VolumeSpecificationProperty	VolumeSpecification is a subproperty of the EbsBlockDeviceConfig property type.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnCluster(Construct scope, String id, CfnClusterProps props)	Create a new AWS::EMR::Cluster.
protected	CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
Object	getAdditionalInfo()	A JSON string for selecting additional features.
Object	getApplications()	The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.
String	getAttrMasterPublicDns()	The public DNS name of the master node (instance), such as ec2-12-123-123-123.us-west-2.compute.amazonaws.com .
String	getAutoScalingRole()	An IAM role for automatic scaling policies.
Object	getAutoTerminationPolicy()	AWS::EMR::Cluster.AutoTerminationPolicy.
Object	getBootstrapActions()	A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
protected Map<String,Object>	getCfnProperties()
Object	getConfigurations()	Applies only to Amazon EMR releases 4.x and later.
String	getCustomAmiId()	Available only in Amazon EMR releases 5.7.0 and later.
Number	getEbsRootVolumeSize()	The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.
Object	getInstances()	A specification of the number and type of Amazon EC2 instances.
String	getJobFlowRole()	Also called instance profile and Amazon EC2 role.
Object	getKerberosAttributes()	Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
String	getLogEncryptionKmsKeyId()	The AWS KMS key used for encrypting log files.
String	getLogUri()	The path to the Amazon S3 location where logs for this cluster are stored.
Object	getManagedScalingPolicy()	Creates or updates a managed scaling policy for an Amazon EMR cluster.
String	getName()	The name of the cluster.
String	getOsReleaseLabel()	AWS::EMR::Cluster.OSReleaseLabel.
String	getReleaseLabel()	The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
String	getScaleDownBehavior()	The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
String	getSecurityConfiguration()	The name of the security configuration applied to the cluster.
String	getServiceRole()	The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.
Number	getStepConcurrencyLevel()	Specifies the number of steps that can be executed concurrently.
Object	getSteps()	A list of steps to run.
TagManager	getTags()	A list of tags associated with a cluster.
Object	getVisibleToAllUsers()	Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalInfo(Object value)	A JSON string for selecting additional features.
void	setApplications(List<Object> value)	The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.
void	setApplications(IResolvable value)	The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.
void	setAutoScalingRole(String value)	An IAM role for automatic scaling policies.
void	setAutoTerminationPolicy(IResolvable value)	AWS::EMR::Cluster.AutoTerminationPolicy.
void	setAutoTerminationPolicy(CfnCluster.AutoTerminationPolicyProperty value)	AWS::EMR::Cluster.AutoTerminationPolicy.
void	setBootstrapActions(List<Object> value)	A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
void	setBootstrapActions(IResolvable value)	A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
void	setConfigurations(List<Object> value)	Applies only to Amazon EMR releases 4.x and later.
void	setConfigurations(IResolvable value)	Applies only to Amazon EMR releases 4.x and later.
void	setCustomAmiId(String value)	Available only in Amazon EMR releases 5.7.0 and later.
void	setEbsRootVolumeSize(Number value)	The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.
void	setInstances(IResolvable value)	A specification of the number and type of Amazon EC2 instances.
void	setInstances(CfnCluster.JobFlowInstancesConfigProperty value)	A specification of the number and type of Amazon EC2 instances.
void	setJobFlowRole(String value)	Also called instance profile and Amazon EC2 role.
void	setKerberosAttributes(IResolvable value)	Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
void	setKerberosAttributes(CfnCluster.KerberosAttributesProperty value)	Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
void	setLogEncryptionKmsKeyId(String value)	The AWS KMS key used for encrypting log files.
void	setLogUri(String value)	The path to the Amazon S3 location where logs for this cluster are stored.
void	setManagedScalingPolicy(IResolvable value)	Creates or updates a managed scaling policy for an Amazon EMR cluster.
void	setManagedScalingPolicy(CfnCluster.ManagedScalingPolicyProperty value)	Creates or updates a managed scaling policy for an Amazon EMR cluster.
void	setName(String value)	The name of the cluster.
void	setOsReleaseLabel(String value)	AWS::EMR::Cluster.OSReleaseLabel.
void	setReleaseLabel(String value)	The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
void	setScaleDownBehavior(String value)	The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
void	setSecurityConfiguration(String value)	The name of the security configuration applied to the cluster.
void	setServiceRole(String value)	The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.
void	setStepConcurrencyLevel(Number value)	Specifies the number of steps that can be executed concurrently.
void	setSteps(List<Object> value)	A list of steps to run.
void	setSteps(IResolvable value)	A list of steps to run.
void	setVisibleToAllUsers(Boolean value)	Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.
void	setVisibleToAllUsers(IResolvable value)	Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCluster

@Stability(Stable)
public CfnCluster(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnClusterProps props)

Create a new AWS::EMR::Cluster.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector -

• tree inspector to collect and process attributes.

This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrMasterPublicDns

@Stability(Stable)
@NotNull
public String getAttrMasterPublicDns()

The public DNS name of the master node (instance), such as ec2-12-123-123-123.us-west-2.compute.amazonaws.com .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

A list of tags associated with a cluster.

getAdditionalInfo

@Stability(Stable)
@NotNull
public Object getAdditionalInfo()

A JSON string for selecting additional features.

setAdditionalInfo

@Stability(Stable)
public void setAdditionalInfo(@NotNull
 Object value)

A JSON string for selecting additional features.

getInstances

@Stability(Stable)
@NotNull
public Object getInstances()

A specification of the number and type of Amazon EC2 instances.

setInstances

@Stability(Stable)
public void setInstances(@NotNull
 CfnCluster.JobFlowInstancesConfigProperty value)

A specification of the number and type of Amazon EC2 instances.

setInstances

@Stability(Stable)
public void setInstances(@NotNull
 IResolvable value)

A specification of the number and type of Amazon EC2 instances.

getJobFlowRole

@Stability(Stable)
@NotNull
public String getJobFlowRole()

Also called instance profile and Amazon EC2 role.

An IAM role for an Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole . In order to use the default role, you must have already created it using the AWS CLI or console.

setJobFlowRole

@Stability(Stable)
public void setJobFlowRole(@NotNull
 String value)

Also called instance profile and Amazon EC2 role.

An IAM role for an Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole . In order to use the default role, you must have already created it using the AWS CLI or console.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the cluster.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the cluster.

getServiceRole

@Stability(Stable)
@NotNull
public String getServiceRole()

The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.

setServiceRole

@Stability(Stable)
public void setServiceRole(@NotNull
 String value)

The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.

getApplications

@Stability(Stable)
@Nullable
public Object getApplications()

The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.

setApplications

@Stability(Stable)
public void setApplications(@Nullable
 IResolvable value)

The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.

setApplications

@Stability(Stable)
public void setApplications(@Nullable
 List<Object> value)

The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.

getAutoScalingRole

@Stability(Stable)
@Nullable
public String getAutoScalingRole()

An IAM role for automatic scaling policies.

The default role is EMR_AutoScaling_DefaultRole . The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.

setAutoScalingRole

@Stability(Stable)
public void setAutoScalingRole(@Nullable
 String value)

An IAM role for automatic scaling policies.

The default role is EMR_AutoScaling_DefaultRole . The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.

getAutoTerminationPolicy

@Stability(Stable)
@Nullable
public Object getAutoTerminationPolicy()

AWS::EMR::Cluster.AutoTerminationPolicy.

setAutoTerminationPolicy

@Stability(Stable)
public void setAutoTerminationPolicy(@Nullable
 IResolvable value)

AWS::EMR::Cluster.AutoTerminationPolicy.

setAutoTerminationPolicy

@Stability(Stable)
public void setAutoTerminationPolicy(@Nullable
 CfnCluster.AutoTerminationPolicyProperty value)

AWS::EMR::Cluster.AutoTerminationPolicy.

getBootstrapActions

@Stability(Stable)
@Nullable
public Object getBootstrapActions()

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

setBootstrapActions

@Stability(Stable)
public void setBootstrapActions(@Nullable
 IResolvable value)

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

setBootstrapActions

@Stability(Stable)
public void setBootstrapActions(@Nullable
 List<Object> value)

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

getConfigurations

@Stability(Stable)
@Nullable
public Object getConfigurations()

Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.

setConfigurations

@Stability(Stable)
public void setConfigurations(@Nullable
 IResolvable value)

Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.

setConfigurations

@Stability(Stable)
public void setConfigurations(@Nullable
 List<Object> value)

Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.

getCustomAmiId

@Stability(Stable)
@Nullable
public String getCustomAmiId()

Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

setCustomAmiId

@Stability(Stable)
public void setCustomAmiId(@Nullable
 String value)

Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

getEbsRootVolumeSize

@Stability(Stable)
@Nullable
public Number getEbsRootVolumeSize()

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.

Available in Amazon EMR releases 4.x and later.

setEbsRootVolumeSize

@Stability(Stable)
public void setEbsRootVolumeSize(@Nullable
 Number value)

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.

Available in Amazon EMR releases 4.x and later.

getKerberosAttributes

@Stability(Stable)
@Nullable
public Object getKerberosAttributes()

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.

For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .

setKerberosAttributes

@Stability(Stable)
public void setKerberosAttributes(@Nullable
 IResolvable value)

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.

For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .

setKerberosAttributes

@Stability(Stable)
public void setKerberosAttributes(@Nullable
 CfnCluster.KerberosAttributesProperty value)

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.

For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .

getLogEncryptionKmsKeyId

@Stability(Stable)
@Nullable
public String getLogEncryptionKmsKeyId()

The AWS KMS key used for encrypting log files.

This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.

setLogEncryptionKmsKeyId

@Stability(Stable)
public void setLogEncryptionKmsKeyId(@Nullable
 String value)

The AWS KMS key used for encrypting log files.

This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.

getLogUri

@Stability(Stable)
@Nullable
public String getLogUri()

The path to the Amazon S3 location where logs for this cluster are stored.

setLogUri

@Stability(Stable)
public void setLogUri(@Nullable
 String value)

The path to the Amazon S3 location where logs for this cluster are stored.

getManagedScalingPolicy

@Stability(Stable)
@Nullable
public Object getManagedScalingPolicy()

Creates or updates a managed scaling policy for an Amazon EMR cluster.

The managed scaling policy defines the limits for resources, such as Amazon EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.

setManagedScalingPolicy

@Stability(Stable)
public void setManagedScalingPolicy(@Nullable
 IResolvable value)

Creates or updates a managed scaling policy for an Amazon EMR cluster.

The managed scaling policy defines the limits for resources, such as Amazon EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.

setManagedScalingPolicy

@Stability(Stable)
public void setManagedScalingPolicy(@Nullable
 CfnCluster.ManagedScalingPolicyProperty value)

Creates or updates a managed scaling policy for an Amazon EMR cluster.

The managed scaling policy defines the limits for resources, such as Amazon EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.

getOsReleaseLabel

@Stability(Stable)
@Nullable
public String getOsReleaseLabel()

AWS::EMR::Cluster.OSReleaseLabel.

setOsReleaseLabel

@Stability(Stable)
public void setOsReleaseLabel(@Nullable
 String value)

AWS::EMR::Cluster.OSReleaseLabel.

getReleaseLabel

@Stability(Stable)
@Nullable
public String getReleaseLabel()

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.

Release labels are in the form emr-x.x.x , where x.x.x is an Amazon EMR release version such as emr-5.14.0 . For more information about Amazon EMR release versions and included application versions and features, see . The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion .

setReleaseLabel

@Stability(Stable)
public void setReleaseLabel(@Nullable
 String value)

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.

Release labels are in the form emr-x.x.x , where x.x.x is an Amazon EMR release version such as emr-5.14.0 . For more information about Amazon EMR release versions and included application versions and features, see . The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion .

getScaleDownBehavior

@Stability(Stable)
@Nullable
public String getScaleDownBehavior()

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.

TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

setScaleDownBehavior

@Stability(Stable)
public void setScaleDownBehavior(@Nullable
 String value)

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.

TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

getSecurityConfiguration

@Stability(Stable)
@Nullable
public String getSecurityConfiguration()

The name of the security configuration applied to the cluster.

setSecurityConfiguration

@Stability(Stable)
public void setSecurityConfiguration(@Nullable
 String value)

The name of the security configuration applied to the cluster.

getStepConcurrencyLevel

@Stability(Stable)
@Nullable
public Number getStepConcurrencyLevel()

Specifies the number of steps that can be executed concurrently.

The default value is 1 . The maximum value is 256 .

setStepConcurrencyLevel

@Stability(Stable)
public void setStepConcurrencyLevel(@Nullable
 Number value)

Specifies the number of steps that can be executed concurrently.

The default value is 1 . The maximum value is 256 .

getSteps

@Stability(Stable)
@Nullable
public Object getSteps()

A list of steps to run.

setSteps

@Stability(Stable)
public void setSteps(@Nullable
 IResolvable value)

A list of steps to run.

setSteps

@Stability(Stable)
public void setSteps(@Nullable
 List<Object> value)

A list of steps to run.

getVisibleToAllUsers

@Stability(Stable)
@Nullable
public Object getVisibleToAllUsers()

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.

If this value is set to true , all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

When you create clusters directly through the EMR console or API, this value is set to true by default. However, for AWS::EMR::Cluster resources in CloudFormation, the default is false .

setVisibleToAllUsers

@Stability(Stable)
public void setVisibleToAllUsers(@Nullable
 Boolean value)

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.

If this value is set to true , all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

When you create clusters directly through the EMR console or API, this value is set to true by default. However, for AWS::EMR::Cluster resources in CloudFormation, the default is false .

setVisibleToAllUsers

@Stability(Stable)
public void setVisibleToAllUsers(@Nullable
 IResolvable value)

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.

If this value is set to true , all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

When you create clusters directly through the EMR console or API, this value is set to true by default. However, for AWS::EMR::Cluster resources in CloudFormation, the default is false .