# EmrCreateCluster

A Step Functions Task to create an EMR Cluster.

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

OUTPUT: the ClusterId.

Extends: Construct › State › TaskStateBase › EmrCreateCluster
Implements: IChainable, INextable, IConstruct, IDependable

- Source: [`aws-stepfunctions-tasks/lib/emr/emr-create-cluster.ts`](https://github.com/aws/aws-cdk/blob/v2.273.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/emr/emr-create-cluster.ts#L218)
- Type last changed: v2.178.0 · 6 Feb 2025

## Example

```ts
new tasks.EmrCreateCluster(this, 'PrioritizedAllocation', {
  instances: {
    instanceFleets: [{
      instanceFleetType: tasks.EmrCreateCluster.InstanceRoleType.CORE,
      instanceTypeConfigs: [{
        instanceType: 'm5.large',
        priority: 0, // Highest priority
      }, {
        instanceType: 'm5.xlarge',
        priority: 1, // Lower priority
      }],
      launchSpecifications: {
        onDemandSpecification: {
          allocationStrategy: tasks.EmrCreateCluster.OnDemandAllocationStrategy.PRIORITIZED,
        },
      },
      targetOnDemandCapacity: 2,
    }],
  },
  name: 'PrioritizedCluster',
  integrationPattern: sfn.IntegrationPattern.RUN_JOB,
});
```

## Initializer

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

## Construct Props

- `additionalInfo`: string = None — A JSON string for selecting additional features.

- `applications`: [EmrCreateCluster.ApplicationConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.EmrCreateCluster.ApplicationConfigProperty.html)[] = EMR selected default — A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.

- `assign`: { [key: string]: any } = Not assign variables — Workflow variables to store in this step.

  Using workflow variables, you can store data in a step and retrieve that data in future steps.

- `autoScalingRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) = A role will be created. — An IAM role for automatic scaling policies.

- `autoTerminationPolicyIdleTimeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = 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`: [EmrCreateCluster.BootstrapActionConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.EmrCreateCluster.BootstrapActionConfigProperty.html)[] = None — A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

- `clusterRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) = * 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`: string = No comment — A comment describing this state.

- `configurations`: [EmrCreateCluster.ConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.EmrCreateCluster.ConfigurationProperty.html)[] = None — The list of configurations supplied for the EMR cluster you are creating.

- `credentials`: [Credentials](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Credentials.html) = 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.

  **Default:** None (Task is executed using the State Machine's execution role)

- `customAmiId`: string = None — The ID of a custom Amazon EBS-backed Linux AMI.

- `ebsRootVolumeIops`: number = EMR selected default — The IOPS of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

  Requires EMR release label 6.15.0 or above.
  Must be in range [3000, 16000].

- `ebsRootVolumeSize`: [Size](/cdk/api/v2/docs/aws-cdk-lib.Size.html) = EMR selected default — The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

- `ebsRootVolumeThroughput`: number = EMR selected default — The throughput, in MiB/s, of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

  Requires EMR release label 6.15.0 or above.
  Must be in range [125, 1000].

- `heartbeat`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `heartbeatTimeout`

- `heartbeatTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the heartbeat.

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

- `inputPath`: string = $ — 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 {}.

- `instances`: [EmrCreateCluster.InstancesConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.EmrCreateCluster.InstancesConfigProperty.html) (required) — A specification of the number and type of Amazon EC2 instances.

- `integrationPattern`: [IntegrationPattern](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.IntegrationPattern.html) = `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.

  **Default:** `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

- `kerberosAttributes`: [EmrCreateCluster.KerberosAttributesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.EmrCreateCluster.KerberosAttributesProperty.html) = None — Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.

- `logUri`: string = None — The location in Amazon S3 to write the log files of the job flow.

- `managedScalingPolicy`: [EmrCreateCluster.ManagedScalingPolicyProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.EmrCreateCluster.ManagedScalingPolicyProperty.html) = None — The specified managed scaling policy for an Amazon EMR cluster.

- `name`: string (required) — The Name of the Cluster.

- `outputPath`: string = $ — JSONPath expression to select part of the state to be the output to this state.

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

- `outputs`: any = $states.result or $states.errorOutput — Used to specify and transform output from the state.

  When specified, the value overrides the state output default.
  The output field accepts any JSON value (object, array, string, number, boolean, null).
  Any string value, including those inside objects or arrays,
  will be evaluated as JSONata if surrounded by {% %} characters.
  Output also accepts a JSONata expression directly.

  **Default:** $states.result or $states.errorOutput

- `queryLanguage`: [QueryLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.QueryLanguage.html) = JSONPath — The name of the query language used by the state.

  If the state does not contain a `queryLanguage` field,
  then it will use the query language specified in the top-level `queryLanguage` field.

- `releaseLabel`: string = EMR selected default — 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.

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

- `resultSelector`: { [key: string]: any } = 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.

- `scaleDownBehavior`: [EmrCreateCluster.EmrClusterScaleDownBehavior](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.EmrCreateCluster.EmrClusterScaleDownBehavior.html) = 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`: string = None — The name of a security configuration to apply to the cluster.

- `serviceRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) = 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.

  **Default:** A role will be created that Amazon EMR service can assume.

- `stateName`: string = The construct ID will be used as state name — Optional name for this state.

  **Default:** The construct ID will be used as state name

- `stepConcurrencyLevel`: number = 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`: { [key: string]: string } = None — A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

- `taskTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the task.

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

- `timeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `taskTimeout`

- `visibleToAllUsers`: boolean = 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

- `autoScalingRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) (required) — The autoscaling role for the EMR Cluster.

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

- `clusterRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) (required) — The instance role for the EMR Cluster.

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

- `endStates`: [INextable](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.INextable.html)[] (required) — Continuable states of this Chainable.

- `id`: string (required) — Descriptive identifier for this chainable.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `serviceRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) (required) — The service role for the EMR Cluster.

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

- `startState`: [State](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.State.html) (required) — First state of this Chainable.

- `stateId`: string (required) — Tokenized string that evaluates to the state's ID.

## Methods

- `addCatch(handler: IChainable, props?: CatchProps): 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: string): void` — Add a prefix to the stateId of this state.

- `addRetry(props?: RetryProps): TaskStateBase` — Add retry configuration for this state.

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

- `bindToGraph(graph: StateGraph): void` — Register this state as part of the given graph.

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

- `filterNextables(states: State[]): INextable[]` (static) — Return only the states that allow chaining from an array of states.

- `findReachableEndStates(start: State, options?: FindStateOptions): State[]` (static) — Find the set of end states states reachable through transitions from the given start state.

- `findReachableStates(start: State, options?: FindStateOptions): State[]` (static) — Find the set of states reachable through transitions from the given start state.

  This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `jsonata(scope: Construct, id: string, props: EmrCreateClusterJsonataProps): EmrCreateCluster // chainable` (static) — A Step Functions task using JSONata to create an EMR Cluster.

  This task creates a Lambda function to call cross-region AWS API and invokes it.

- `jsonPath(scope: Construct, id: string, props: EmrCreateClusterJsonPathProps): EmrCreateCluster // chainable` (static) — A Step Functions task using JSONPath to create an EMR Cluster.

  This task creates a Lambda function to call cross-region AWS API and invokes it.

- `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this Task.

- `metricFailed(props?: MetricOptions): Metric` — Metric for the number of times this activity fails.

- `metricHeartbeatTimedOut(props?: MetricOptions): Metric` — Metric for the number of times the heartbeat times out for this activity.

- `metricRunTime(props?: MetricOptions): Metric` — The interval, in milliseconds, between the time the Task starts and the time it closes.

- `metricScheduled(props?: MetricOptions): Metric` — Metric for the number of times this activity is scheduled.

- `metricScheduleTime(props?: MetricOptions): Metric` — The interval, in milliseconds, for which the activity stays in the schedule state.

- `metricStarted(props?: MetricOptions): Metric` — Metric for the number of times this activity is started.

- `metricSucceeded(props?: MetricOptions): Metric` — Metric for the number of times this activity succeeds.

- `metricTime(props?: MetricOptions): Metric` — The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

- `metricTimedOut(props?: MetricOptions): Metric` — Metric for the number of times this activity times out.

- `next(next: IChainable): Chain` — Continue normal execution with the given state.

- `prefixStates(root: IConstruct, prefix: string): void` (static) — Add a prefix to the stateId of all States found in a construct tree.

- `toStateJson(topLevelQueryLanguage?: QueryLanguage): json` — Return the Amazon States Language object for this state.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining