Package software.amazon.awscdk.services.batch

Class JobDefinitionContainer.Builder

java.lang.Object

software.amazon.awscdk.services.batch.JobDefinitionContainer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JobDefinitionContainer>

Enclosing interface:

JobDefinitionContainer

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

A builder for JobDefinitionContainer

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JobDefinitionContainer.Builder	assignPublicIp(Boolean assignPublicIp)	Sets the value of JobDefinitionContainer.getAssignPublicIp()
JobDefinitionContainer	build()	Builds the configured instance.
JobDefinitionContainer.Builder	command(List<String> command)	Sets the value of JobDefinitionContainer.getCommand()
JobDefinitionContainer.Builder	environment(Map<String,String> environment)	Sets the value of JobDefinitionContainer.getEnvironment()
JobDefinitionContainer.Builder	executionRole(IRole executionRole)	Sets the value of JobDefinitionContainer.getExecutionRole()
JobDefinitionContainer.Builder	gpuCount(Number gpuCount)	Sets the value of JobDefinitionContainer.getGpuCount()
JobDefinitionContainer.Builder	image(ContainerImage image)	Sets the value of JobDefinitionContainer.getImage()
JobDefinitionContainer.Builder	instanceType(InstanceType instanceType)	Sets the value of JobDefinitionContainer.getInstanceType()
JobDefinitionContainer.Builder	jobRole(IRole jobRole)	Sets the value of JobDefinitionContainer.getJobRole()
JobDefinitionContainer.Builder	linuxParams(LinuxParameters linuxParams)	Sets the value of JobDefinitionContainer.getLinuxParams()
JobDefinitionContainer.Builder	logConfiguration(LogConfiguration logConfiguration)	Sets the value of JobDefinitionContainer.getLogConfiguration()
JobDefinitionContainer.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of JobDefinitionContainer.getMemoryLimitMiB()
JobDefinitionContainer.Builder	mountPoints(List<? extends MountPoint> mountPoints)	Sets the value of JobDefinitionContainer.getMountPoints()
JobDefinitionContainer.Builder	platformVersion(FargatePlatformVersion platformVersion)	Sets the value of JobDefinitionContainer.getPlatformVersion()
JobDefinitionContainer.Builder	privileged(Boolean privileged)	Sets the value of JobDefinitionContainer.getPrivileged()
JobDefinitionContainer.Builder	readOnly(Boolean readOnly)	Sets the value of JobDefinitionContainer.getReadOnly()
JobDefinitionContainer.Builder	ulimits(List<? extends Ulimit> ulimits)	Sets the value of JobDefinitionContainer.getUlimits()
JobDefinitionContainer.Builder	user(String user)	Sets the value of JobDefinitionContainer.getUser()
JobDefinitionContainer.Builder	vcpus(Number vcpus)	Sets the value of JobDefinitionContainer.getVcpus()
JobDefinitionContainer.Builder	volumes(List<? extends Volume> volumes)	Sets the value of JobDefinitionContainer.getVolumes()

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

image

@Stability(Experimental)
public JobDefinitionContainer.Builder image(ContainerImage image)

Sets the value of JobDefinitionContainer.getImage()

Parameters:

image - The image used to start a container. This parameter is required.

Returns:

this

assignPublicIp

@Stability(Experimental)
public JobDefinitionContainer.Builder assignPublicIp(Boolean assignPublicIp)

Sets the value of JobDefinitionContainer.getAssignPublicIp()

Parameters:

assignPublicIp - Whether or not to assign a public IP to the job.

Returns:

this

command

@Stability(Experimental)
public JobDefinitionContainer.Builder command(List<String> command)

Sets the value of JobDefinitionContainer.getCommand()

Parameters:

command - The command that is passed to the container. If you provide a shell command as a single string, you have to quote command-line arguments.

Returns:

this

environment

@Stability(Experimental)
public JobDefinitionContainer.Builder environment(Map<String,String> environment)

Sets the value of JobDefinitionContainer.getEnvironment()

Parameters:

environment - The environment variables to pass to the container.

Returns:

this

executionRole

@Stability(Experimental)
public JobDefinitionContainer.Builder executionRole(IRole executionRole)

Sets the value of JobDefinitionContainer.getExecutionRole()

Parameters:

executionRole - The IAM role that AWS Batch can assume. Required when using Fargate.

Returns:

this

gpuCount

@Stability(Experimental)
public JobDefinitionContainer.Builder gpuCount(Number gpuCount)

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

Sets the value of JobDefinitionContainer.getInstanceType()

Parameters:

instanceType - The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.

Returns:

this

jobRole

@Stability(Experimental)
public JobDefinitionContainer.Builder jobRole(IRole jobRole)

Sets the value of JobDefinitionContainer.getJobRole()

Parameters:

jobRole - The IAM role that the container can assume for AWS permissions.

Returns:

this

linuxParams

@Stability(Experimental)
public JobDefinitionContainer.Builder linuxParams(LinuxParameters linuxParams)

Sets the value of JobDefinitionContainer.getLinuxParams()

Parameters:

linuxParams - Linux-specific modifications that are applied to the container, such as details for device mappings. For now, only the devices property is supported.

Returns:

this

logConfiguration

@Stability(Experimental)
public JobDefinitionContainer.Builder logConfiguration(LogConfiguration logConfiguration)

Sets the value of JobDefinitionContainer.getLogConfiguration()

Parameters:

logConfiguration - The log configuration specification for the container.

Returns:

this

memoryLimitMiB

@Stability(Experimental)
public JobDefinitionContainer.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of JobDefinitionContainer.getMemoryLimitMiB()

Parameters:

memoryLimitMiB - The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. You must specify at least 4 MiB of memory for EC2 and 512 MiB for Fargate.

Returns:

this

mountPoints

@Stability(Experimental)
public JobDefinitionContainer.Builder mountPoints(List<? extends MountPoint> mountPoints)

Sets the value of JobDefinitionContainer.getMountPoints()

Parameters:

mountPoints - The mount points for data volumes in your container.

Returns:

this

platformVersion

@Stability(Experimental)
public JobDefinitionContainer.Builder platformVersion(FargatePlatformVersion platformVersion)

Sets the value of JobDefinitionContainer.getPlatformVersion()

Parameters:

platformVersion - Fargate platform version.

Returns:

this

privileged

@Stability(Experimental)
public JobDefinitionContainer.Builder privileged(Boolean privileged)

Sets the value of JobDefinitionContainer.getPrivileged()

Parameters:

privileged - When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

Returns:

this

readOnly

@Stability(Experimental)
public JobDefinitionContainer.Builder readOnly(Boolean readOnly)

Sets the value of JobDefinitionContainer.getReadOnly()

Parameters:

readOnly - When this parameter is true, the container is given read-only access to its root file system.

Returns:

this

ulimits

@Stability(Experimental)
public JobDefinitionContainer.Builder ulimits(List<? extends Ulimit> ulimits)

Sets the value of JobDefinitionContainer.getUlimits()

Parameters:

ulimits - A list of ulimits to set in the container.

Returns:

this

user

@Stability(Experimental)
public JobDefinitionContainer.Builder user(String user)

Sets the value of JobDefinitionContainer.getUser()

Parameters:

user - The user name to use inside the container.

Returns:

this

vcpus

@Stability(Experimental)
public JobDefinitionContainer.Builder vcpus(Number vcpus)

Sets the value of JobDefinitionContainer.getVcpus()

Parameters:

vcpus - The number of vCPUs reserved for the container. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU for EC2 and 0.25 for Fargate.

Returns:

this

volumes

@Stability(Experimental)
public JobDefinitionContainer.Builder volumes(List<? extends Volume> volumes)

Sets the value of JobDefinitionContainer.getVolumes()

Parameters:

volumes - A list of data volumes used in a job.

Returns:

this

build

@Stability(Experimental)
public JobDefinitionContainer build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of JobDefinitionContainer

Throws:

NullPointerException - if any required attribute was not provided