Package software.amazon.awscdk.services.ecs

Interface LinuxParametersProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LinuxParametersProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:16.508Z")
@Stability(Stable)
public interface LinuxParametersProps
extends software.amazon.jsii.JsiiSerializable

The properties for defining Linux-specific options that are applied to the container.

Example:

 TaskDefinition taskDefinition;
 taskDefinition.addContainer("container", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .memoryLimitMiB(1024)
         .linuxParameters(LinuxParameters.Builder.create(this, "LinuxParameters")
                 .initProcessEnabled(true)
                 .sharedMemorySize(1024)
                 .maxSwap(Size.mebibytes(5000))
                 .swappiness(90)
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LinuxParametersProps.Builder	A builder for LinuxParametersProps
static final class	LinuxParametersProps.Jsii$Proxy	An implementation for LinuxParametersProps

Method Summary

Modifier and Type	Method	Description
static LinuxParametersProps.Builder	builder()
default Boolean	getInitProcessEnabled()	Specifies whether to run an init process inside the container that forwards signals and reaps processes.
default Size	getMaxSwap()	The total amount of swap memory a container can use.
default Number	getSharedMemorySize()	The value for the size of the /dev/shm volume.
default Number	getSwappiness()	This allows you to tune a container's memory swappiness behavior.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInitProcessEnabled

@Stability(Stable)
@Nullable
default Boolean getInitProcessEnabled()

Specifies whether to run an init process inside the container that forwards signals and reaps processes.

Default: false

getMaxSwap

@Stability(Stable)
@Nullable
default Size getMaxSwap()

The total amount of swap memory a container can use.

This parameter will be translated to the --memory-swap option to docker run.

This parameter is only supported when you are using the EC2 launch type. Accepted values are positive integers.

Default: No swap.

getSharedMemorySize

@Stability(Stable)
@Nullable
default Number getSharedMemorySize()

The value for the size of the /dev/shm volume.

Default: No shared memory.

getSwappiness

@Stability(Stable)
@Nullable
default Number getSwappiness()

This allows you to tune a container's memory swappiness behavior.

This parameter maps to the --memory-swappiness option to docker run. The swappiness relates to the kernel's tendency to swap memory. A value of 0 will cause swapping to not happen unless absolutely necessary. A value of 100 will cause pages to be swapped very aggressively.

This parameter is only supported when you are using the EC2 launch type. Accepted values are whole numbers between 0 and 100. If a value is not specified for maxSwap then this parameter is ignored.

Default: 60

builder

@Stability(Stable)
static LinuxParametersProps.Builder builder()

Returns:

a LinuxParametersProps.Builder of LinuxParametersProps