software.amazon.awssdk.services.ecs.model

Class LinuxParameters

java.lang.Object

software.amazon.awssdk.services.ecs.model.LinuxParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LinuxParameters.Builder,LinuxParameters>

@Generated(value="software.amazon.awssdk:codegen")
public final class LinuxParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LinuxParameters.Builder,LinuxParameters>

Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LinuxParameters.Builder

Method Summary

Modifier and Type	Method and Description
static LinuxParameters.Builder	builder()
KernelCapabilities	capabilities() The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
List<Device>	devices() Any host devices to expose to the container.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	initProcessEnabled() Run an init process inside the container that forwards signals and reaps processes.
List<SdkField<?>>	sdkFields()
static Class<? extends LinuxParameters.Builder>	serializableBuilderClass()
Integer	sharedMemorySize() The value for the size (in MiB) of the /dev/shm volume.
List<Tmpfs>	tmpfs() The container path, mount options, and size (in MiB) of the tmpfs mount.
LinuxParameters.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

capabilities

public KernelCapabilities capabilities()

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported.

Returns:

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported.

devices

public List<Device> devices()

Any 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.

If you are using tasks that use the Fargate launch type, the devices parameter is not supported.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Any 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.

If you are using tasks that use the Fargate launch type, the devices parameter is not supported.

initProcessEnabled

public Boolean initProcessEnabled()

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 --format '{{.Server.APIVersion}}'

Returns:

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 --format '{{.Server.APIVersion}}'

sharedMemorySize

public Integer sharedMemorySize()

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

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

Returns:

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

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

tmpfs

public List<Tmpfs> tmpfs()

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

If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

toBuilder

public LinuxParameters.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<LinuxParameters.Builder,LinuxParameters>

Returns:

a builder for type T

builder

public static LinuxParameters.Builder builder()

serializableBuilderClass

public static Class<? extends LinuxParameters.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.