software.amazon.awssdk.services.pipes.model

Interface BatchContainerOverrides.Builder

All Superinterfaces:

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

Enclosing class:

BatchContainerOverrides

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

Method Summary

Modifier and Type	Method and Description
BatchContainerOverrides.Builder	command(Collection<String> command) The command to send to the container that overrides the default command from the Docker image or the task definition.
BatchContainerOverrides.Builder	command(String... command) The command to send to the container that overrides the default command from the Docker image or the task definition.
BatchContainerOverrides.Builder	environment(BatchEnvironmentVariable... environment) The environment variables to send to the container.
BatchContainerOverrides.Builder	environment(Collection<BatchEnvironmentVariable> environment) The environment variables to send to the container.
BatchContainerOverrides.Builder	environment(Consumer<BatchEnvironmentVariable.Builder>... environment) The environment variables to send to the container.
BatchContainerOverrides.Builder	instanceType(String instanceType) The instance type to use for a multi-node parallel job.
BatchContainerOverrides.Builder	resourceRequirements(BatchResourceRequirement... resourceRequirements) The type and amount of resources to assign to a container.
BatchContainerOverrides.Builder	resourceRequirements(Collection<BatchResourceRequirement> resourceRequirements) The type and amount of resources to assign to a container.
BatchContainerOverrides.Builder	resourceRequirements(Consumer<BatchResourceRequirement.Builder>... resourceRequirements) The type and amount of resources to assign to a container.

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

command

BatchContainerOverrides.Builder command(Collection<String> command)

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

Parameters:

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

Returns:

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

command

BatchContainerOverrides.Builder command(String... command)

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

Parameters:

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

Returns:

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

environment

BatchContainerOverrides.Builder environment(Collection<BatchEnvironmentVariable> 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 task definition.

Environment variables cannot start with "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 task definition.

Environment variables cannot start with "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

BatchContainerOverrides.Builder environment(BatchEnvironmentVariable... 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 task definition.

Environment variables cannot start with "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 task definition.

Environment variables cannot start with "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

BatchContainerOverrides.Builder environment(Consumer<BatchEnvironmentVariable.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 task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

This is a convenience method that creates an instance of the BatchEnvironmentVariable.Builder avoiding the need to create one manually via BatchEnvironmentVariable.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 BatchEnvironmentVariable.Builder

Returns:

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

See Also:

#environment(java.util.Collection)

instanceType

BatchContainerOverrides.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.

resourceRequirements

BatchContainerOverrides.Builder resourceRequirements(Collection<BatchResourceRequirement> 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

BatchContainerOverrides.Builder resourceRequirements(BatchResourceRequirement... 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

BatchContainerOverrides.Builder resourceRequirements(Consumer<BatchResourceRequirement.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 BatchResourceRequirement.Builder avoiding the need to create one manually via BatchResourceRequirement.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 BatchResourceRequirement.Builder

Returns:

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

See Also:

#resourceRequirements(java.util.Collection)