interface EmrAddStepJsonataProps

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

Properties for EmrAddStep using JSONata.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const outputs: any;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const emrAddStepJsonataProps: stepfunctions_tasks.EmrAddStepJsonataProps = {
  clusterId: 'clusterId',
  jar: 'jar',
  name: 'name',

  // the properties below are optional
  actionOnFailure: stepfunctions_tasks.ActionOnFailure.TERMINATE_CLUSTER,
  args: ['args'],
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  executionRoleArn: 'executionRoleArn',
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  mainClass: 'mainClass',
  outputs: outputs,
  properties: {
    propertiesKey: 'properties',
  },
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};

Properties

Name	Type	Description
clusterId	string	The ClusterId to add the Step to.
jar	string	A path to a JAR file run during the step.
name	string	The name of the Step.
actionOnFailure?	ActionOnFailure	The action to take when the cluster step fails.
args?	string[]	A list of command line arguments passed to the JAR file's main function when executed.
assign?	{ [string]: any }	Workflow variables to store in this step.
comment?	string	A comment describing this state.
credentials?	Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
executionRoleArn?	string	The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.
heartbeat?⚠️	Duration	Timeout for the heartbeat.
heartbeatTimeout?	Timeout	Timeout for the heartbeat.
integrationPattern?	IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
mainClass?	string	The name of the main class in the specified Java file.
outputs?	any	Used to specify and transform output from the state.
properties?	{ [string]: string }	A list of Java properties that are set when the step runs.
queryLanguage?	QueryLanguage	The name of the query language used by the state.
stateName?	string	Optional name for this state.
taskTimeout?	Timeout	Timeout for the task.
timeout?⚠️	Duration	Timeout for the task.

---

clusterId

Type: string

The ClusterId to add the Step to.

---

jar

Type: string

A path to a JAR file run during the step.

See also: https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html

---

name

Type: string

The name of the Step.

See also: https://docs.aws.amazon.com/emr/latest/APIReference/API_StepConfig.html

---

actionOnFailure?

Type: ActionOnFailure (optional, default: ActionOnFailure.CONTINUE)

The action to take when the cluster step fails.

See also: https://docs.aws.amazon.com/emr/latest/APIReference/API_StepConfig.html

---

args?

Type: string[] (optional, default: No args)

A list of command line arguments passed to the JAR file's main function when executed.

See also: https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html

---

assign?

Type: { [string]: any } (optional, default: 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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

---

comment?

Type: string (optional, default: No comment)

A comment describing this state.

---

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

---

executionRoleArn?

Type: string (optional, default: Uses EC2 instance profile role)

The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.

See also: https://docs.aws.amazon.com/emr/latest/APIReference/API_AddJobFlowSteps.html#API_AddJobFlowSteps_RequestSyntax

---

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

---

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

---

mainClass?

Type: string (optional, default: No mainClass)

The name of the main class in the specified Java file.

If not specified, the JAR file should specify a Main-Class in its manifest file.

See also: https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html

---

outputs?

Type: any (optional, default: $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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

---

properties?

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

A list of Java properties that are set when the step runs.

You can use these properties to pass key value pairs to your main function.

See also: https://docs.aws.amazon.com/emr/latest/APIReference/API_HadoopJarStepConfig.html

---

queryLanguage?

Type: QueryLanguage (optional, default: 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.

---

stateName?

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

Optional name for this state.

---

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.