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

Class ContainerOverrides.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ContainerOverrides>

Enclosing interface:

ContainerOverrides

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

A builder for ContainerOverrides

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContainerOverrides	build()	Builds the configured instance.
ContainerOverrides.Builder	command(List<String> command)	Sets the value of ContainerOverrides.getCommand()
ContainerOverrides.Builder	environment(Map<String,String> environment)	Sets the value of ContainerOverrides.getEnvironment()
ContainerOverrides.Builder	gpuCount(Number gpuCount)	Sets the value of ContainerOverrides.getGpuCount()
ContainerOverrides.Builder	instanceType(InstanceType instanceType)	Sets the value of ContainerOverrides.getInstanceType()
ContainerOverrides.Builder	memory(Number memory)	Sets the value of ContainerOverrides.getMemory()
ContainerOverrides.Builder	vcpus(Number vcpus)	Sets the value of ContainerOverrides.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 ContainerOverrides.Builder command(List<String> command)

Sets the value of ContainerOverrides.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 ContainerOverrides.Builder environment(Map<String,String> environment)

Sets the value of ContainerOverrides.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 ContainerOverrides.Builder gpuCount(Number gpuCount)

Sets the value of ContainerOverrides.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 ContainerOverrides.Builder instanceType(InstanceType instanceType)

Sets the value of ContainerOverrides.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 ContainerOverrides.Builder memory(Number memory)

Sets the value of ContainerOverrides.getMemory()

Parameters:

memory - The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

Returns:

this

vcpus

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

Sets the value of ContainerOverrides.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 ContainerOverrides build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ContainerOverrides

Throws:

NullPointerException - if any required attribute was not provided