batch/aws.sdk.kotlin.services.batch.model/SubmitJobRequest/Builder

Builder

Properties

The array properties for the submitted job, such as the size of the array. 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 Batch User Guide.

containerOverrides

var containerOverrides: ContainerOverrides?

An object with various properties that override the defaults for the job definition that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

dependsOn

var dependsOn: List<JobDependency>?

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

eksPropertiesOverride

var eksPropertiesOverride: EksPropertiesOverride?

An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.

jobDefinition

var jobDefinition: String?

The job definition used by this job. This value can be one of definition-name, definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with or without the revision (arn:aws:batch:region:account:job-definition/definition-name:revision , or arn:aws:batch:region:account:job-definition/definition-name ).

jobName

var jobName: String?

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

jobQueue

var jobQueue: String?

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

nodeOverrides

var nodeOverrides: NodeOverrides?

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

parameters

var parameters: Map<String, String>?

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

propagateTags

var propagateTags: Boolean?

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.

retryStrategy

var retryStrategy: RetryStrategy?

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

schedulingPriorityOverride

var schedulingPriorityOverride: Int?

The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition and works only within a single share identifier.

shareIdentifier

var shareIdentifier: String?

The share identifier for the job. Don't specify this parameter if the job queue doesn't have a scheduling policy. If the job queue has a scheduling policy, then this parameter must be specified.