RunBatchJobProps (software.amazon.awscdk:stepfunctions-tasks 1.41.0 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: RunBatchJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-21T11:02:02.774Z")
 @Stability(value=Experimental)
public interface RunBatchJobProps
extends software.amazon.jsii.JsiiSerializable

Properties for RunBatchJob.

EXPERIMENTAL

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RunBatchJobProps.Builder` A builder for `RunBatchJobProps`
`static class`	`RunBatchJobProps.Jsii$Proxy` An implementation for `RunBatchJobProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static RunBatchJobProps.Builder`	`builder()`
`default Number`	`getArraySize()` The array size can be between 2 and 10,000.
`default Number`	`getAttempts()` The number of times to move a job to the RUNNABLE status.
`default ContainerOverrides`	`getContainerOverrides()` 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<JobDependency>`	`getDependsOn()` A list of dependencies for the job.
`default ServiceIntegrationPattern`	`getIntegrationPattern()` The service integration pattern indicates different ways to call TerminateCluster.
`IJobDefinition`	`getJobDefinition()` The job definition used by this job.
`String`	`getJobName()` The name of the job.
`IJobQueue`	`getJobQueue()` The job queue into which the job is submitted.
`default Map<String,Object>`	`getPayload()` The payload to be passed as parametrs to the batch job.
`default Duration`	`getTimeout()` The timeout configuration for this SubmitJob operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getJobDefinition
```
@Stability(value=Experimental)
 @NotNull
IJobDefinition getJobDefinition()
```
    The job definition used by this job.
    EXPERIMENTAL
  - getJobName
```
@Stability(value=Experimental)
 @NotNull
String getJobName()
```
    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.
    EXPERIMENTAL
  - getJobQueue
```
@Stability(value=Experimental)
 @NotNull
IJobQueue getJobQueue()
```
    The job queue into which the job is submitted.
    EXPERIMENTAL
  - getArraySize
```
@Stability(value=Experimental)
 @Nullable
default Number getArraySize()
```
    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
    EXPERIMENTAL
  - getAttempts
```
@Stability(value=Experimental)
 @Nullable
default Number getAttempts()
```
    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
    EXPERIMENTAL
  - getContainerOverrides
```
@Stability(value=Experimental)
 @Nullable
default ContainerOverrides getContainerOverrides()
```
    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
    EXPERIMENTAL
    
    See Also:
    
    https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverrides
  - getDependsOn
```
@Stability(value=Experimental)
 @Nullable
default List<JobDependency> getDependsOn()
```
    A list of dependencies for the job.
    A job can depend upon a maximum of 20 jobs.
    Default: - No dependencies
    EXPERIMENTAL
    
    See Also:
    
    https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOn
  - getIntegrationPattern
```
@Stability(value=Experimental)
 @Nullable
default ServiceIntegrationPattern getIntegrationPattern()
```
    The service integration pattern indicates different ways to call TerminateCluster.
    The valid value is either FIRE_AND_FORGET or SYNC.
    Default: SYNC
    EXPERIMENTAL
  - getPayload
```
@Stability(value=Experimental)
 @Nullable
default Map<String,Object> getPayload()
```
    The payload to be passed as parametrs to the batch job.
    Default: - No parameters are passed
    EXPERIMENTAL
  - getTimeout
```
@Stability(value=Experimental)
 @Nullable
default Duration getTimeout()
```
    The timeout configuration for this SubmitJob operation.
    The minimum value for the timeout is 60 seconds.
    Default: - No timeout
    EXPERIMENTAL
    
    See Also:
    
    https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-timeout
  - builder
```
@Stability(value=Experimental)
static RunBatchJobProps.Builder builder()
```
    Returns:
    
    a RunBatchJobProps.Builder of RunBatchJobProps

Interface RunBatchJobProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getJobDefinition

getJobName

getJobQueue

getArraySize

getAttempts

getContainerOverrides

getDependsOn

getIntegrationPattern

getPayload

getTimeout

builder