interface EmrAddStepProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.EmrAddStepProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#EmrAddStepProps |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.EmrAddStepProps |
![]() | aws_cdk.aws_stepfunctions_tasks.EmrAddStepProps |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » EmrAddStepProps |
Properties for EmrAddStep.
Example
new tasks.EmrAddStep(this, 'Task', {
clusterId: 'ClusterId',
name: 'StepName',
jar: 'Jar',
actionOnFailure: tasks.ActionOnFailure.CONTINUE,
});
Properties
Name | Type | Description |
---|---|---|
cluster | 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. |
action | Action | 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. |
execution | string | The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
main | string | The name of the main class in the specified Java file. |
output | string | JSONPath expression to select part of the state to be the output to this state. |
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. |
query | Query | The name of the query language used by the state. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
state | string | Optional name for this state. |
task | 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.
name
Type:
string
The name of the Step.
See also: https://docs.aws.amazon.com/emr/latest/APIReference/API_StepConfig.html
actionOnFailure?
Type:
Action
(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.
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.
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.
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.
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: $)
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:
Integration
(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.
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.
outputPath?
Type:
string
(optional, default: $)
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?
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.
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.
queryLanguage?
Type:
Query
(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.
resultPath?
Type:
string
(optional, default: $)
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.
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.