Class: Aws::ECS::Types::ContainerDefinition

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

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

{
  name: "String",
  image: "String",
  cpu: 1,
  memory: 1,
  memory_reservation: 1,
  links: ["String"],
  port_mappings: [
    {
      container_port: 1,
      host_port: 1,
      protocol: "tcp", # accepts tcp, udp
    },
  ],
  essential: false,
  entry_point: ["String"],
  command: ["String"],
  environment: [
    {
      name: "String",
      value: "String",
    },
  ],
  mount_points: [
    {
      source_volume: "String",
      container_path: "String",
      read_only: false,
    },
  ],
  volumes_from: [
    {
      source_container: "String",
      read_only: false,
    },
  ],
  linux_parameters: {
    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"],
      },
    ],
  },
  hostname: "String",
  user: "String",
  working_directory: "String",
  disable_networking: false,
  privileged: false,
  readonly_root_filesystem: false,
  dns_servers: ["String"],
  dns_search_domains: ["String"],
  extra_hosts: [
    {
      hostname: "String", # required
      ip_address: "String", # required
    },
  ],
  docker_security_options: ["String"],
  docker_labels: {
    "String" => "String",
  },
  ulimits: [
    {
      name: "core", # required, accepts core, cpu, data, fsize, locks, memlock, msgqueue, nice, nofile, nproc, rss, rtprio, rttime, sigpending, stack
      soft_limit: 1, # required
      hard_limit: 1, # required
    },
  ],
  log_configuration: {
    log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
    options: {
      "String" => "String",
    },
  },
  health_check: {
    command: ["String"], # required
    interval: 1,
    timeout: 1,
    retries: 1,
    start_period: 1,
  },
}

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#command ⇒ Array<String>

The command that is passed to the container. This parameter maps to ‘Cmd` in the [Create a container] section of the [Docker Remote API] and the `COMMAND` parameter to [docker run]. For more information, see [docs.docker.com/engine/reference/builder/#cmd][4].

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/ [4]: docs.docker.com/engine/reference/builder/#cmd

Returns:

  • (Array<String>) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#cpu ⇒ Integer

The number of ‘cpu` units reserved for the container. This parameter maps to `CpuShares` in the [Create a container] section of the

Docker Remote API][2

and the ‘–cpu-shares` option to [docker

run].

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ‘cpu` value.

<note markdown=“1”> You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances] detail page by 1,024.

</note>

For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint] in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • **Agent versions less than or equal to 1.1.0:** Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.

  • **Agent versions greater than or equal to 1.2.0:** Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/ [4]: aws.amazon.com/ec2/instance-types/ [5]: docs.docker.com/engine/reference/run/#cpu-share-constraint

Returns:

  • (Integer) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#disable_networking ⇒ Boolean

When this parameter is true, networking is disabled within the container. This parameter maps to ‘NetworkDisabled` in the [Create a container] section of the [Docker Remote API].

<note markdown=“1”> This parameter is not supported for Windows containers.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/

Returns:

  • (Boolean) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#dns_search_domains ⇒ Array<String>

A list of DNS search domains that are presented to the container. This parameter maps to ‘DnsSearch` in the [Create a container] section of the [Docker Remote API] and the `–dns-search` option to [docker run].

<note markdown=“1”> This parameter is not supported for Windows containers.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (Array<String>) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#dns_servers ⇒ Array<String>

A list of DNS servers that are presented to the container. This parameter maps to ‘Dns` in the [Create a container] section of the [Docker Remote API] and the `–dns` option to [docker run].

<note markdown=“1”> This parameter is not supported for Windows containers.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (Array<String>) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#docker_labels ⇒ Hash<String,String>

A key/value map of labels to add to the container. This parameter maps to ‘Labels` in the [Create a container] section of the

Docker Remote API][2

and the ‘–label` option to [docker run].

This parameter requires version 1.18 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”`

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (Hash<String,String>) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#docker_security_options ⇒ Array<String>

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

This parameter maps to ‘SecurityOpt` in the [Create a container] section of the [Docker Remote API] and the `–security-opt` option to [docker run].

<note markdown=“1”> The Amazon ECS container agent running on a container instance must register with the ‘ECS_SELINUX_CAPABLE=true` or `ECS_APPARMOR_CAPABLE=true` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration] in the *Amazon Elastic Container Service Developer Guide*.

This parameter is not supported for Windows containers.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/ [4]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html

Returns:

  • (Array<String>) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#entry_point ⇒ Array<String>

Early versions of the Amazon ECS container agent do not properly handle ‘entryPoint` parameters. If you have problems using `entryPoint`, update your container agent or enter your commands and arguments as `command` array items instead.

The entry point that is passed to the container. This parameter maps to ‘Entrypoint` in the [Create a container] section of the

Docker Remote API][2

and the ‘–entrypoint` option to [docker

run]. For more information, see [docs.docker.com/engine/reference/builder/#entrypoint][4].

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/ [4]: docs.docker.com/engine/reference/builder/#entrypoint

Returns:

  • (Array<String>) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#environment ⇒ Array<Types::KeyValuePair>

The environment variables to pass to a container. This parameter maps to ‘Env` in the [Create a container] section of the [Docker Remote API] and the `–env` option to [docker run].

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#essential ⇒ Boolean

If the ‘essential` parameter of a container is marked as `true`, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the `essential` parameter of a container is marked as `false`, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html

Returns:

  • (Boolean) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#extra_hosts ⇒ Array<Types::HostEntry>

A list of hostnames and IP address mappings to append to the ‘/etc/hosts` file on the container. If using the Fargate launch type, this may be used to list non-Fargate hosts you want the container to talk to. This parameter maps to `ExtraHosts` in the

Create a container][1

section of the [Docker Remote API] and

the ‘–add-host` option to [docker run].

<note markdown=“1”> This parameter is not supported for Windows containers.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#health_check ⇒ Types::HealthCheck

The health check command and associated configuration parameters for the container. This parameter maps to ‘HealthCheck` in the [Create a container] section of the [Docker Remote API] and the `HEALTHCHECK` parameter of [docker run].

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#hostname ⇒ String

The hostname to use for your container. This parameter maps to ‘Hostname` in the [Create a container] section of the [Docker Remote API] and the `–hostname` option to [docker run].

<note markdown=“1”> The ‘hostname` parameter is not supported if using the `awsvpc` networkMode.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#image ⇒ String

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either ‘ repository-url/image:tag ` or ` repository-url/image@digest `. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to `Image` in the [Create a container] section of the [Docker Remote API] and the `IMAGE` parameter of [docker run].

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full ‘registry/repository:tag` or `registry/repository@digest`. For example, `012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest` or `012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`.

  • Images in official repositories on Docker Hub use a single name (for example, ‘ubuntu` or `mongo`).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, ‘amazon/amazon-ecs-agent`).

  • Images in other online repositories are qualified further by a domain name (for example, ‘quay.io/assemblyline/ubuntu`).

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#links ⇒ Array<String>

The ‘link` parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to `bridge`. The `name:internalName` construct is analogous to `name:alias` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to [docs.docker.com/engine/userguide/networking/default_network/dockerlinks/][1]. This parameter maps to `Links` in the [Create a container] section of the [Docker Remote API] and the `–link` option to [ `docker run` ][4].

<note markdown=“1”> This parameter is not supported for Windows containers.

</note>

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

[1]: docs.docker.com/engine/userguide/networking/default_network/dockerlinks/ [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [3]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [4]: docs.docker.com/engine/reference/commandline/run/

Returns:

  • (Array<String>) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#linux_parameters ⇒ Types::LinuxParameters

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

<note markdown=“1”> This parameter is not supported for Windows containers.

</note>

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#log_configuration ⇒ Types::LogConfiguration

The log configuration specification for the container.

If using the Fargate launch type, the only supported value is ‘awslogs`.

This parameter maps to ‘LogConfig` in the [Create a container] section of the [Docker Remote API] and the `–log-driver` option to [docker run]. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers] in the Docker documentation.

<note markdown=“1”> Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

</note>

This parameter requires version 1.18 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”`

<note markdown=“1”> The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ‘ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration] in the *Amazon Elastic Container Service Developer Guide*.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/ [4]: docs.docker.com/engine/admin/logging/overview/ [5]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#memory ⇒ Integer

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to ‘Memory` in the [Create a container] section of the [Docker Remote API] and the `–memory` option to [docker run].

If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task ‘memory` value.

For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of ‘memory` or `memoryReservation` in container definitions. If you specify both, `memory` must be greater than `memoryReservation`. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of `memory` is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (Integer) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#memory_reservation ⇒ Integer

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the ‘memory` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to `MemoryReservation` in the [Create a container] section of the [Docker Remote API] and the `–memory-reservation` option to [docker run].

You must specify a non-zero integer for one or both of ‘memory` or `memoryReservation` in container definitions. If you specify both, `memory` must be greater than `memoryReservation`. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of `memory` is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ‘memoryReservation` of 128 MiB, and a `memory` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (Integer) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#mount_points ⇒ Array<Types::MountPoint>

The mount points for data volumes in your container.

This parameter maps to ‘Volumes` in the [Create a container] section of the [Docker Remote API] and the `–volume` option to [docker run].

Windows containers can mount whole directories on the same drive as ‘$env:ProgramData`. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#name ⇒ String

The name of a container. If you are linking multiple containers together in a task definition, the ‘name` of one container can be entered in the `links` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to `name` in the [Create a container] section of the [Docker Remote API] and the `–name` option to [docker run].

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#port_mappings ⇒ Array<Types::PortMapping>

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the ‘awsvpc` network mode, you should only specify the `containerPort`. The `hostPort` can be left blank or it must be the same value as the `containerPort`.

Port mappings on Windows use the ‘NetNAT` gateway address rather than `localhost`. There is no loopback for port mappings on Windows, so you cannot access a container’s mapped port from the host itself.

This parameter maps to ‘PortBindings` in the [Create a container] section of the [Docker Remote API] and the `–publish` option to [docker run]. If the network mode of a task definition is set to `none`, then you can’t specify port mappings. If the network mode of a task definition is set to ‘host`, then host ports must either be undefined or they must match the container port in the port mapping.

<note markdown=“1”> After a task reaches the ‘RUNNING` status, manual and automatic host and container port assignments are visible in the **Network Bindings** section of a container description for a selected task in the Amazon ECS console, or the `networkBindings` section DescribeTasks responses.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#privileged ⇒ Boolean

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ‘root` user). This parameter maps to `Privileged` in the [Create a container] section of the [Docker Remote API] and the `–privileged` option to [docker run].

<note markdown=“1”> This parameter is not supported for Windows containers or tasks using the Fargate launch type.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (Boolean) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#readonly_root_filesystem ⇒ Boolean

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ‘ReadonlyRootfs` in the [Create a container] section of the [Docker Remote API] and the `–read-only` option to `docker run`.

<note markdown=“1”> This parameter is not supported for Windows containers.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/

Returns:

  • (Boolean) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#ulimits ⇒ Array<Types::Ulimit>

A list of ‘ulimits` to set in the container. This parameter maps to `Ulimits` in the [Create a container] section of the [Docker Remote API] and the `–ulimit` option to [docker run]. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 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”`

<note markdown=“1”> This parameter is not supported for Windows containers.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#user ⇒ String

The user name to use inside the container. This parameter maps to ‘User` in the [Create a container] section of the [Docker Remote API] and the `–user` option to [docker run].

<note markdown=“1”> This parameter is not supported for Windows containers.

</note>

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#volumes_from ⇒ Array<Types::VolumeFrom>

Data volumes to mount from another container. This parameter maps to ‘VolumesFrom` in the [Create a container] section of the [Docker Remote API] and the `–volumes-from` option to [docker run].

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end

#working_directory ⇒ String

The working directory in which to run commands inside the container. This parameter maps to ‘WorkingDir` in the [Create a container] section of the [Docker Remote API] and the `–workdir` option to [docker run].

[1]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container [2]: docs.docker.com/engine/reference/api/docker_remote_api_v1.27/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-ecs/types.rb', line 1047

class ContainerDefinition < Struct.new(
  :name,
  :image,
  :cpu,
  :memory,
  :memory_reservation,
  :links,
  :port_mappings,
  :essential,
  :entry_point,
  :command,
  :environment,
  :mount_points,
  :volumes_from,
  :linux_parameters,
  :hostname,
  :user,
  :working_directory,
  :disable_networking,
  :privileged,
  :readonly_root_filesystem,
  :dns_servers,
  :dns_search_domains,
  :extra_hosts,
  :docker_security_options,
  :docker_labels,
  :ulimits,
  :log_configuration,
  :health_check)
  include Aws::Structure
end