aws-cdk-lib.aws_stepfunctions_tasks.BatchSubmitJobProps

BatchSubmitJobProps Struct

Properties for BatchSubmitJob.

BatchSubmitJobProps

extends

• TaskStateBaseProps

Source

aws-stepfunctions-tasks/lib/batch/submit-job.ts

Type last changed

v2.89.0 · 28 Jul 2023

Example

import * as batch from 'aws-cdk-lib/aws-batch';
declare const batchJobDefinition: batch.EcsJobDefinition;
declare const batchQueue: batch.JobQueue;

const task = new tasks.BatchSubmitJob(this, 'Submit Job', {
  jobDefinitionArn: batchJobDefinition.jobDefinitionArn,
  jobName: 'MyJob',
  jobQueueArn: batchQueue.jobQueueArn,
});

Properties

arraySizenumberarray_sizeint | floatarraySizeNumberArraySizedoubleArraySize*float64= No 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.

assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}= 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.

attemptsnumberattemptsint | floatattemptsNumberAttemptsdoubleAttempts*float64= 1#

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.

commentstringcommentstrcommentStringCommentstringComment*string= No comment#

A comment describing this state.

containerOverridesBatchContainerOverridescontainer_overridesBatchContainerOverridescontainerOverridesBatchContainerOverridesContainerOverridesBatchContainerOverridesContainerOverridesBatchContainerOverrides= No 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.

credentialsCredentialscredentialsCredentialscredentialsCredentialsCredentialsCredentialsCredentialsCredentials= None (Task is executed using the…#

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

default

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

dependsOnBatchJobDependency[]depends_ontyping.List[BatchJobDependency]dependsOnList<BatchJobDependency>DependsOnBatchJobDependency[]DependsOn*[]BatchJobDependency= No dependencies#

A list of dependencies for the job.

A job can depend upon a maximum of 20 jobs.

heartbeatDurationheartbeatDurationheartbeatDurationHeartbeatDurationHeartbeatDuration= Nonedeprecated#

use `heartbeatTimeout`

heartbeatTimeoutTimeoutheartbeat_timeoutTimeoutheartbeatTimeoutTimeoutHeartbeatTimeoutTimeoutHeartbeatTimeoutTimeout= None#

Timeout for the heartbeat.

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

inputPathstringinput_pathstrinputPathStringInputPathstringInputPath*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 {}.

integrationPatternIntegrationPatternintegration_patternIntegrationPatternintegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPattern= `IntegrationPattern.REQUEST_RESP…#

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

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

jobDefinitionArnstringjob_definition_arnstrjobDefinitionArnStringJobDefinitionArnstringJobDefinitionArn*stringrequired#

The arn of the job definition used by this job.

jobNamestringjob_namestrjobNameStringJobNamestringJobName*stringrequired#

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.

jobQueueArnstringjob_queue_arnstrjobQueueArnStringJobQueueArnstringJobQueueArn*stringrequired#

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

outputPathstringoutput_pathstroutputPathStringOutputPathstringOutputPath*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 {}.

outputsanyoutputsAnyoutputsObjectOutputsobjectOutputsinterface{}= $states.result or $states.errorO…#

Used to specify and transform output from the state.

notes · default

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

payloadTaskInputpayloadTaskInputpayloadTaskInputPayloadTaskInputPayloadTaskInput= No parameters are passed#

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

queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= 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.

resultPathstringresult_pathstrresultPathStringResultPathstringResultPath*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 }result_selectortyping.Mapping[str, Any]resultSelectorMap<String, Object>ResultSelectorIDictionary<string, object>ResultSelector*map[string]interface{}= 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.

stateNamestringstate_namestrstateNameStringStateNamestringStateName*string= The construct ID will be used as…#

Optional name for this state.

default

Default: The construct ID will be used as state name

tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= {} - no tags#

The tags applied to the job request.

taskTimeoutTimeouttask_timeoutTimeouttaskTimeoutTimeoutTaskTimeoutTimeoutTaskTimeoutTimeout= None#

Timeout for the task.

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

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Nonedeprecated#

use `taskTimeout`

Used as props by

• BatchSubmitJob