Package software.amazon.awscdk.services.ecs

Class ContainerDefinitionOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.ContainerDefinitionOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ContainerDefinitionOptions>

Enclosing interface:

ContainerDefinitionOptions

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

A builder for ContainerDefinitionOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContainerDefinitionOptions	build()	Builds the configured instance.
ContainerDefinitionOptions.Builder	command(List<String> command)	Sets the value of ContainerDefinitionOptions.getCommand()
ContainerDefinitionOptions.Builder	containerName(String containerName)	Sets the value of ContainerDefinitionOptions.getContainerName()
ContainerDefinitionOptions.Builder	cpu(Number cpu)	Sets the value of ContainerDefinitionOptions.getCpu()
ContainerDefinitionOptions.Builder	credentialSpecs(List<? extends CredentialSpec> credentialSpecs)	Sets the value of ContainerDefinitionOptions.getCredentialSpecs()
ContainerDefinitionOptions.Builder	disableNetworking(Boolean disableNetworking)	Sets the value of ContainerDefinitionOptions.getDisableNetworking()
ContainerDefinitionOptions.Builder	dnsSearchDomains(List<String> dnsSearchDomains)	Sets the value of ContainerDefinitionOptions.getDnsSearchDomains()
ContainerDefinitionOptions.Builder	dnsServers(List<String> dnsServers)	Sets the value of ContainerDefinitionOptions.getDnsServers()
ContainerDefinitionOptions.Builder	dockerLabels(Map<String,String> dockerLabels)	Sets the value of ContainerDefinitionOptions.getDockerLabels()
ContainerDefinitionOptions.Builder	dockerSecurityOptions(List<String> dockerSecurityOptions)	Sets the value of ContainerDefinitionOptions.getDockerSecurityOptions()
ContainerDefinitionOptions.Builder	entryPoint(List<String> entryPoint)	Sets the value of ContainerDefinitionOptions.getEntryPoint()
ContainerDefinitionOptions.Builder	environment(Map<String,String> environment)	Sets the value of ContainerDefinitionOptions.getEnvironment()
ContainerDefinitionOptions.Builder	environmentFiles(List<? extends EnvironmentFile> environmentFiles)	Sets the value of ContainerDefinitionOptions.getEnvironmentFiles()
ContainerDefinitionOptions.Builder	essential(Boolean essential)	Sets the value of ContainerDefinitionOptions.getEssential()
ContainerDefinitionOptions.Builder	extraHosts(Map<String,String> extraHosts)	Sets the value of ContainerDefinitionOptions.getExtraHosts()
ContainerDefinitionOptions.Builder	gpuCount(Number gpuCount)	Sets the value of ContainerDefinitionOptions.getGpuCount()
ContainerDefinitionOptions.Builder	healthCheck(HealthCheck healthCheck)	Sets the value of ContainerDefinitionOptions.getHealthCheck()
ContainerDefinitionOptions.Builder	hostname(String hostname)	Sets the value of ContainerDefinitionOptions.getHostname()
ContainerDefinitionOptions.Builder	image(ContainerImage image)	Sets the value of ContainerDefinitionOptions.getImage()
ContainerDefinitionOptions.Builder	inferenceAcceleratorResources(List<String> inferenceAcceleratorResources)	Sets the value of ContainerDefinitionOptions.getInferenceAcceleratorResources()
ContainerDefinitionOptions.Builder	interactive(Boolean interactive)	Sets the value of ContainerDefinitionOptions.getInteractive()
ContainerDefinitionOptions.Builder	linuxParameters(LinuxParameters linuxParameters)	Sets the value of ContainerDefinitionOptions.getLinuxParameters()
ContainerDefinitionOptions.Builder	logging(LogDriver logging)	Sets the value of ContainerDefinitionOptions.getLogging()
ContainerDefinitionOptions.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of ContainerDefinitionOptions.getMemoryLimitMiB()
ContainerDefinitionOptions.Builder	memoryReservationMiB(Number memoryReservationMiB)	Sets the value of ContainerDefinitionOptions.getMemoryReservationMiB()
ContainerDefinitionOptions.Builder	portMappings(List<? extends PortMapping> portMappings)	Sets the value of ContainerDefinitionOptions.getPortMappings()
ContainerDefinitionOptions.Builder	privileged(Boolean privileged)	Sets the value of ContainerDefinitionOptions.getPrivileged()
ContainerDefinitionOptions.Builder	pseudoTerminal(Boolean pseudoTerminal)	Sets the value of ContainerDefinitionOptions.getPseudoTerminal()
ContainerDefinitionOptions.Builder	readonlyRootFilesystem(Boolean readonlyRootFilesystem)	Sets the value of ContainerDefinitionOptions.getReadonlyRootFilesystem()
ContainerDefinitionOptions.Builder	secrets(Map<String,? extends Secret> secrets)	Sets the value of ContainerDefinitionOptions.getSecrets()
ContainerDefinitionOptions.Builder	startTimeout(Duration startTimeout)	Sets the value of ContainerDefinitionOptions.getStartTimeout()
ContainerDefinitionOptions.Builder	stopTimeout(Duration stopTimeout)	Sets the value of ContainerDefinitionOptions.getStopTimeout()
ContainerDefinitionOptions.Builder	systemControls(List<? extends SystemControl> systemControls)	Sets the value of ContainerDefinitionOptions.getSystemControls()
ContainerDefinitionOptions.Builder	ulimits(List<? extends Ulimit> ulimits)	Sets the value of ContainerDefinitionOptions.getUlimits()
ContainerDefinitionOptions.Builder	user(String user)	Sets the value of ContainerDefinitionOptions.getUser()
ContainerDefinitionOptions.Builder	workingDirectory(String workingDirectory)	Sets the value of ContainerDefinitionOptions.getWorkingDirectory()

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(Stable)
public ContainerDefinitionOptions.Builder image(ContainerImage image)

Sets the value of ContainerDefinitionOptions.getImage()

Parameters:

image - The image used to start a container. This parameter is required. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. TODO: Update these to specify using classes of IContainerImage

Returns:

this

command

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

Sets the value of ContainerDefinitionOptions.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

containerName

@Stability(Stable)
public ContainerDefinitionOptions.Builder containerName(String containerName)

Sets the value of ContainerDefinitionOptions.getContainerName()

Parameters:

containerName - The name of the container.

Returns:

this

cpu

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

Sets the value of ContainerDefinitionOptions.getCpu()

Parameters:

cpu - The minimum number of CPU units to reserve for the container.

Returns:

this

credentialSpecs

@Stability(Stable)
public ContainerDefinitionOptions.Builder credentialSpecs(List<? extends CredentialSpec> credentialSpecs)

Sets the value of ContainerDefinitionOptions.getCredentialSpecs()

Parameters:

credentialSpecs - A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the dockerSecurityOptions.

Currently, only one credential spec is allowed per container definition.

Returns:

this

disableNetworking

@Stability(Stable)
public ContainerDefinitionOptions.Builder disableNetworking(Boolean disableNetworking)

Sets the value of ContainerDefinitionOptions.getDisableNetworking()

Parameters:

disableNetworking - Specifies whether networking is disabled within the container. When this parameter is true, networking is disabled within the container.

Returns:

this

dnsSearchDomains

@Stability(Stable)
public ContainerDefinitionOptions.Builder dnsSearchDomains(List<String> dnsSearchDomains)

Sets the value of ContainerDefinitionOptions.getDnsSearchDomains()

Parameters:

dnsSearchDomains - A list of DNS search domains that are presented to the container.

Returns:

this

dnsServers

@Stability(Stable)
public ContainerDefinitionOptions.Builder dnsServers(List<String> dnsServers)

Sets the value of ContainerDefinitionOptions.getDnsServers()

Parameters:

dnsServers - A list of DNS servers that are presented to the container.

Returns:

this

dockerLabels

@Stability(Stable)
public ContainerDefinitionOptions.Builder dockerLabels(Map<String,String> dockerLabels)

Sets the value of ContainerDefinitionOptions.getDockerLabels()

Parameters:

dockerLabels - A key/value map of labels to add to the container.

Returns:

this

dockerSecurityOptions

@Stability(Stable)
public ContainerDefinitionOptions.Builder dockerSecurityOptions(List<String> dockerSecurityOptions)

Sets the value of ContainerDefinitionOptions.getDockerSecurityOptions()

Parameters:

dockerSecurityOptions - A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

Returns:

this

entryPoint

@Stability(Stable)
public ContainerDefinitionOptions.Builder entryPoint(List<String> entryPoint)

Sets the value of ContainerDefinitionOptions.getEntryPoint()

Parameters:

entryPoint - The ENTRYPOINT value to pass to the container.

Returns:

this

environment

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

Sets the value of ContainerDefinitionOptions.getEnvironment()

Parameters:

environment - The environment variables to pass to the container.

Returns:

this

environmentFiles

@Stability(Stable)
public ContainerDefinitionOptions.Builder environmentFiles(List<? extends EnvironmentFile> environmentFiles)

Sets the value of ContainerDefinitionOptions.getEnvironmentFiles()

Parameters:

environmentFiles - The environment files to pass to the container.

Returns:

this

essential

@Stability(Stable)
public ContainerDefinitionOptions.Builder essential(Boolean essential)

Sets the value of ContainerDefinitionOptions.getEssential()

Parameters:

essential - Specifies whether the container is marked essential. If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. All tasks must have at least one essential container.

If this parameter is omitted, a container is assumed to be essential.

Returns:

this

extraHosts

@Stability(Stable)
public ContainerDefinitionOptions.Builder extraHosts(Map<String,String> extraHosts)

Sets the value of ContainerDefinitionOptions.getExtraHosts()

Parameters:

extraHosts - A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

Returns:

this

gpuCount

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

Sets the value of ContainerDefinitionOptions.getGpuCount()

Parameters:

gpuCount - The number of GPUs assigned to the container.

Returns:

this

healthCheck

@Stability(Stable)
public ContainerDefinitionOptions.Builder healthCheck(HealthCheck healthCheck)

Sets the value of ContainerDefinitionOptions.getHealthCheck()

Parameters:

healthCheck - The health check command and associated configuration parameters for the container.

Returns:

this

hostname

@Stability(Stable)
public ContainerDefinitionOptions.Builder hostname(String hostname)

Sets the value of ContainerDefinitionOptions.getHostname()

Parameters:

hostname - The hostname to use for your container.

Returns:

this

inferenceAcceleratorResources

@Stability(Stable)
public ContainerDefinitionOptions.Builder inferenceAcceleratorResources(List<String> inferenceAcceleratorResources)

Sets the value of ContainerDefinitionOptions.getInferenceAcceleratorResources()

Parameters:

inferenceAcceleratorResources - The inference accelerators referenced by the container.

Returns:

this

interactive

@Stability(Stable)
public ContainerDefinitionOptions.Builder interactive(Boolean interactive)

Sets the value of ContainerDefinitionOptions.getInteractive()

Parameters:

interactive - When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated.

Returns:

this

linuxParameters

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

Sets the value of ContainerDefinitionOptions.getLinuxParameters()

Parameters:

linuxParameters - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

Returns:

this

logging

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

Sets the value of ContainerDefinitionOptions.getLogging()

Parameters:

logging - The log configuration specification for the container.

Returns:

this

memoryLimitMiB

@Stability(Stable)
public ContainerDefinitionOptions.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of ContainerDefinitionOptions.getMemoryLimitMiB()

Parameters:

memoryLimitMiB - The amount (in MiB) of memory to present to the container. If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

Returns:

this

memoryReservationMiB

@Stability(Stable)
public ContainerDefinitionOptions.Builder memoryReservationMiB(Number memoryReservationMiB)

Sets the value of ContainerDefinitionOptions.getMemoryReservationMiB()

Parameters:

memoryReservationMiB - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

Returns:

this

portMappings

@Stability(Stable)
public ContainerDefinitionOptions.Builder portMappings(List<? extends PortMapping> portMappings)

Sets the value of ContainerDefinitionOptions.getPortMappings()

Parameters:

portMappings - The port mappings to add to the container definition.

Returns:

this

privileged

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

Sets the value of ContainerDefinitionOptions.getPrivileged()

Parameters:

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

Returns:

this

pseudoTerminal

@Stability(Stable)
public ContainerDefinitionOptions.Builder pseudoTerminal(Boolean pseudoTerminal)

Sets the value of ContainerDefinitionOptions.getPseudoTerminal()

Parameters:

pseudoTerminal - When this parameter is true, a TTY is allocated. This parameter maps to Tty in the "Create a container section" of the Docker Remote API and the --tty option to docker run.

Returns:

this

readonlyRootFilesystem

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

Sets the value of ContainerDefinitionOptions.getReadonlyRootFilesystem()

Parameters:

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

Returns:

this

secrets

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

Sets the value of ContainerDefinitionOptions.getSecrets()

Parameters:

secrets - The secret environment variables to pass to the container.

Returns:

this

startTimeout

@Stability(Stable)
public ContainerDefinitionOptions.Builder startTimeout(Duration startTimeout)

Sets the value of ContainerDefinitionOptions.getStartTimeout()

Parameters:

startTimeout - Time duration (in seconds) to wait before giving up on resolving dependencies for a container.

Returns:

this

stopTimeout

@Stability(Stable)
public ContainerDefinitionOptions.Builder stopTimeout(Duration stopTimeout)

Sets the value of ContainerDefinitionOptions.getStopTimeout()

Parameters:

stopTimeout - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

Returns:

this

systemControls

@Stability(Stable)
public ContainerDefinitionOptions.Builder systemControls(List<? extends SystemControl> systemControls)

Sets the value of ContainerDefinitionOptions.getSystemControls()

Parameters:

systemControls - A list of namespaced kernel parameters to set in the container.

Returns:

this

ulimits

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

Sets the value of ContainerDefinitionOptions.getUlimits()

Parameters:

ulimits - An array of ulimits to set in the container.

Returns:

this

user

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

Sets the value of ContainerDefinitionOptions.getUser()

Parameters:

user - The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

Returns:

this

workingDirectory

@Stability(Stable)
public ContainerDefinitionOptions.Builder workingDirectory(String workingDirectory)

Sets the value of ContainerDefinitionOptions.getWorkingDirectory()

Parameters:

workingDirectory - The working directory in which to run commands inside the container.

Returns:

this

build

@Stability(Stable)
public ContainerDefinitionOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ContainerDefinitionOptions

Throws:

NullPointerException - if any required attribute was not provided