Class: Aws::ECS::Types::RegisterTaskDefinitionRequest

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 RegisterTaskDefinitionRequest data as a hash:

{
  family: "String", # required
  task_role_arn: "String",
  execution_role_arn: "String",
  network_mode: "bridge", # accepts bridge, host, awsvpc, none
  container_definitions: [ # required
    {
      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,
      },
    },
  ],
  volumes: [
    {
      name: "String",
      host: {
        source_path: "String",
      },
    },
  ],
  placement_constraints: [
    {
      type: "memberOf", # accepts memberOf
      expression: "String",
    },
  ],
  requires_compatibilities: ["EC2"], # accepts EC2, FARGATE
  cpu: "String",
  memory: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#container_definitionsArray<Types::ContainerDefinition>

A list of container definitions in JSON format that describe the different containers that make up your task.

Returns:



4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end

#cpuString

The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example ‘1024`, or as a string using vCPUs, for example `1 vCPU` or `1 vcpu`, in a task definition but will be converted to an integer indicating the CPU units when the task definition is registered.

<note markdown=“1”> Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

</note>

If using the EC2 launch type, this field is optional. Supported values are between ‘128` CPU units (`0.125` vCPUs) and `10240` CPU units (`10` vCPUs).

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the ‘memory` parameter:

  • 256 (.25 vCPU) - Available ‘memory` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available ‘memory` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available ‘memory` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available ‘memory` values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available ‘memory` values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

Returns:

  • (String)


4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end

#execution_role_arnString

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

Returns:

  • (String)


4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end

#familyString

You must specify a ‘family` for a task definition, which allows you to track multiple versions of the same task definition. The `family` is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

  • (String)


4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end

#memoryString

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example ‘1024`, or as a string using GB, for example `1GB` or `1 GB`, in a task definition but will be converted to an integer indicating the MiB when the task definition is registered.

<note markdown=“1”> Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

</note>

If using the EC2 launch type, this field is optional.

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the ‘cpu` parameter:

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ‘cpu` values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ‘cpu` values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ‘cpu` values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

    • Available ‘cpu` values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

    • Available ‘cpu` values: 4096 (4 vCPU)

Returns:

  • (String)


4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end

#network_modeString

The Docker networking mode to use for the containers in the task. The valid values are ‘none`, `bridge`, `awsvpc`, and `host`. The default Docker network mode is `bridge`. If using the Fargate launch type, the `awsvpc` network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to `none`, you can’t specify port mappings in your container definitions, and the task’s containers do not have external connectivity. The ‘host` and `awsvpc` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the `bridge` mode.

With the ‘host` and `awsvpc` network modes, exposed container ports are mapped directly to the corresponding host port (for the `host` network mode) or the attached elastic network interface port (for the `awsvpc` network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is ‘awsvpc`, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking] in the *Amazon Elastic Container Service Developer Guide*.

If the network mode is ‘host`, you can’t run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode.

For more information, see [Network settings] in the *Docker run reference*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html [2]: docs.docker.com/engine/reference/run/#network-settings

Returns:

  • (String)


4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end

#placement_constraintsArray<Types::TaskDefinitionPlacementConstraint>

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).



4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end

#requires_compatibilitiesArray<String>

The launch type required by the task. If no value is specified, it defaults to ‘EC2`.

Returns:

  • (Array<String>)


4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end

#task_role_arnString

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see [IAM Roles for Tasks] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html

Returns:

  • (String)


4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end

#volumesArray<Types::Volume>

A list of volume definitions in JSON format that containers in your task may use.

Returns:



4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/aws-sdk-ecs/types.rb', line 4112

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints,
  :requires_compatibilities,
  :cpu,
  :memory)
  include Aws::Structure
end