Menu
Amazon EC2 Container Service
API Reference (API Version 2014-11-13)

RegisterTaskDefinition

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.

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.

Request Syntax

{
   "containerDefinitions": [ 
      { 
         "command": [ "string" ],
         "cpu": number,
         "disableNetworking": boolean,
         "dnsSearchDomains": [ "string" ],
         "dnsServers": [ "string" ],
         "dockerLabels": { 
            "string" : "string" 
         },
         "dockerSecurityOptions": [ "string" ],
         "entryPoint": [ "string" ],
         "environment": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "essential": boolean,
         "extraHosts": [ 
            { 
               "hostname": "string",
               "ipAddress": "string"
            }
         ],
         "hostname": "string",
         "image": "string",
         "links": [ "string" ],
         "linuxParameters": { 
            "capabilities": { 
               "add": [ "string" ],
               "drop": [ "string" ]
            },
            "devices": [ 
               { 
                  "containerPath": "string",
                  "hostPath": "string",
                  "permissions": [ "string" ]
               }
            ],
            "initProcessEnabled": boolean
         },
         "logConfiguration": { 
            "logDriver": "string",
            "options": { 
               "string" : "string" 
            }
         },
         "memory": number,
         "memoryReservation": number,
         "mountPoints": [ 
            { 
               "containerPath": "string",
               "readOnly": boolean,
               "sourceVolume": "string"
            }
         ],
         "name": "string",
         "portMappings": [ 
            { 
               "containerPort": number,
               "hostPort": number,
               "protocol": "string"
            }
         ],
         "privileged": boolean,
         "readonlyRootFilesystem": boolean,
         "ulimits": [ 
            { 
               "hardLimit": number,
               "name": "string",
               "softLimit": number
            }
         ],
         "user": "string",
         "volumesFrom": [ 
            { 
               "readOnly": boolean,
               "sourceContainer": "string"
            }
         ],
         "workingDirectory": "string"
      }
   ],
   "cpu": "string",
   "executionRoleArn": "string",
   "family": "string",
   "memory": "string",
   "networkMode": "string",
   "placementConstraints": [ 
      { 
         "expression": "string",
         "type": "string"
      }
   ],
   "requiresCompatibilities": [ "string" ],
   "taskRoleArn": "string",
   "volumes": [ 
      { 
         "host": { 
            "sourcePath": "string"
         },
         "name": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

containerDefinitions

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

Type: Array of ContainerDefinition objects

Required: Yes

cpu

The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used.

Note

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 Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

  • 256 (.25 vCPU) - Available memory values: 512MB, 1GB, 2GB

  • 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

  • 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

  • 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

  • 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

Type: String

Required: No

executionRoleArn

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

Type: String

Required: No

family

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.

Type: String

Required: Yes

memory

The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used.

Note

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 Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

  • 512MB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)

  • 1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)

  • 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)

  • Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)

  • Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)

Type: String

Required: No

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

Type: String

Valid Values: bridge | host | awsvpc | none

Required: No

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 run time).

Type: Array of TaskDefinitionPlacementConstraint objects

Required: No

requiresCompatibilities

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

Type: Array of strings

Valid Values: EC2 | FARGATE

Required: No

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.

Type: String

Required: No

volumes

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

Type: Array of Volume objects

Required: No

Response Syntax

{
   "taskDefinition": { 
      "compatibilities": [ "string" ],
      "containerDefinitions": [ 
         { 
            "command": [ "string" ],
            "cpu": number,
            "disableNetworking": boolean,
            "dnsSearchDomains": [ "string" ],
            "dnsServers": [ "string" ],
            "dockerLabels": { 
               "string" : "string" 
            },
            "dockerSecurityOptions": [ "string" ],
            "entryPoint": [ "string" ],
            "environment": [ 
               { 
                  "name": "string",
                  "value": "string"
               }
            ],
            "essential": boolean,
            "extraHosts": [ 
               { 
                  "hostname": "string",
                  "ipAddress": "string"
               }
            ],
            "hostname": "string",
            "image": "string",
            "links": [ "string" ],
            "linuxParameters": { 
               "capabilities": { 
                  "add": [ "string" ],
                  "drop": [ "string" ]
               },
               "devices": [ 
                  { 
                     "containerPath": "string",
                     "hostPath": "string",
                     "permissions": [ "string" ]
                  }
               ],
               "initProcessEnabled": boolean
            },
            "logConfiguration": { 
               "logDriver": "string",
               "options": { 
                  "string" : "string" 
               }
            },
            "memory": number,
            "memoryReservation": number,
            "mountPoints": [ 
               { 
                  "containerPath": "string",
                  "readOnly": boolean,
                  "sourceVolume": "string"
               }
            ],
            "name": "string",
            "portMappings": [ 
               { 
                  "containerPort": number,
                  "hostPort": number,
                  "protocol": "string"
               }
            ],
            "privileged": boolean,
            "readonlyRootFilesystem": boolean,
            "ulimits": [ 
               { 
                  "hardLimit": number,
                  "name": "string",
                  "softLimit": number
               }
            ],
            "user": "string",
            "volumesFrom": [ 
               { 
                  "readOnly": boolean,
                  "sourceContainer": "string"
               }
            ],
            "workingDirectory": "string"
         }
      ],
      "cpu": "string",
      "executionRoleArn": "string",
      "family": "string",
      "memory": "string",
      "networkMode": "string",
      "placementConstraints": [ 
         { 
            "expression": "string",
            "type": "string"
         }
      ],
      "requiresAttributes": [ 
         { 
            "name": "string",
            "targetId": "string",
            "targetType": "string",
            "value": "string"
         }
      ],
      "requiresCompatibilities": [ "string" ],
      "revision": number,
      "status": "string",
      "taskDefinitionArn": "string",
      "taskRoleArn": "string",
      "volumes": [ 
         { 
            "host": { 
               "sourcePath": "string"
            },
            "name": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

taskDefinition

The full description of the registered task definition.

Type: TaskDefinition object

Errors

For information about the errors that are common to all actions, see Common Errors.

ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

HTTP Status Code: 400

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Example

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.

Example

This example request registers a task definition in the hello_world family with the host networking mode.

Sample Request

POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 486
X-Amz-Target: AmazonEC2ContainerServiceV20141113.RegisterTaskDefinition
X-Amz-Date: 20150429T193109Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS

{
  "networkMode": "host",
  "containerDefinitions": [
    {
      "name": "wordpress",
      "links": [
        "mysql"
      ],
      "image": "wordpress",
      "essential": true,
      "portMappings": [
        {
          "containerPort": 80,
          "hostPort": 80
        }
      ],
      "memory": 500,
      "cpu": 10
    },
    {
      "name": "mysql",
      "image": "mysql",
      "cpu": 10,
      "environment": [
        {
          "name": "MYSQL_ROOT_PASSWORD",
          "value": "password"
        }
      ],
      "memory": 500,
      "essential": true
    }
  ],
  "family": "hello_world"
}

Sample Response

HTTP/1.1 200 OK
Server: Server
Date: Fri, 12 Aug 2016 22:17:20 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 714
Connection: keep-alive
x-amzn-RequestId: 896d7e0f-60da-11e6-8e21-55c97a4b6423

{
  "taskDefinition": {
    "containerDefinitions": [
      {
        "cpu": 10,
        "environment": [],
        "essential": true,
        "image": "wordpress",
        "links": [
          "mysql"
        ],
        "memory": 500,
        "mountPoints": [],
        "name": "wordpress",
        "portMappings": [
          {
            "containerPort": 80,
            "hostPort": 80,
            "protocol": "tcp"
          }
        ],
        "volumesFrom": []
      },
      {
        "cpu": 10,
        "environment": [
          {
            "name": "MYSQL_ROOT_PASSWORD",
            "value": "password"
          }
        ],
        "essential": true,
        "image": "mysql",
        "memory": 500,
        "mountPoints": [],
        "name": "mysql",
        "portMappings": [],
        "volumesFrom": []
      }
    ],
    "family": "hello_world",
    "networkMode": "host",
    "requiresAttributes": [
      {
        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
      }
    ],
    "revision": 4,
    "status": "ACTIVE",
    "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:4",
    "volumes": []
  }
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: