Package software.amazon.awscdk.cfnpropertymixins.services.batch

Class CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.batch.CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobDefinitionPropsMixin.ContainerPropertiesProperty>

Enclosing interface:

CfnJobDefinitionPropsMixin.ContainerPropertiesProperty

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

A builder for CfnJobDefinitionPropsMixin.ContainerPropertiesProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty	build()	Builds the configured instance.
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	command(List<String> command)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getCommand()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEnableExecuteCommand()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	enableExecuteCommand(IResolvable enableExecuteCommand)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEnableExecuteCommand()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	environment(List<? extends Object> environment)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEnvironment()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	environment(IResolvable environment)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEnvironment()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	ephemeralStorage(CfnJobDefinitionPropsMixin.EphemeralStorageProperty ephemeralStorage)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEphemeralStorage()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	ephemeralStorage(IResolvable ephemeralStorage)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEphemeralStorage()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	executionRoleArn(String executionRoleArn)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getExecutionRoleArn()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	fargatePlatformConfiguration(CfnJobDefinitionPropsMixin.FargatePlatformConfigurationProperty fargatePlatformConfiguration)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getFargatePlatformConfiguration()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	fargatePlatformConfiguration(IResolvable fargatePlatformConfiguration)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getFargatePlatformConfiguration()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	image(String image)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getImage()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	instanceType(String instanceType)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getInstanceType()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	jobRoleArn(String jobRoleArn)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getJobRoleArn()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	linuxParameters(CfnJobDefinitionPropsMixin.LinuxParametersProperty linuxParameters)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getLinuxParameters()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	linuxParameters(IResolvable linuxParameters)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getLinuxParameters()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	logConfiguration(CfnJobDefinitionPropsMixin.LogConfigurationProperty logConfiguration)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getLogConfiguration()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	logConfiguration(IResolvable logConfiguration)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getLogConfiguration()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	memory(Number memory)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getMemory()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	mountPoints(List<? extends Object> mountPoints)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getMountPoints()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	mountPoints(IResolvable mountPoints)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getMountPoints()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	networkConfiguration(CfnJobDefinitionPropsMixin.NetworkConfigurationProperty networkConfiguration)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getNetworkConfiguration()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	networkConfiguration(IResolvable networkConfiguration)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getNetworkConfiguration()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	privileged(Boolean privileged)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getPrivileged()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	privileged(IResolvable privileged)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getPrivileged()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	readonlyRootFilesystem(Boolean readonlyRootFilesystem)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getReadonlyRootFilesystem()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	readonlyRootFilesystem(IResolvable readonlyRootFilesystem)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getReadonlyRootFilesystem()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	repositoryCredentials(CfnJobDefinitionPropsMixin.RepositoryCredentialsProperty repositoryCredentials)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getRepositoryCredentials()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	repositoryCredentials(IResolvable repositoryCredentials)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getRepositoryCredentials()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	resourceRequirements(List<? extends Object> resourceRequirements)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getResourceRequirements()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	resourceRequirements(IResolvable resourceRequirements)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getResourceRequirements()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	runtimePlatform(CfnJobDefinitionPropsMixin.RuntimePlatformProperty runtimePlatform)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getRuntimePlatform()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	runtimePlatform(IResolvable runtimePlatform)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getRuntimePlatform()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	secrets(List<? extends Object> secrets)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getSecrets()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	secrets(IResolvable secrets)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getSecrets()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	ulimits(List<? extends Object> ulimits)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getUlimits()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	ulimits(IResolvable ulimits)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getUlimits()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	user(String user)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getUser()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	vcpus(Number vcpus)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getVcpus()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	volumes(List<? extends Object> volumes)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getVolumes()
CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder	volumes(IResolvable volumes)	Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.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

command

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

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.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 https://docs.docker.com/engine/reference/builder/#cmd .

Returns:

this

enableExecuteCommand

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Determines whether execute command functionality is turned on for this task. If true , execute command functionality is turned on all the containers in the task.

Returns:

this

enableExecuteCommand

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder enableExecuteCommand(IResolvable enableExecuteCommand)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Determines whether execute command functionality is turned on for this task. If true , execute command functionality is turned on all the containers in the task.

Returns:

this

environment

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder environment(IResolvable environment)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEnvironment()

Parameters:

environment - The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option 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 CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder environment(List<? extends Object> environment)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEnvironment()

Parameters:

environment - The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option 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

ephemeralStorage

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder ephemeralStorage(IResolvable ephemeralStorage)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEphemeralStorage()

Parameters:

ephemeralStorage - The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .

Returns:

this

ephemeralStorage

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder ephemeralStorage(CfnJobDefinitionPropsMixin.EphemeralStorageProperty ephemeralStorage)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getEphemeralStorage()

Parameters:

ephemeralStorage - The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .

Returns:

this

executionRoleArn

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder executionRoleArn(String executionRoleArn)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getExecutionRoleArn()

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide .

Returns:

this

fargatePlatformConfiguration

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder fargatePlatformConfiguration(IResolvable fargatePlatformConfiguration)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getFargatePlatformConfiguration()

Parameters:

fargatePlatformConfiguration - The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Returns:

this

fargatePlatformConfiguration

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder fargatePlatformConfiguration(CfnJobDefinitionPropsMixin.FargatePlatformConfigurationProperty fargatePlatformConfiguration)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getFargatePlatformConfiguration()

Parameters:

fargatePlatformConfiguration - The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Returns:

this

image

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder image(String image)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getImage()

Parameters:

image - Required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with *repository-url* / *image* : *tag* . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run .

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

• Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/ *registry_alias* / *my-web-app* : *latest* .
• Images in Amazon ECR repositories use the full registry and repository URI (for example, 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name> ).
• Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo ).
• Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent ).
• Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu ).

Returns:

this

instanceType

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder instanceType(String instanceType)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getInstanceType()

Parameters:

instanceType - the value to be set.

Returns:

this

jobRoleArn

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder jobRoleArn(String jobRoleArn)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getJobRoleArn()

Parameters:

jobRoleArn - The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide .

Returns:

this

linuxParameters

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder linuxParameters(IResolvable linuxParameters)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getLinuxParameters()

Parameters:

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

Returns:

this

linuxParameters

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder linuxParameters(CfnJobDefinitionPropsMixin.LinuxParametersProperty linuxParameters)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getLinuxParameters()

Parameters:

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

Returns:

this

logConfiguration

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder logConfiguration(IResolvable logConfiguration)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.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 might 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 on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

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 | grep "Server API version"

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 CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder logConfiguration(CfnJobDefinitionPropsMixin.LogConfigurationProperty logConfiguration)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.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 might 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 on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

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 | grep "Server API version"

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

memory

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder memory(Number memory)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getMemory()

Parameters:

memory - This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

Returns:

this

mountPoints

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder mountPoints(IResolvable mountPoints)

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

Returns:

this

mountPoints

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder mountPoints(List<? extends Object> mountPoints)

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

Returns:

this

networkConfiguration

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder networkConfiguration(IResolvable networkConfiguration)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getNetworkConfiguration()

Parameters:

networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Returns:

this

networkConfiguration

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder networkConfiguration(CfnJobDefinitionPropsMixin.NetworkConfigurationProperty networkConfiguration)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getNetworkConfiguration()

Parameters:

networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Returns:

this

privileged

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder privileged(Boolean privileged)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getPrivileged()

Parameters:

privileged - When this parameter is true, the container is given elevated permissions 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 . The default value is false.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

Returns:

this

privileged

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder privileged(IResolvable privileged)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getPrivileged()

Parameters:

privileged - When this parameter is true, the container is given elevated permissions 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 . The default value is false.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

Returns:

this

readonlyRootFilesystem

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder readonlyRootFilesystem(Boolean readonlyRootFilesystem)

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

Returns:

this

readonlyRootFilesystem

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder readonlyRootFilesystem(IResolvable readonlyRootFilesystem)

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

Returns:

this

repositoryCredentials

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder repositoryCredentials(IResolvable repositoryCredentials)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getRepositoryCredentials()

Parameters:

repositoryCredentials - The private repository authentication credentials to use.

Returns:

this

repositoryCredentials

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder repositoryCredentials(CfnJobDefinitionPropsMixin.RepositoryCredentialsProperty repositoryCredentials)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getRepositoryCredentials()

Parameters:

repositoryCredentials - The private repository authentication credentials to use.

Returns:

this

resourceRequirements

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder resourceRequirements(IResolvable resourceRequirements)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getResourceRequirements()

Parameters:

resourceRequirements - The type and amount of resources to assign to a container. The supported resources include GPU , MEMORY , and VCPU .

Returns:

this

resourceRequirements

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder resourceRequirements(List<? extends Object> resourceRequirements)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getResourceRequirements()

Parameters:

resourceRequirements - The type and amount of resources to assign to a container. The supported resources include GPU , MEMORY , and VCPU .

Returns:

this

runtimePlatform

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder runtimePlatform(IResolvable runtimePlatform)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getRuntimePlatform()

Parameters:

runtimePlatform - An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Returns:

this

runtimePlatform

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder runtimePlatform(CfnJobDefinitionPropsMixin.RuntimePlatformProperty runtimePlatform)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getRuntimePlatform()

Parameters:

runtimePlatform - An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Returns:

this

secrets

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder secrets(IResolvable secrets)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getSecrets()

Parameters:

secrets - The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide .

Returns:

this

secrets

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder secrets(List<? extends Object> secrets)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getSecrets()

Parameters:

secrets - The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide .

Returns:

this

ulimits

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder ulimits(IResolvable ulimits)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getUlimits()

Parameters:

ulimits - A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Returns:

this

ulimits

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder ulimits(List<? extends Object> ulimits)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getUlimits()

Parameters:

ulimits - A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Returns:

this

user

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder user(String user)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getUser()

Parameters:

user - The user name 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

vcpus

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder vcpus(Number vcpus)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getVcpus()

Parameters:

vcpus - This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.

Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run . The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

Returns:

this

volumes

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder volumes(IResolvable volumes)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getVolumes()

Parameters:

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

Returns:

this

volumes

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.Builder volumes(List<? extends Object> volumes)

Sets the value of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty.getVolumes()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnJobDefinitionPropsMixin.ContainerPropertiesProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnJobDefinitionPropsMixin.ContainerPropertiesProperty>

Returns:

a new instance of CfnJobDefinitionPropsMixin.ContainerPropertiesProperty

Throws:

NullPointerException - if any required attribute was not provided