Package software.amazon.awscdk.services.batch

Class EcsEc2ContainerDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.EcsEc2ContainerDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsEc2ContainerDefinitionProps>

Enclosing interface:

EcsEc2ContainerDefinitionProps

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

A builder for EcsEc2ContainerDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EcsEc2ContainerDefinitionProps	build()	Builds the configured instance.
EcsEc2ContainerDefinitionProps.Builder	command(List<String> command)	Sets the value of EcsContainerDefinitionProps.getCommand()
EcsEc2ContainerDefinitionProps.Builder	cpu(Number cpu)	Sets the value of EcsContainerDefinitionProps.getCpu()
EcsEc2ContainerDefinitionProps.Builder	environment(Map<String,String> environment)	Sets the value of EcsContainerDefinitionProps.getEnvironment()
EcsEc2ContainerDefinitionProps.Builder	executionRole(IRole executionRole)	Sets the value of EcsContainerDefinitionProps.getExecutionRole()
EcsEc2ContainerDefinitionProps.Builder	gpu(Number gpu)	Sets the value of EcsEc2ContainerDefinitionProps.getGpu()
EcsEc2ContainerDefinitionProps.Builder	image(ContainerImage image)	Sets the value of EcsContainerDefinitionProps.getImage()
EcsEc2ContainerDefinitionProps.Builder	jobRole(IRole jobRole)	Sets the value of EcsContainerDefinitionProps.getJobRole()
EcsEc2ContainerDefinitionProps.Builder	linuxParameters(LinuxParameters linuxParameters)	Sets the value of EcsContainerDefinitionProps.getLinuxParameters()
EcsEc2ContainerDefinitionProps.Builder	logging(LogDriver logging)	Sets the value of EcsContainerDefinitionProps.getLogging()
EcsEc2ContainerDefinitionProps.Builder	memory(Size memory)	Sets the value of EcsContainerDefinitionProps.getMemory()
EcsEc2ContainerDefinitionProps.Builder	privileged(Boolean privileged)	Sets the value of EcsEc2ContainerDefinitionProps.getPrivileged()
EcsEc2ContainerDefinitionProps.Builder	readonlyRootFilesystem(Boolean readonlyRootFilesystem)	Sets the value of EcsContainerDefinitionProps.getReadonlyRootFilesystem()
EcsEc2ContainerDefinitionProps.Builder	secrets(Map<String,? extends Secret> secrets)	Sets the value of EcsContainerDefinitionProps.getSecrets()
EcsEc2ContainerDefinitionProps.Builder	ulimits(List<? extends Ulimit> ulimits)	Sets the value of EcsEc2ContainerDefinitionProps.getUlimits()
EcsEc2ContainerDefinitionProps.Builder	user(String user)	Sets the value of EcsContainerDefinitionProps.getUser()
EcsEc2ContainerDefinitionProps.Builder	volumes(List<? extends EcsVolume> volumes)	Sets the value of EcsContainerDefinitionProps.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

gpu

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder gpu(Number gpu)

Sets the value of EcsEc2ContainerDefinitionProps.getGpu()

Parameters:

gpu - The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

Returns:

this

privileged

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder privileged(Boolean privileged)

Sets the value of EcsEc2ContainerDefinitionProps.getPrivileged()

Parameters:

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

Returns:

this

ulimits

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder ulimits(List<? extends Ulimit> ulimits)

Sets the value of EcsEc2ContainerDefinitionProps.getUlimits()

Parameters:

ulimits - Limits to set for the user this docker container will run as.

Returns:

this

cpu

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder cpu(Number cpu)

Sets the value of EcsContainerDefinitionProps.getCpu()

Parameters:

cpu - The number of vCPUs reserved for the container. This parameter is required. Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.

Returns:

this

image

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder image(ContainerImage image)

Sets the value of EcsContainerDefinitionProps.getImage()

Parameters:

image - The image that this container will run. This parameter is required.

Returns:

this

memory

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

Sets the value of EcsContainerDefinitionProps.getMemory()

Parameters:

memory - The memory hard limit present to the container. This parameter is required. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job.

Returns:

this

command

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

Sets the value of EcsContainerDefinitionProps.getCommand()

Parameters:

command - The command that's passed to the container.

Returns:

this

environment

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

Sets the value of EcsContainerDefinitionProps.getEnvironment()

Parameters:

environment - The environment variables to pass to a container. Cannot start with AWS_BATCH. We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Returns:

this

executionRole

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder executionRole(IRole executionRole)

Sets the value of EcsContainerDefinitionProps.getExecutionRole()

Parameters:

executionRole - The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.

Returns:

this

jobRole

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder jobRole(IRole jobRole)

Sets the value of EcsContainerDefinitionProps.getJobRole()

Parameters:

jobRole - The role that the container can assume.

Returns:

this

linuxParameters

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder linuxParameters(LinuxParameters linuxParameters)

Sets the value of EcsContainerDefinitionProps.getLinuxParameters()

Parameters:

linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.

Returns:

this

logging

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder logging(LogDriver logging)

Sets the value of EcsContainerDefinitionProps.getLogging()

Parameters:

logging - The loging configuration for this Job.

Returns:

this

readonlyRootFilesystem

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder readonlyRootFilesystem(Boolean readonlyRootFilesystem)

Sets the value of EcsContainerDefinitionProps.getReadonlyRootFilesystem()

Parameters:

readonlyRootFilesystem - Gives the container readonly access to its root filesystem.

Returns:

this

secrets

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder secrets(Map<String,? extends Secret> secrets)

Sets the value of EcsContainerDefinitionProps.getSecrets()

Parameters:

secrets - A map from environment variable names to the secrets for the container. Allows your job definitions to reference the secret by the environment variable name defined in this property.

Returns:

this

user

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder user(String user)

Sets the value of EcsContainerDefinitionProps.getUser()

Parameters:

user - The user name to use inside the container.

Returns:

this

volumes

@Stability(Stable)
public EcsEc2ContainerDefinitionProps.Builder volumes(List<? extends EcsVolume> volumes)

Sets the value of EcsContainerDefinitionProps.getVolumes()

Parameters:

volumes - The volumes to mount to this container. Automatically added to the job definition.

Returns:

this

build

@Stability(Stable)
public EcsEc2ContainerDefinitionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EcsEc2ContainerDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided