Class: Aws::ECS::Types::LinuxParameters

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::LinuxParameters

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass LinuxParameters data as a hash:

{
  capabilities: {
    add: ["String"],
    drop: ["String"],
  },
  devices: [
    {
      host_path: "String", # required
      container_path: "String",
      permissions: ["read"], # accepts read, write, mknod
    },
  ],
  init_process_enabled: false,
  shared_memory_size: 1,
  tmpfs: [
    {
      container_path: "String", # required
      size: 1, # required
      mount_options: ["String"],
    },
  ],
}

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #capabilities ⇒ Types::KernelCapabilities

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

• #devices ⇒ Array<Types::Device>

  Any host devices to expose to the container.

• #init_process_enabled ⇒ Boolean

  Run an ‘init` process inside the container that forwards signals and reaps processes.

• #shared_memory_size ⇒ Integer

  The value for the size (in MiB) of the ‘/dev/shm` volume.

• #tmpfs ⇒ Array<Types::Tmpfs>

  The container path, mount options, and size (in MiB) of the tmpfs mount.

Instance Attribute Details

#capabilities ⇒ Types::KernelCapabilities

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

<note markdown=“1”> If you are using tasks that use the Fargate launch type, ‘capabilities` is supported but the `add` parameter is not supported.

</note>

Returns:

• (Types::KernelCapabilities)

# File 'lib/aws-sdk-ecs/types.rb', line 3198

class LinuxParameters < Struct.new(
  :capabilities,
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs)
  include Aws::Structure
end

#devices ⇒ Array<Types::Device>

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

<note markdown=“1”> If you are using tasks that use the Fargate launch type, the ‘devices` parameter is not supported.

</note>

[1]: docs.docker.com/engine/api/v1.35/#operation/ContainerCreate [2]: docs.docker.com/engine/api/v1.35/ [3]: docs.docker.com/engine/reference/run/

Returns:

• (Array<Types::Device>)

# File 'lib/aws-sdk-ecs/types.rb', line 3198

class LinuxParameters < Struct.new(
  :capabilities,
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs)
  include Aws::Structure
end

#init_process_enabled ⇒ Boolean

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 ’Aws::ECS::Types::LinuxParameters.{{.Server{.Server.APIVersion}‘`

[1]: docs.docker.com/engine/reference/run/

Returns:

• (Boolean)

# File 'lib/aws-sdk-ecs/types.rb', line 3198

class LinuxParameters < Struct.new(
  :capabilities,
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs)
  include Aws::Structure
end

#shared_memory_size ⇒ Integer

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

<note markdown=“1”> If you are using tasks that use the Fargate launch type, the ‘sharedMemorySize` parameter is not supported.

</note>

[1]: docs.docker.com/engine/reference/run/

Returns:

• (Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 3198

class LinuxParameters < Struct.new(
  :capabilities,
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs)
  include Aws::Structure
end

#tmpfs ⇒ Array<Types::Tmpfs>

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ‘–tmpfs` option to [docker run].

<note markdown=“1”> If you are using tasks that use the Fargate launch type, the ‘tmpfs` parameter is not supported.

</note>

[1]: docs.docker.com/engine/reference/run/

Returns:

• (Array<Types::Tmpfs>)

# File 'lib/aws-sdk-ecs/types.rb', line 3198

class LinuxParameters < Struct.new(
  :capabilities,
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs)
  include Aws::Structure
end