Class CfnJobDefinitionPropsMixin.LinuxParametersProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnJobDefinitionPropsMixin.LinuxParametersProperty>
- Enclosing interface:
CfnJobDefinitionPropsMixin.LinuxParametersProperty
CfnJobDefinitionPropsMixin.LinuxParametersProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getDevices()devices(IResolvable devices) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getDevices()initProcessEnabled(Boolean initProcessEnabled) initProcessEnabled(IResolvable initProcessEnabled) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getMaxSwap()sharedMemorySize(Number sharedMemorySize) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getSharedMemorySize()swappiness(Number swappiness) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getSwappiness()Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getTmpfs()tmpfs(IResolvable tmpfs) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getTmpfs()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
devices
@Stability(Stable) public CfnJobDefinitionPropsMixin.LinuxParametersProperty.Builder devices(IResolvable devices) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getDevices()- Parameters:
devices- Any of the host devices to expose to the container. This parameter maps toDevicesin the Create a container section of the Docker Remote API and the--deviceoption 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 CfnJobDefinitionPropsMixin.LinuxParametersProperty.Builder devices(List<? extends Object> devices) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getDevices()- Parameters:
devices- Any of the host devices to expose to the container. This parameter maps toDevicesin the Create a container section of the Docker Remote API and the--deviceoption 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 CfnJobDefinitionPropsMixin.LinuxParametersProperty.Builder initProcessEnabled(Boolean initProcessEnabled) - Parameters:
initProcessEnabled- If true, run aninitprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption 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 CfnJobDefinitionPropsMixin.LinuxParametersProperty.Builder initProcessEnabled(IResolvable initProcessEnabled) - Parameters:
initProcessEnabled- If true, run aninitprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption 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 CfnJobDefinitionPropsMixin.LinuxParametersProperty.Builder maxSwap(Number maxSwap) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getMaxSwap()- Parameters:
maxSwap- The total amount of swap memory (in MiB) a container can use. This parameter is translated to the--memory-swapoption to docker run where the value is the sum of the container memory plus themaxSwapvalue. For more information, see--memory-swapdetails in the Docker documentation.If a
maxSwapvalue of0is specified, the container doesn't use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container doesn't use the swap configuration for the container instance on which it runs. AmaxSwapvalue must be set for theswappinessparameter 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
-
swappiness
@Stability(Stable) public CfnJobDefinitionPropsMixin.LinuxParametersProperty.Builder swappiness(Number swappiness) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getSwappiness()- Parameters:
swappiness- You can use this parameter to tune a container's memory swappiness behavior. Aswappinessvalue of0causes swapping to not occur unless absolutely necessary. Aswappinessvalue of100causes pages to be swapped aggressively. Valid values are whole numbers between0and100. If theswappinessparameter isn't specified, a default value of60is used. If a value isn't specified formaxSwap, then this parameter is ignored. IfmaxSwapis set to 0, the container doesn't use swap. This parameter maps to the--memory-swappinessoption 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
maxSwapandswappinessparameters are omitted from a job definition, each container has a defaultswappinessvalue 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 CfnJobDefinitionPropsMixin.LinuxParametersProperty.Builder tmpfs(IResolvable tmpfs) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getTmpfs()- Parameters:
tmpfs- The container path, mount options, and size (in MiB) of thetmpfsmount. This parameter maps to the--tmpfsoption 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 CfnJobDefinitionPropsMixin.LinuxParametersProperty.Builder tmpfs(List<? extends Object> tmpfs) Sets the value ofCfnJobDefinitionPropsMixin.LinuxParametersProperty.getTmpfs()- Parameters:
tmpfs- The container path, mount options, and size (in MiB) of thetmpfsmount. This parameter maps to the--tmpfsoption 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
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnJobDefinitionPropsMixin.LinuxParametersProperty>- Returns:
- a new instance of
CfnJobDefinitionPropsMixin.LinuxParametersProperty - Throws:
NullPointerException- if any required attribute was not provided
-