BatchSubmitJobJsonataProps

class aws_cdk.aws_stepfunctions_tasks.BatchSubmitJobJsonataProps(*, 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, job_definition_arn, job_name, job_queue_arn, array_size=None, attempts=None, container_overrides=None, depends_on=None, payload=None, tags=None)

Bases: TaskStateJsonataBaseProps

Properties for BatchSubmitJob 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

  • job_definition_arn (str) – The arn of the job definition used by this job.

  • job_name (str) – The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

  • job_queue_arn (str) – The arn of the job queue into which the job is submitted.

  • array_size (Union[int, float, None]) – The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide. Default: - No array size

  • attempts (Union[int, float, None]) – The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value. Default: 1

  • container_overrides (Union[BatchContainerOverrides, Dict[str, Any], None]) – A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. Default: - No container overrides

  • depends_on (Optional[Sequence[Union[BatchJobDependency, Dict[str, Any]]]]) – A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. Default: - No dependencies

  • payload (Optional[TaskInput]) – The payload to be passed as parameters to the batch job. Default: - No parameters are passed

  • tags (Optional[Mapping[str, str]]) – The tags applied to the job request. Default: {} - no tags

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_ec2 as ec2
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks

# assign: Any
# instance_type: ec2.InstanceType
# outputs: Any
# size: cdk.Size
# task_input: stepfunctions.TaskInput
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

batch_submit_job_jsonata_props = stepfunctions_tasks.BatchSubmitJobJsonataProps(
    job_definition_arn="jobDefinitionArn",
    job_name="jobName",
    job_queue_arn="jobQueueArn",

    # the properties below are optional
    array_size=123,
    assign={
        "assign_key": assign
    },
    attempts=123,
    comment="comment",
    container_overrides=stepfunctions_tasks.BatchContainerOverrides(
        command=["command"],
        environment={
            "environment_key": "environment"
        },
        gpu_count=123,
        instance_type=instance_type,
        memory=size,
        vcpus=123
    ),
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    depends_on=[stepfunctions_tasks.BatchJobDependency(
        job_id="jobId",
        type="type"
    )],
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    outputs=outputs,
    payload=task_input,
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    state_name="stateName",
    tags={
        "tags_key": "tags"
    },
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30)
)

Attributes

array_size

The array size can be between 2 and 10,000.

If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Default:

  • No array size

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

attempts

The number of times to move a job to the RUNNABLE status.

You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

Default:

1

comment

A comment describing this state.

Default:

No comment

container_overrides

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.

Default:

  • No container overrides

See:

https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverrides

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

depends_on

A list of dependencies for the job.

A job can depend upon a maximum of 20 jobs.

Default:

  • No dependencies

See:

https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOn

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

job_definition_arn

The arn of the job definition used by this job.

job_name

The name of the job.

The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

job_queue_arn

The arn of the job queue into which the job is submitted.

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

payload

The payload to be passed as parameters to the batch job.

Default:

  • No parameters are passed

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

tags

The tags applied to the job request.

Default:

{} - no tags

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