EmrAddStepJsonataProps

class aws_cdk.aws_stepfunctions_tasks.EmrAddStepJsonataProps(*, comment=None, query_language=None, state_name=None, credentials=None, heartbeat=None, heartbeat_timeout=None, integration_pattern=None, task_timeout=None, timeout=None, assign=None, outputs=None, cluster_id, jar, name, action_on_failure=None, args=None, execution_role_arn=None, main_class=None, properties=None)

Bases: TaskStateJsonataBaseProps

Properties for EmrAddStep using JSONata.

Parameters:

  • comment (Optional[str]) – A comment describing this state. Default: No comment

  • query_language (Optional[QueryLanguage]) – 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. Default: - JSONPath

  • state_name (Optional[str]) – Optional name for this state. Default: - The construct ID will be used as state name

  • credentials (Union[Credentials, Dict[str, Any], None]) – 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)

  • heartbeat (Optional[Duration]) – (deprecated) Timeout for the heartbeat. Default: - None

  • heartbeat_timeout (Optional[Timeout]) – Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - None

  • integration_pattern (Optional[IntegrationPattern]) – 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.

  • task_timeout (Optional[Timeout]) – Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - None

  • timeout (Optional[Duration]) – (deprecated) Timeout for the task. Default: - None

  • assign (Optional[Mapping[str, Any]]) – Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps. Default: - Not assign variables

  • outputs (Any) – 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

  • cluster_id (str) – The ClusterId to add the Step to.

  • jar (str) – A path to a JAR file run during the step.

  • name (str) – The name of the Step.

  • action_on_failure (Optional[ActionOnFailure]) – The action to take when the cluster step fails. Default: ActionOnFailure.CONTINUE

  • args (Optional[Sequence[str]]) – A list of command line arguments passed to the JAR file’s main function when executed. Default: - No args

  • execution_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. Default: - Uses EC2 instance profile role

  • main_class (Optional[str]) – 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. Default: - No mainClass

  • properties (Optional[Mapping[str, str]]) – 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. Default: - No properties

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks

# assign: Any
# outputs: Any
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

emr_add_step_jsonata_props = stepfunctions_tasks.EmrAddStepJsonataProps(
    cluster_id="clusterId",
    jar="jar",
    name="name",

    # the properties below are optional
    action_on_failure=stepfunctions_tasks.ActionOnFailure.TERMINATE_CLUSTER,
    args=["args"],
    assign={
        "assign_key": assign
    },
    comment="comment",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    execution_role_arn="executionRoleArn",
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    main_class="mainClass",
    outputs=outputs,
    properties={
        "properties_key": "properties"
    },
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    state_name="stateName",
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30)
)

Attributes

action_on_failure

The action to take when the cluster step fails.

Default:

ActionOnFailure.CONTINUE

See:

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

args

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

Default:

  • No args

See:

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

assign

Workflow variables to store in this step.

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

Default:

  • Not assign variables

See:

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

cluster_id

The ClusterId to add the Step to.

comment

A comment describing this state.

Default:

No comment

credentials

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)

See:

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

execution_role_arn

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

Default:

  • Uses EC2 instance profile role

See:

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

heartbeat

(deprecated) Timeout for the heartbeat.

Default:

  • None

Deprecated:

use heartbeatTimeout

Stability:

deprecated

heartbeat_timeout

Timeout for the heartbeat.

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

Default:

  • None

integration_pattern

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.

See:

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

jar

A path to a JAR file run during the step.

See:

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

main_class

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.

Default:

  • No mainClass

See:

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

name

The name of the Step.

See:

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

outputs

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

See:

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

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.

Default:

  • No properties

See:

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

query_language

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.

Default:

  • JSONPath

state_name

Optional name for this state.

Default:

  • The construct ID will be used as state name

task_timeout

Timeout for the task.

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

Default:

  • None

timeout

(deprecated) Timeout for the task.

Default:

  • None

Deprecated:

use taskTimeout

Stability:

deprecated