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) Deprecated. This field is deprecated, use resourceRequirements instead.
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) Deprecated. This field is deprecated, use resourceRequirements instead.

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

@Deprecated
ContainerOverrides.Builder vcpus(Integer vcpus)

Deprecated. This field is deprecated, use resourceRequirements instead.

This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

Parameters:

vcpus - This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

Returns:

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

memory

@Deprecated
ContainerOverrides.Builder memory(Integer memory)

Deprecated. This field is deprecated, use resourceRequirements instead.

This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

Parameters:

memory - This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

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.

This parameter can't contain an empty string.

Parameters:

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

This parameter can't contain an empty string.

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.

This parameter can't contain an empty string.

Parameters:

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

This parameter can't contain an empty string.

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 jobs that run 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 jobs that run 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 cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

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 cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

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 cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

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 cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

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 cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

This is a convenience method that creates an instance of the KeyValuePair.Builder avoiding the need to create one manually via KeyValuePair.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #environment(List).

Parameters:

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

Returns:

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

See Also:

#environment(java.util.Collection)

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 method that creates an instance of the ResourceRequirement.Builder avoiding the need to create one manually via ResourceRequirement.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #resourceRequirements(List).

Parameters:

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

Returns:

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

See Also:

#resourceRequirements(java.util.Collection)