Package software.amazon.awscdk.services.batch

Class CfnJobDefinition.LinuxParametersProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.CfnJobDefinition.LinuxParametersProperty.Jsii$Proxy

All Implemented Interfaces:

CfnJobDefinition.LinuxParametersProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnJobDefinition.LinuxParametersProperty

@Stability(Stable)
@Internal
public static final class CfnJobDefinition.LinuxParametersProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnJobDefinition.LinuxParametersProperty

An implementation for CfnJobDefinition.LinuxParametersProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.CfnJobDefinition.LinuxParametersProperty

CfnJobDefinition.LinuxParametersProperty.Builder, CfnJobDefinition.LinuxParametersProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnJobDefinition.LinuxParametersProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnJobDefinition.LinuxParametersProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getDevices()	Any of the host devices to expose to the container.
final Object	getInitProcessEnabled()	If true, run an init process inside the container that forwards signals and reaps processes.
final Number	getMaxSwap()	The total amount of swap memory (in MiB) a container can use.
final Number	getSharedMemorySize()	The value for the size (in MiB) of the /dev/shm volume.
final Number	getSwappiness()	You can use this parameter to tune a container's memory swappiness behavior.
final Object	getTmpfs()	The container path, mount options, and size (in MiB) of the tmpfs mount.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnJobDefinition.LinuxParametersProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnJobDefinition.LinuxParametersProperty.Builder.

Method Details

getDevices

public final Object getDevices()

Description copied from interface: CfnJobDefinition.LinuxParametersProperty

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobDefinition.DeviceProperty>

Specified by:

getDevices in interface CfnJobDefinition.LinuxParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-devices

getInitProcessEnabled

public final Object getInitProcessEnabled()

Description copied from interface: CfnJobDefinition.LinuxParametersProperty

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 union: either Boolean or IResolvable

Specified by:

getInitProcessEnabled in interface CfnJobDefinition.LinuxParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-initprocessenabled

getMaxSwap

public final Number getMaxSwap()

Description copied from interface: CfnJobDefinition.LinuxParametersProperty

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 on which it runs. 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.

Specified by:

getMaxSwap in interface CfnJobDefinition.LinuxParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-maxswap

getSharedMemorySize

public final Number getSharedMemorySize()

Description copied from interface: CfnJobDefinition.LinuxParametersProperty

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.

Specified by:

getSharedMemorySize in interface CfnJobDefinition.LinuxParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-sharedmemorysize

getSwappiness

public final Number getSwappiness()

Description copied from interface: CfnJobDefinition.LinuxParametersProperty

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.

Specified by:

getSwappiness in interface CfnJobDefinition.LinuxParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-swappiness

getTmpfs

public final Object getTmpfs()

Description copied from interface: CfnJobDefinition.LinuxParametersProperty

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobDefinition.TmpfsProperty>

Specified by:

getTmpfs in interface CfnJobDefinition.LinuxParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-tmpfs

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object