Package software.amazon.awscdk.services.batch

Class CfnJobDefinition.TaskContainerPropertiesProperty.Builder

java.lang.Object

software.amazon.awscdk.services.batch.CfnJobDefinition.TaskContainerPropertiesProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobDefinition.TaskContainerPropertiesProperty>

Enclosing interface:

CfnJobDefinition.TaskContainerPropertiesProperty

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

A builder for CfnJobDefinition.TaskContainerPropertiesProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnJobDefinition.TaskContainerPropertiesProperty	build()	Builds the configured instance.
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	command(List<String> command)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getCommand()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	dependsOn(List<? extends Object> dependsOn)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getDependsOn()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	dependsOn(IResolvable dependsOn)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getDependsOn()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	environment(List<? extends Object> environment)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getEnvironment()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	environment(IResolvable environment)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getEnvironment()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	essential(Boolean essential)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getEssential()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	essential(IResolvable essential)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getEssential()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	image(String image)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getImage()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	linuxParameters(IResolvable linuxParameters)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getLinuxParameters()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	linuxParameters(CfnJobDefinition.LinuxParametersProperty linuxParameters)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getLinuxParameters()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	logConfiguration(IResolvable logConfiguration)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getLogConfiguration()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	logConfiguration(CfnJobDefinition.LogConfigurationProperty logConfiguration)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getLogConfiguration()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	mountPoints(List<? extends Object> mountPoints)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getMountPoints()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	mountPoints(IResolvable mountPoints)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getMountPoints()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	name(String name)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getName()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	privileged(Boolean privileged)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getPrivileged()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	privileged(IResolvable privileged)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getPrivileged()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	readonlyRootFilesystem(Boolean readonlyRootFilesystem)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getReadonlyRootFilesystem()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	readonlyRootFilesystem(IResolvable readonlyRootFilesystem)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getReadonlyRootFilesystem()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	repositoryCredentials(IResolvable repositoryCredentials)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getRepositoryCredentials()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	repositoryCredentials(CfnJobDefinition.RepositoryCredentialsProperty repositoryCredentials)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getRepositoryCredentials()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	resourceRequirements(List<? extends Object> resourceRequirements)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getResourceRequirements()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	resourceRequirements(IResolvable resourceRequirements)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getResourceRequirements()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	secrets(List<? extends Object> secrets)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getSecrets()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	secrets(IResolvable secrets)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getSecrets()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	ulimits(List<? extends Object> ulimits)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getUlimits()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	ulimits(IResolvable ulimits)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getUlimits()
CfnJobDefinition.TaskContainerPropertiesProperty.Builder	user(String user)	Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getUser()

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 CfnJobDefinition.TaskContainerPropertiesProperty.Builder image(String image)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getImage()

Parameters:

image - The image used to start a container. This parameter is required. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of the docker run .

Returns:

this

command

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

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getCommand()

Parameters:

command - The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run . For more information, see Dockerfile reference: CMD .

Returns:

this

dependsOn

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder dependsOn(IResolvable dependsOn)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getDependsOn()

Parameters:

dependsOn - A list of containers that this container depends on.

Returns:

this

dependsOn

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder dependsOn(List<? extends Object> dependsOn)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getDependsOn()

Parameters:

dependsOn - A list of containers that this container depends on.

Returns:

this

environment

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder environment(IResolvable environment)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getEnvironment()

Parameters:

environment - The environment variables to pass to a container. This parameter maps to Env inthe Create a container section of the Docker Remote API and the --env parameter to docker run .

We don't recommend using plaintext environment variables for sensitive information, such as credential data. > Environment variables cannot start with AWS_BATCH . This naming convention is reserved for variables that AWS Batch sets.

Returns:

this

environment

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder environment(List<? extends Object> environment)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getEnvironment()

Parameters:

environment - The environment variables to pass to a container. This parameter maps to Env inthe Create a container section of the Docker Remote API and the --env parameter to docker run .

We don't recommend using plaintext environment variables for sensitive information, such as credential data. > Environment variables cannot start with AWS_BATCH . This naming convention is reserved for variables that AWS Batch sets.

Returns:

this

essential

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder essential(Boolean essential)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getEssential()

Parameters:

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, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide .

Returns:

this

essential

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder essential(IResolvable essential)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getEssential()

Parameters:

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, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide .

Returns:

this

linuxParameters

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder linuxParameters(IResolvable linuxParameters)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getLinuxParameters()

Parameters:

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

Returns:

this

linuxParameters

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder linuxParameters(CfnJobDefinition.LinuxParametersProperty linuxParameters)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getLinuxParameters()

Parameters:

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

Returns:

this

logConfiguration

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder logConfiguration(IResolvable logConfiguration)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getLogConfiguration()

Parameters:

logConfiguration - The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation .

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide .

Returns:

this

logConfiguration

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder logConfiguration(CfnJobDefinition.LogConfigurationProperty logConfiguration)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getLogConfiguration()

Parameters:

logConfiguration - The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation .

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide .

Returns:

this

mountPoints

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder mountPoints(IResolvable mountPoints)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getMountPoints()

Parameters:

mountPoints - The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .

Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers can't mount directories on a different drive, and mount point can't be across drives.

Returns:

this

mountPoints

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder mountPoints(List<? extends Object> mountPoints)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getMountPoints()

Parameters:

mountPoints - The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .

Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers can't mount directories on a different drive, and mount point can't be across drives.

Returns:

this

name

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder name(String name)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getName()

Parameters:

name - The name of a container. The name can be used as a unique identifier to target your dependsOn and Overrides objects.

Returns:

this

privileged

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder privileged(Boolean privileged)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getPrivileged()

Parameters:

privileged - When this parameter is true , the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run .

This parameter is not supported for Windows containers or tasks run on Fargate.

Returns:

this

privileged

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder privileged(IResolvable privileged)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getPrivileged()

Parameters:

privileged - When this parameter is true , the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run .

This parameter is not supported for Windows containers or tasks run on Fargate.

Returns:

this

readonlyRootFilesystem

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder readonlyRootFilesystem(Boolean readonlyRootFilesystem)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getReadonlyRootFilesystem()

Parameters:

readonlyRootFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .

This parameter is not supported for Windows containers.

Returns:

this

readonlyRootFilesystem

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder readonlyRootFilesystem(IResolvable readonlyRootFilesystem)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getReadonlyRootFilesystem()

Parameters:

readonlyRootFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .

This parameter is not supported for Windows containers.

Returns:

this

repositoryCredentials

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder repositoryCredentials(IResolvable repositoryCredentials)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getRepositoryCredentials()

Parameters:

repositoryCredentials - The private repository authentication credentials to use.

Returns:

this

repositoryCredentials

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder repositoryCredentials(CfnJobDefinition.RepositoryCredentialsProperty repositoryCredentials)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getRepositoryCredentials()

Parameters:

repositoryCredentials - The private repository authentication credentials to use.

Returns:

this

resourceRequirements

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder resourceRequirements(IResolvable resourceRequirements)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getResourceRequirements()

Parameters:

resourceRequirements - The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Returns:

this

resourceRequirements

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder resourceRequirements(List<? extends Object> resourceRequirements)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getResourceRequirements()

Parameters:

resourceRequirements - The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Returns:

this

secrets

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder secrets(IResolvable secrets)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getSecrets()

Parameters:

secrets - The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Returns:

this

secrets

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder secrets(List<? extends Object> secrets)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getSecrets()

Parameters:

secrets - The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Returns:

this

ulimits

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder ulimits(IResolvable ulimits)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getUlimits()

Parameters:

ulimits - A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run .

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535 .

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Returns:

this

ulimits

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder ulimits(List<? extends Object> ulimits)

Sets the value of CfnJobDefinition.TaskContainerPropertiesProperty.getUlimits()

Parameters:

ulimits - A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run .

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535 .

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Returns:

this

user

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty.Builder user(String user)

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

When running tasks using the host network mode, don't run containers using the root user (UID 0) . We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

• user
• user:group
• uid
• uid:gid
• user:gi
• uid:group

This parameter is not supported for Windows containers.

Returns:

this

build

@Stability(Stable)
public CfnJobDefinition.TaskContainerPropertiesProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnJobDefinition.TaskContainerPropertiesProperty>

Returns:

a new instance of CfnJobDefinition.TaskContainerPropertiesProperty

Throws:

NullPointerException - if any required attribute was not provided