Package software.amazon.awscdk.services.stepfunctions.tasks

Class BatchContainerOverrides.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.BatchContainerOverrides.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BatchContainerOverrides>

Enclosing interface:

BatchContainerOverrides

@Stability(Stable)
public static final class BatchContainerOverrides.Builder
extends Object
implements software.amazon.jsii.Builder<BatchContainerOverrides>

A builder for BatchContainerOverrides

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BatchContainerOverrides	build()	Builds the configured instance.
BatchContainerOverrides.Builder	command(List<String> command)	Sets the value of BatchContainerOverrides.getCommand()
BatchContainerOverrides.Builder	environment(Map<String,String> environment)	Sets the value of BatchContainerOverrides.getEnvironment()
BatchContainerOverrides.Builder	gpuCount(Number gpuCount)	Sets the value of BatchContainerOverrides.getGpuCount()
BatchContainerOverrides.Builder	instanceType(InstanceType instanceType)	Sets the value of BatchContainerOverrides.getInstanceType()
BatchContainerOverrides.Builder	memory(Size memory)	Sets the value of BatchContainerOverrides.getMemory()
BatchContainerOverrides.Builder	vcpus(Number vcpus)	Sets the value of BatchContainerOverrides.getVcpus()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

command

@Stability(Stable)
public BatchContainerOverrides.Builder command(List<String> command)

Sets the value of BatchContainerOverrides.getCommand()

Parameters:

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

Returns:

this

environment

@Stability(Stable)
public BatchContainerOverrides.Builder environment(Map<String,String> environment)

Sets the value of BatchContainerOverrides.getEnvironment()

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.

Returns:

this

gpuCount

@Stability(Stable)
public BatchContainerOverrides.Builder gpuCount(Number gpuCount)

Sets the value of BatchContainerOverrides.getGpuCount()

Parameters:

gpuCount - The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.

Returns:

this

instanceType

@Stability(Stable)
public BatchContainerOverrides.Builder instanceType(InstanceType instanceType)

Sets the value of BatchContainerOverrides.getInstanceType()

Parameters:

instanceType - The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Returns:

this

memory

@Stability(Stable)
public BatchContainerOverrides.Builder memory(Size memory)

Sets the value of BatchContainerOverrides.getMemory()

Parameters:

memory - Memory reserved for the job.

Returns:

this

vcpus

@Stability(Stable)
public BatchContainerOverrides.Builder vcpus(Number vcpus)

Sets the value of BatchContainerOverrides.getVcpus()

Parameters:

vcpus - The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

Returns:

this

build

@Stability(Stable)
public BatchContainerOverrides build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BatchContainerOverrides>

Returns:

a new instance of BatchContainerOverrides

Throws:

NullPointerException - if any required attribute was not provided