You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/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.

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesTypes::KernelCapabilities

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.



2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2620

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

#devicesArray<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.

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

Returns:



2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2620

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

#init_process_enabledBoolean

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:

  • (Boolean)


2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2620

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

#shared_memory_sizeInteger

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:

  • (Integer)


2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2620

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

#tmpfsArray<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.

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

Returns:



2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2620

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