class EmrCreateCluster (construct)

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.EmrCreateCluster
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#EmrCreateCluster
Java	software.amazon.awscdk.services.stepfunctions.tasks.EmrCreateCluster
Python	aws_cdk.aws_stepfunctions_tasks.EmrCreateCluster
TypeScript (source)	aws-cdk-lib » aws_stepfunctions_tasks » EmrCreateCluster

Implements IConstruct, IDependable, IChainable, INextable

A Step Functions Task to create an EMR Cluster.

The ClusterConfiguration is defined as Parameters in the state machine definition.

OUTPUT: the ClusterId.

Example

const clusterRole = new iam.Role(this, 'ClusterRole', {
  assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com'),
});

const serviceRole = new iam.Role(this, 'ServiceRole', {
  assumedBy: new iam.ServicePrincipal('elasticmapreduce.amazonaws.com'),
});

const autoScalingRole = new iam.Role(this, 'AutoScalingRole', {
  assumedBy: new iam.ServicePrincipal('elasticmapreduce.amazonaws.com'),
});

autoScalingRole.assumeRolePolicy?.addStatements(
  new iam.PolicyStatement({
    effect: iam.Effect.ALLOW,
    principals: [
      new iam.ServicePrincipal('application-autoscaling.amazonaws.com'),
    ],
    actions: [
      'sts:AssumeRole',
    ],
  }));
)

new tasks.EmrCreateCluster(this, 'Create Cluster', {
  instances: {},
  clusterRole,
  name: sfn.TaskInput.fromJsonPathAt('$.ClusterName').value,
  serviceRole,
  autoScalingRole,
});

Initializer

new EmrCreateCluster(scope: Construct, id: string, props: EmrCreateClusterProps)

Parameters

• scope Construct
• id string — Descriptive identifier for this chainable.
• props EmrCreateClusterProps

Construct Props

Name	Type	Description
instances	InstancesConfigProperty	A specification of the number and type of Amazon EC2 instances.
name	string	The Name of the Cluster.
additionalInfo?	string	A JSON string for selecting additional features.
applications?	ApplicationConfigProperty[]	A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.
autoScalingRole?	IRole	An IAM role for automatic scaling policies.
autoTerminationPolicyIdleTimeout?	Duration	The amount of idle time after which the cluster automatically terminates.
bootstrapActions?	BootstrapActionConfigProperty[]	A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
clusterRole?	IRole	Also called instance profile and EC2 role.
comment?	string	An optional description for this state.
configurations?	ConfigurationProperty[]	The list of configurations supplied for the EMR cluster you are creating.
credentials?	Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
customAmiId?	string	The ID of a custom Amazon EBS-backed Linux AMI.
ebsRootVolumeSize?	Size	The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.
heartbeat?⚠️	Duration	Timeout for the heartbeat.
heartbeatTimeout?	Timeout	Timeout for the heartbeat.
inputPath?	string	JSONPath expression to select part of the state to be the input to this state.
integrationPattern?	IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
kerberosAttributes?	KerberosAttributesProperty	Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
logUri?	string	The location in Amazon S3 to write the log files of the job flow.
outputPath?	string	JSONPath expression to select select a portion of the state output to pass to the next state.
releaseLabel?	string	The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
resultPath?	string	JSONPath expression to indicate where to inject the state's output.
resultSelector?	{ [string]: any }	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
scaleDownBehavior?	EmrClusterScaleDownBehavior	Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
securityConfiguration?	string	The name of a security configuration to apply to the cluster.
serviceRole?	IRole	The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
stateName?	string	Optional name for this state.
stepConcurrencyLevel?	number	Specifies the step concurrency level to allow multiple steps to run in parallel.
tags?	{ [string]: string }	A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
taskTimeout?	Timeout	Timeout for the task.
timeout?⚠️	Duration	Timeout for the task.
visibleToAllUsers?	boolean	A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions.

---

instances

Type: InstancesConfigProperty

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

---

name

Type: string

The Name of the Cluster.

---

additionalInfo?

Type: string (optional, default: None)

A JSON string for selecting additional features.

---

applications?

Type: ApplicationConfigProperty[] (optional, default: EMR selected default)

A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.

---

autoScalingRole?

Type: IRole (optional, default: A role will be created.)

An IAM role for automatic scaling policies.

---

autoTerminationPolicyIdleTimeout?

Type: Duration (optional, default: No timeout)

The amount of idle time after which the cluster automatically terminates.

You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).

---

bootstrapActions?

Type: BootstrapActionConfigProperty[] (optional, default: None)

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

---

clusterRole?

Type: IRole (optional, default: * A Role will be created)

Also called instance profile and EC2 role.

An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role.

This attribute has been renamed from jobFlowRole to clusterRole to align with other ERM/StepFunction integration parameters.

---

comment?

Type: string (optional, default: No comment)

An optional description for this state.

---

configurations?

Type: ConfigurationProperty[] (optional, default: None)

The list of configurations supplied for the EMR cluster you are creating.

---

credentials?

Type: Credentials (optional, default: None (Task is executed using the State Machine's execution role))

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

---

customAmiId?

Type: string (optional, default: None)

The ID of a custom Amazon EBS-backed Linux AMI.

---

ebsRootVolumeSize?

Type: Size (optional, default: EMR selected default)

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

---

heartbeat?⚠️

⚠️ Deprecated: use heartbeatTimeout

Type: Duration (optional, default: None)

Timeout for the heartbeat.

---

heartbeatTimeout?

Type: Timeout (optional, default: None)

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

---

inputPath?

Type: string (optional, default: The entire task input (JSON path '$'))

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

---

integrationPattern?

Type: IntegrationPattern (optional, default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.)

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

---

kerberosAttributes?

Type: KerberosAttributesProperty (optional, default: None)

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

---

logUri?

Type: string (optional, default: None)

The location in Amazon S3 to write the log files of the job flow.

---

outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$'))

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

---

releaseLabel?

Type: string (optional, default: EMR selected default)

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

---

resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON path '$'))

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

---

resultSelector?

Type: { [string]: any } (optional, default: None)

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

---

scaleDownBehavior?

Type: EmrClusterScaleDownBehavior (optional, default: EMR selected default)

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

---

securityConfiguration?

Type: string (optional, default: None)

The name of a security configuration to apply to the cluster.

---

serviceRole?

Type: IRole (optional, default: A role will be created that Amazon EMR service can assume.)

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

---

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.

---

stepConcurrencyLevel?

Type: number (optional, default: 1 - no step concurrency allowed)

Specifies the step concurrency level to allow multiple steps to run in parallel.

Requires EMR release label 5.28.0 or above. Must be in range [1, 256].

---

tags?

Type: { [string]: string } (optional, default: None)

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

---

taskTimeout?

Type: Timeout (optional, default: None)

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

---

timeout?⚠️

⚠️ Deprecated: use taskTimeout

Type: Duration (optional, default: None)

Timeout for the task.

---

visibleToAllUsers?

Type: boolean (optional, default: true)

A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions.

Properties

Name	Type	Description
autoScalingRole	IRole	The autoscaling role for the EMR Cluster.
clusterRole	IRole	The instance role for the EMR Cluster.
endStates	INextable[]	Continuable states of this Chainable.
id	string	Descriptive identifier for this chainable.
node	Node	The tree node.
serviceRole	IRole	The service role for the EMR Cluster.
startState	State	First state of this Chainable.
stateId	string	Tokenized string that evaluates to the state's ID.
taskMetrics?	TaskMetricsConfig
taskPolicies?	PolicyStatement[]

---

autoScalingRole

Type: IRole

The autoscaling role for the EMR Cluster.

Only available after task has been added to a state machine.

---

clusterRole

Type: IRole

The instance role for the EMR Cluster.

Only available after task has been added to a state machine.

---

endStates

Type: INextable[]

Continuable states of this Chainable.

---

id

Type: string

Descriptive identifier for this chainable.

---

node

Type: Node

The tree node.

---

serviceRole

Type: IRole

The service role for the EMR Cluster.

Only available after task has been added to a state machine.

---

startState

Type: State

First state of this Chainable.

---

stateId

Type: string

Tokenized string that evaluates to the state's ID.

---

taskMetrics?

Type: TaskMetricsConfig (optional)

---

taskPolicies?

Type: PolicyStatement[] (optional)

Methods

Name	Description
addCatch(handler, props?)	Add a recovery handler for this state.
addPrefix(x)	Add a prefix to the stateId of this state.
addRetry(props?)	Add retry configuration for this state.
bindToGraph(graph)	Register this state as part of the given graph.
metric(metricName, props?)	Return the given named metric for this Task.
metricFailed(props?)	Metric for the number of times this activity fails.
metricHeartbeatTimedOut(props?)	Metric for the number of times the heartbeat times out for this activity.
metricRunTime(props?)	The interval, in milliseconds, between the time the Task starts and the time it closes.
metricScheduleTime(props?)	The interval, in milliseconds, for which the activity stays in the schedule state.
metricScheduled(props?)	Metric for the number of times this activity is scheduled.
metricStarted(props?)	Metric for the number of times this activity is started.
metricSucceeded(props?)	Metric for the number of times this activity succeeds.
metricTime(props?)	The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
metricTimedOut(props?)	Metric for the number of times this activity times out.
next(next)	Continue normal execution with the given state.
toStateJson()	Return the Amazon States Language object for this state.
toString()	Returns a string representation of this construct.

---

addCatch(handler, props?)

public addCatch(handler: IChainable, props?: CatchProps): TaskStateBase

Parameters

• handler IChainable
• props CatchProps

Returns

• TaskStateBase

Add a recovery handler for this state.

When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.

---

addPrefix(x)

public addPrefix(x: string): void

Parameters

• x string

Add a prefix to the stateId of this state.

---

addRetry(props?)

public addRetry(props?: RetryProps): TaskStateBase

Parameters

• props RetryProps

Returns

• TaskStateBase

Add retry configuration for this state.

This controls if and how the execution will be retried if a particular error occurs.

---

bindToGraph(graph)

public bindToGraph(graph: StateGraph): void

Parameters

• graph StateGraph

Register this state as part of the given graph.

Don't call this. It will be called automatically when you work with states normally.

---

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this Task.

---

metricFailed(props?)

public metricFailed(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity fails.

---

metricHeartbeatTimedOut(props?)

public metricHeartbeatTimedOut(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times the heartbeat times out for this activity.

---

metricRunTime(props?)

public metricRunTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The interval, in milliseconds, between the time the Task starts and the time it closes.

---

metricScheduleTime(props?)

public metricScheduleTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The interval, in milliseconds, for which the activity stays in the schedule state.

---

metricScheduled(props?)

public metricScheduled(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity is scheduled.

---

metricStarted(props?)

public metricStarted(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity is started.

---

metricSucceeded(props?)

public metricSucceeded(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity succeeds.

---

metricTime(props?)

public metricTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

---

metricTimedOut(props?)

public metricTimedOut(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity times out.

---

next(next)

public next(next: IChainable): Chain

Parameters

• next IChainable

Returns

• Chain

Continue normal execution with the given state.

---

toStateJson()

public toStateJson(): json

Returns

• json

Return the Amazon States Language object for this state.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.