software.amazon.awscdk.services.stepfunctions.tasks

Interface BatchSubmitJobProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

BatchSubmitJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:42.651Z")
 @Stability(value=Experimental)
public interface BatchSubmitJobProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

(experimental) Properties for RunBatchJob.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BatchSubmitJobProps.Builder A builder for BatchSubmitJobProps
static class	BatchSubmitJobProps.Jsii$Proxy An implementation for BatchSubmitJobProps

Method Summary

Modifier and Type	Method and Description
static BatchSubmitJobProps.Builder	builder()
default Number	getArraySize() (experimental) The array size can be between 2 and 10,000.
default Number	getAttempts() (experimental) The number of times to move a job to the RUNNABLE status.
default BatchContainerOverrides	getContainerOverrides() (experimental) 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 List<BatchJobDependency>	getDependsOn() (experimental) A list of dependencies for the job.
String	getJobDefinitionArn() (experimental) The arn of the job definition used by this job.
String	getJobName() (experimental) The name of the job.
String	getJobQueueArn() (experimental) The arn of the job queue into which the job is submitted.
default TaskInput	getPayload() (experimental) The payload to be passed as parameters to the batch job.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getJobDefinitionArn

@Stability(value=Experimental)
 @NotNull
String getJobDefinitionArn()

(experimental) The arn of the job definition used by this job.

getJobName

@Stability(value=Experimental)
 @NotNull
String getJobName()

(experimental) 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.

getJobQueueArn

@Stability(value=Experimental)
 @NotNull
String getJobQueueArn()

(experimental) The arn of the job queue into which the job is submitted.

getArraySize

@Stability(value=Experimental)
 @Nullable
default Number getArraySize()

(experimental) 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

getAttempts

@Stability(value=Experimental)
 @Nullable
default Number getAttempts()

(experimental) 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

getContainerOverrides

@Stability(value=Experimental)
 @Nullable
default BatchContainerOverrides getContainerOverrides()

(experimental) 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 Also:

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

getDependsOn

@Stability(value=Experimental)
 @Nullable
default List<BatchJobDependency> getDependsOn()

(experimental) A list of dependencies for the job.

A job can depend upon a maximum of 20 jobs.

Default: - No dependencies

See Also:

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

getPayload

@Stability(value=Experimental)
 @Nullable
default TaskInput getPayload()

(experimental) The payload to be passed as parameters to the batch job.

Default: - No parameters are passed

builder

@Stability(value=Experimental)
static BatchSubmitJobProps.Builder builder()

Specified by:

builder in interface TaskStateBaseProps

Returns:

a BatchSubmitJobProps.Builder of BatchSubmitJobProps