ecs_register_task_definition: Registers a new task definition from the supplied family and containerDefinitions

Description

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

Usage

ecs_register_task_definition(family, taskRoleArn, executionRoleArn,
  networkMode, containerDefinitions, volumes, placementConstraints,
  requiresCompatibilities, cpu, memory, tags, pidMode, ipcMode,
  proxyConfiguration)

Arguments

family

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

taskRoleArn

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.

executionRoleArn

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

networkMode

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 you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks 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 value 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.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you cannot 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. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

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

containerDefinitions

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

volumes

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

placementConstraints

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 runtime).

requiresCompatibilities

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

cpu

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. String values are converted to an integer indicating the CPU units when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If you are 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 you are 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)

memory

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. String values are converted to an integer indicating the MiB when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

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)

Request syntax

svc$register_task_definition(
  family = "string",
  taskRoleArn = "string",
  executionRoleArn = "string",
  networkMode = "bridge"|"host"|"awsvpc"|"none",
  containerDefinitions = list(
    list(
      name = "string",
      image = "string",
      repositoryCredentials = list(
        credentialsParameter = "string"
      ),
      cpu = 123,
      memory = 123,
      memoryReservation = 123,
      links = list(
        "string"
      ),
      portMappings = list(
        list(
          containerPort = 123,
          hostPort = 123,
          protocol = "tcp"|"udp"
        )
      ),
      essential = TRUE|FALSE,
      entryPoint = list(
        "string"
      ),
      command = list(
        "string"
      ),
      environment = list(
        list(
          name = "string",
          value = "string"
        )
      ),
      mountPoints = list(
        list(
          sourceVolume = "string",
          containerPath = "string",
          readOnly = TRUE|FALSE
        )
      ),
      volumesFrom = list(
        list(
          sourceContainer = "string",
          readOnly = TRUE|FALSE
        )
      ),
      linuxParameters = list(
        capabilities = list(
          add = list(
            "string"
          ),
          drop = list(
            "string"
          )
        ),
        devices = list(
          list(
            hostPath = "string",
            containerPath = "string",
            permissions = list(
              "read"|"write"|"mknod"
            )
          )
        ),
        initProcessEnabled = TRUE|FALSE,
        sharedMemorySize = 123,
        tmpfs = list(
          list(
            containerPath = "string",
            size = 123,
            mountOptions = list(
              "string"
            )
          )
        )
      ),
      secrets = list(
        list(
          name = "string",
          valueFrom = "string"
        )
      ),
      dependsOn = list(
        list(
          containerName = "string",
          condition = "START"|"COMPLETE"|"SUCCESS"|"HEALTHY"
        )
      ),
      startTimeout = 123,
      stopTimeout = 123,
      hostname = "string",
      user = "string",
      workingDirectory = "string",
      disableNetworking = TRUE|FALSE,
      privileged = TRUE|FALSE,
      readonlyRootFilesystem = TRUE|FALSE,
      dnsServers = list(
        "string"
      ),
      dnsSearchDomains = list(
        "string"
      ),
      extraHosts = list(
        list(
          hostname = "string",
          ipAddress = "string"
        )
      ),
      dockerSecurityOptions = list(
        "string"
      ),
      interactive = TRUE|FALSE,
      pseudoTerminal = TRUE|FALSE,
      dockerLabels = list(
        "string"
      ),
      ulimits = list(
        list(
          name = "core"|"cpu"|"data"|"fsize"|"locks"|"memlock"|"msgqueue"|"nice"|"nofile"|"nproc"|"rss"|"rtprio"|"rttime"|"sigpending"|"stack",
          softLimit = 123,
          hardLimit = 123
        )
      ),
      logConfiguration = list(
        logDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk",
        options = list(
          "string"
        )
      ),
      healthCheck = list(
        command = list(
          "string"
        ),
        interval = 123,
        timeout = 123,
        retries = 123,
        startPeriod = 123
      ),
      systemControls = list(
        list(
          namespace = "string",
          value = "string"
        )
      ),
      resourceRequirements = list(
        list(
          value = "string",
          type = "GPU"
        )
      )
    )
  ),
  volumes = list(
    list(
      name = "string",
      host = list(
        sourcePath = "string"
      ),
      dockerVolumeConfiguration = list(
        scope = "task"|"shared",
        autoprovision = TRUE|FALSE,
        driver = "string",
        driverOpts = list(
          "string"
        ),
        labels = list(
          "string"
        )
      )
    )
  ),
  placementConstraints = list(
    list(
      type = "memberOf",
      expression = "string"
    )
  ),
  requiresCompatibilities = list(
    "EC2"|"FARGATE"
  ),
  cpu = "string",
  memory = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  pidMode = "host"|"task",
  ipcMode = "host"|"task"|"none",
  proxyConfiguration = list(
    type = "APPMESH",
    containerName = "string",
    properties = list(
      list(
        name = "string",
        value = "string"
      )
    )
  )
)

Details

You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, 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.

Examples

Run this code

# NOT RUN {
# This example registers a task definition to the specified family.
# }
# NOT RUN {
svc$register_task_definition(
  containerDefinitions = list(
    list(
      name = "sleep",
      command = list(
        "sleep",
        "360"
      ),
      cpu = 10L,
      essential = TRUE,
      image = "busybox",
      memory = 10L
    )
  ),
  family = "sleep360",
  taskRoleArn = "",
  volumes = list()
)
# }
# NOT RUN {
# }

Run the code above in your browser using DataLab