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

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

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

{
  family: "String", # required
  task_role_arn: "String",
  network_mode: "bridge", # accepts bridge, host, 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"],
        },
      },
      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",
        },
      },
    },
  ],
  volumes: [
    {
      name: "String",
      host: {
        source_path: "String",
      },
    },
  ],
  placement_constraints: [
    {
      type: "memberOf", # accepts memberOf
      expression: "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:



3158
3159
3160
3161
3162
3163
3164
3165
3166
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3158

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints)
  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)


3158
3159
3160
3161
3162
3163
3164
3165
3166
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3158

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

#network_modeString

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

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

Returns:

  • (String)


3158
3159
3160
3161
3162
3163
3164
3165
3166
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3158

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints)
  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).



3158
3159
3160
3161
3162
3163
3164
3165
3166
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3158

class RegisterTaskDefinitionRequest < Struct.new(
  :family,
  :task_role_arn,
  :network_mode,
  :container_definitions,
  :volumes,
  :placement_constraints)
  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 EC2 Container Service Developer Guide.

Returns:

  • (String)


3158
3159
3160
3161
3162
3163
3164
3165
3166
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3158

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

#volumesArray<Types::Volume>

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

Returns:



3158
3159
3160
3161
3162
3163
3164
3165
3166
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3158

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