Package software.amazon.awscdk.services.batch

Class CfnJobDefinition.LinuxParametersProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnJobDefinition.LinuxParametersProperty

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

A builder for CfnJobDefinition.LinuxParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnJobDefinition.LinuxParametersProperty	build()	Builds the configured instance.
CfnJobDefinition.LinuxParametersProperty.Builder	devices(List<? extends Object> devices)	Sets the value of CfnJobDefinition.LinuxParametersProperty.getDevices()
CfnJobDefinition.LinuxParametersProperty.Builder	devices(IResolvable devices)	Sets the value of CfnJobDefinition.LinuxParametersProperty.getDevices()
CfnJobDefinition.LinuxParametersProperty.Builder	initProcessEnabled(Boolean initProcessEnabled)	Sets the value of CfnJobDefinition.LinuxParametersProperty.getInitProcessEnabled()
CfnJobDefinition.LinuxParametersProperty.Builder	initProcessEnabled(IResolvable initProcessEnabled)	Sets the value of CfnJobDefinition.LinuxParametersProperty.getInitProcessEnabled()
CfnJobDefinition.LinuxParametersProperty.Builder	maxSwap(Number maxSwap)	Sets the value of CfnJobDefinition.LinuxParametersProperty.getMaxSwap()
CfnJobDefinition.LinuxParametersProperty.Builder	sharedMemorySize(Number sharedMemorySize)	Sets the value of CfnJobDefinition.LinuxParametersProperty.getSharedMemorySize()
CfnJobDefinition.LinuxParametersProperty.Builder	swappiness(Number swappiness)	Sets the value of CfnJobDefinition.LinuxParametersProperty.getSwappiness()
CfnJobDefinition.LinuxParametersProperty.Builder	tmpfs(List<? extends Object> tmpfs)	Sets the value of CfnJobDefinition.LinuxParametersProperty.getTmpfs()
CfnJobDefinition.LinuxParametersProperty.Builder	tmpfs(IResolvable tmpfs)	Sets the value of CfnJobDefinition.LinuxParametersProperty.getTmpfs()

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

devices

@Stability(Stable)
public CfnJobDefinition.LinuxParametersProperty.Builder devices(IResolvable devices)

Sets the value of CfnJobDefinition.LinuxParametersProperty.getDevices()

Parameters:

devices - Any of the host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Returns:

this

devices

@Stability(Stable)
public CfnJobDefinition.LinuxParametersProperty.Builder devices(List<? extends Object> devices)

Sets the value of CfnJobDefinition.LinuxParametersProperty.getDevices()

Parameters:

devices - Any of the host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Returns:

this

initProcessEnabled

@Stability(Stable)
public CfnJobDefinition.LinuxParametersProperty.Builder initProcessEnabled(Boolean initProcessEnabled)

Sets the value of CfnJobDefinition.LinuxParametersProperty.getInitProcessEnabled()

Parameters:

initProcessEnabled - If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run . This parameter requires version 1.25 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"

Returns:

this

initProcessEnabled

@Stability(Stable)
public CfnJobDefinition.LinuxParametersProperty.Builder initProcessEnabled(IResolvable initProcessEnabled)

Sets the value of CfnJobDefinition.LinuxParametersProperty.getInitProcessEnabled()

Parameters:

initProcessEnabled - If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run . This parameter requires version 1.25 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"

Returns:

this

maxSwap

@Stability(Stable)
public CfnJobDefinition.LinuxParametersProperty.Builder maxSwap(Number maxSwap)

Sets the value of CfnJobDefinition.LinuxParametersProperty.getMaxSwap()

Parameters:

maxSwap - The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Returns:

this

sharedMemorySize

@Stability(Stable)
public CfnJobDefinition.LinuxParametersProperty.Builder sharedMemorySize(Number sharedMemorySize)

Sets the value of CfnJobDefinition.LinuxParametersProperty.getSharedMemorySize()

Parameters:

sharedMemorySize - The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Returns:

this

swappiness

@Stability(Stable)
public CfnJobDefinition.LinuxParametersProperty.Builder swappiness(Number swappiness)

Sets the value of CfnJobDefinition.LinuxParametersProperty.getSwappiness()

Parameters:

swappiness - You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100 . If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap , then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run .

Consider the following when you use a per-container swap configuration.

• Swap space must be enabled and allocated on the container instance for the containers to use.

By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

• The swap space parameters are only supported for job definitions using EC2 resources.
• If the maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Returns:

this

tmpfs

@Stability(Stable)
public CfnJobDefinition.LinuxParametersProperty.Builder tmpfs(IResolvable tmpfs)

Sets the value of CfnJobDefinition.LinuxParametersProperty.getTmpfs()

Parameters:

tmpfs - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

Returns:

this

tmpfs

@Stability(Stable)
public CfnJobDefinition.LinuxParametersProperty.Builder tmpfs(List<? extends Object> tmpfs)

Sets the value of CfnJobDefinition.LinuxParametersProperty.getTmpfs()

Parameters:

tmpfs - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnJobDefinition.LinuxParametersProperty

Throws:

NullPointerException - if any required attribute was not provided