software.amazon.awssdk.services.batch.model

Interface ContainerOverrides.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ContainerOverrides.Builder,ContainerOverrides>, SdkBuilder<ContainerOverrides.Builder,ContainerOverrides>, SdkPojo

Enclosing class:

ContainerOverrides

public static interface ContainerOverrides.Builder
extends SdkPojo, CopyableBuilder<ContainerOverrides.Builder,ContainerOverrides>

Method Summary

Modifier and Type	Method and Description
ContainerOverrides.Builder	command(Collection<String> command) The command to send to the container that overrides the default command from the Docker image or the job definition.
ContainerOverrides.Builder	command(String... command) The command to send to the container that overrides the default command from the Docker image or the job definition.
ContainerOverrides.Builder	environment(Collection<KeyValuePair> environment) The environment variables to send to the container.
ContainerOverrides.Builder	environment(Consumer<KeyValuePair.Builder>... environment) The environment variables to send to the container.
ContainerOverrides.Builder	environment(KeyValuePair... environment) The environment variables to send to the container.
ContainerOverrides.Builder	instanceType(String instanceType) The instance type to use for a multi-node parallel job.
ContainerOverrides.Builder	memory(Integer memory) This parameter indicates the amount of memory (in MiB) that's reserved for the job.
ContainerOverrides.Builder	resourceRequirements(Collection<ResourceRequirement> resourceRequirements) The type and amount of resources to assign to a container.
ContainerOverrides.Builder	resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements) The type and amount of resources to assign to a container.
ContainerOverrides.Builder	resourceRequirements(ResourceRequirement... resourceRequirements) The type and amount of resources to assign to a container.
ContainerOverrides.Builder	vcpus(Integer vcpus) This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

vcpus

ContainerOverrides.Builder vcpus(Integer vcpus)

This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.

Parameters:

vcpus - This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.

Returns:

Returns a reference to this object so that method calls can be chained together.

memory

ContainerOverrides.Builder memory(Integer memory)

This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

Parameters:

memory - This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

Returns:

Returns a reference to this object so that method calls can be chained together.

command

ContainerOverrides.Builder command(Collection<String> command)

The command to send to the container that overrides the default command from the Docker image or the job definition.

Parameters:

command - The command to send to the container that overrides the default command from the Docker image or the job definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

command

ContainerOverrides.Builder command(String... command)

The command to send to the container that overrides the default command from the Docker image or the job definition.

Parameters:

command - The command to send to the container that overrides the default command from the Docker image or the job definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceType

ContainerOverrides.Builder instanceType(String instanceType)

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or for jobs running on Fargate resources and shouldn't be provided.

Parameters:

instanceType - The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or for jobs running on Fargate resources and shouldn't be provided.

Returns:

Returns a reference to this object so that method calls can be chained together.

environment

ContainerOverrides.Builder environment(Collection<KeyValuePair> environment)

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Parameters:

environment - The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Returns:

Returns a reference to this object so that method calls can be chained together.

environment

ContainerOverrides.Builder environment(KeyValuePair... environment)

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Parameters:

environment - The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Returns:

Returns a reference to this object so that method calls can be chained together.

environment

ContainerOverrides.Builder environment(Consumer<KeyValuePair.Builder>... environment)

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #environment(List).

Parameters:

environment - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#environment(List)

resourceRequirements

ContainerOverrides.Builder resourceRequirements(Collection<ResourceRequirement> resourceRequirements)

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

Parameters:

resourceRequirements - The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceRequirements

ContainerOverrides.Builder resourceRequirements(ResourceRequirement... resourceRequirements)

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

Parameters:

resourceRequirements - The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceRequirements

ContainerOverrides.Builder resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements)

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #resourceRequirements(List).

Parameters:

resourceRequirements - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#resourceRequirements(List)