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
settingsawsvpc
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
,
"dependsOn": [
{
"condition": "string
",
"containerName": "string
"
}
],
"disableNetworking": boolean
,
"dnsSearchDomains": [ "string
" ],
"dnsServers": [ "string
" ],
"dockerLabels": {
"string
" : "string
"
},
"dockerSecurityOptions": [ "string
" ],
"entryPoint": [ "string
" ],
"environment": [
{
"name": "string
",
"value": "string
"
}
],
"environmentFiles": [
{
"type": "string
",
"value": "string
"
}
],
"essential": boolean
,
"extraHosts": [
{
"hostname": "string
",
"ipAddress": "string
"
}
],
"firelensConfiguration": {
"options": {
"string
" : "string
"
},
"type": "string
"
},
"healthCheck": {
"command": [ "string
" ],
"interval": number
,
"retries": number
,
"startPeriod": number
,
"timeout": number
},
"hostname": "string
",
"image": "string
",
"interactive": boolean
,
"links": [ "string
" ],
"linuxParameters": {
"capabilities": {
"add": [ "string
" ],
"drop": [ "string
" ]
},
"devices": [
{
"containerPath": "string
",
"hostPath": "string
",
"permissions": [ "string
" ]
}
],
"initProcessEnabled": boolean
,
"maxSwap": number
,
"sharedMemorySize": number
,
"swappiness": number
,
"tmpfs": [
{
"containerPath": "string
",
"mountOptions": [ "string
" ],
"size": number
}
]
},
"logConfiguration": {
"logDriver": "string
",
"options": {
"string
" : "string
"
},
"secretOptions": [
{
"name": "string
",
"valueFrom": "string
"
}
]
},
"memory": number
,
"memoryReservation": number
,
"mountPoints": [
{
"containerPath": "string
",
"readOnly": boolean
,
"sourceVolume": "string
"
}
],
"name": "string
",
"portMappings": [
{
"containerPort": number
,
"hostPort": number
,
"protocol": "string
"
}
],
"privileged": boolean
,
"pseudoTerminal": boolean
,
"readonlyRootFilesystem": boolean
,
"repositoryCredentials": {
"credentialsParameter": "string
"
},
"resourceRequirements": [
{
"type": "string
",
"value": "string
"
}
],
"secrets": [
{
"name": "string
",
"valueFrom": "string
"
}
],
"startTimeout": number
,
"stopTimeout": number
,
"systemControls": [
{
"namespace": "string
",
"value": "string
"
}
],
"ulimits": [
{
"hardLimit": number
,
"name": "string
",
"softLimit": number
}
],
"user": "string
",
"volumesFrom": [
{
"readOnly": boolean
,
"sourceContainer": "string
"
}
],
"workingDirectory": "string
"
}
],
"cpu": "string
",
"executionRoleArn": "string
",
"family": "string
",
"inferenceAccelerators": [
{
"deviceName": "string
",
"deviceType": "string
"
}
],
"ipcMode": "string
",
"memory": "string
",
"networkMode": "string
",
"pidMode": "string
",
"placementConstraints": [
{
"expression": "string
",
"type": "string
"
}
],
"proxyConfiguration": {
"containerName": "string
",
"properties": [
{
"name": "string
",
"value": "string
"
}
],
"type": "string
"
},
"requiresCompatibilities": [ "string
" ],
"tags": [
{
"key": "string
",
"value": "string
"
}
],
"taskRoleArn": "string
",
"volumes": [
{
"dockerVolumeConfiguration": {
"autoprovision": boolean
,
"driver": "string
",
"driverOpts": {
"string
" : "string
"
},
"labels": {
"string
" : "string
"
},
"scope": "string
"
},
"efsVolumeConfiguration": {
"authorizationConfig": {
"accessPointId": "string
",
"iam": "string
"
},
"fileSystemId": "string
",
"rootDirectory": "string
",
"transitEncryption": "string
",
"transitEncryptionPort": number
},
"fsxWindowsFileServerVolumeConfiguration": {
"authorizationConfig": {
"credentialsParameter": "string
",
"domain": "string
"
},
"fileSystemId": "string
",
"rootDirectory": "string
"
},
"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. It can be expressed as an integer using CPU units, for example
1024
, or as a string using vCPUs, for example1 vCPU
or1 vcpu
, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.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 EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
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)
Type: String
Required: No
-
- executionRoleArn
-
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
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. Thefamily
is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.Type: String
Required: Yes
- inferenceAccelerators
-
The Elastic Inference accelerators to use for the containers in the task.
Type: Array of InferenceAccelerator objects
Required: No
- ipcMode
-
The IPC resource namespace to use for the containers in the task. The valid values are
host
,task
, ornone
. Ifhost
is specified, then all containers within the tasks that specified thehost
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. Iftask
is specified, all containers within the specified task share the same IPC resources. Ifnone
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settingsin the Docker run reference. If the
host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security. If you are setting namespaced kernel parameters using
systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.-
For tasks that use the
host
IPC mode, IPC namespace relatedsystemControls
are not supported. -
For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.
Note This parameter is not supported for Windows containers or tasks run on AWS Fargate.
Type: String
Valid Values:
host | task | none
Required: No
-
- 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 example1GB
or1 GB
, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.Note 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)
Type: String
Required: No
-
- networkMode
-
The Docker networking mode to use for the containers in the task. The valid values are
none
,bridge
,awsvpc
, andhost
. If no network mode is specified, the default isbridge
.For Amazon ECS tasks on Fargate, the
awsvpc
network mode is required. For Amazon ECS tasks on Amazon EC2 instances, any network mode can be used. If the network mode is set tonone
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. Thehost
andawsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridge
mode.With the
host
andawsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for thehost
network mode) or the attached elastic network interface port (for theawsvpc
network mode), so you cannot take advantage of dynamic host port mappings.Important When using the
host
network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.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.Note Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the
ecs-init
package, or AWS Fargate infrastructure support theawsvpc
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. Type: String
Valid Values:
bridge | host | awsvpc | none
Required: No
- pidMode
-
The process namespace to use for the containers in the task. The valid values are
host
ortask
. Ifhost
is specified, then all containers within the tasks that specified thehost
PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. Iftask
is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settingsin the Docker run reference. If the
host
PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security. Note This parameter is not supported for Windows containers or tasks run on AWS Fargate.
Type: String
Valid Values:
host | task
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 runtime).
Type: Array of TaskDefinitionPlacementConstraint objects
Required: No
- proxyConfiguration
-
The configuration details for the App Mesh proxy.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
ecs-init
package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMIType: ProxyConfiguration object
Required: No
- requiresCompatibilities
-
The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
Type: Array of strings
Valid Values:
EC2 | FARGATE
Required: No
- tags
-
The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
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
{
"tags": [
{
"key": "string",
"value": "string"
}
],
"taskDefinition": {
"compatibilities": [ "string" ],
"containerDefinitions": [
{
"command": [ "string" ],
"cpu": number,
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}
],
"disableNetworking": boolean,
"dnsSearchDomains": [ "string" ],
"dnsServers": [ "string" ],
"dockerLabels": {
"string" : "string"
},
"dockerSecurityOptions": [ "string" ],
"entryPoint": [ "string" ],
"environment": [
{
"name": "string",
"value": "string"
}
],
"environmentFiles": [
{
"type": "string",
"value": "string"
}
],
"essential": boolean,
"extraHosts": [
{
"hostname": "string",
"ipAddress": "string"
}
],
"firelensConfiguration": {
"options": {
"string" : "string"
},
"type": "string"
},
"healthCheck": {
"command": [ "string" ],
"interval": number,
"retries": number,
"startPeriod": number,
"timeout": number
},
"hostname": "string",
"image": "string",
"interactive": boolean,
"links": [ "string" ],
"linuxParameters": {
"capabilities": {
"add": [ "string" ],
"drop": [ "string" ]
},
"devices": [
{
"containerPath": "string",
"hostPath": "string",
"permissions": [ "string" ]
}
],
"initProcessEnabled": boolean,
"maxSwap": number,
"sharedMemorySize": number,
"swappiness": number,
"tmpfs": [
{
"containerPath": "string",
"mountOptions": [ "string" ],
"size": number
}
]
},
"logConfiguration": {
"logDriver": "string",
"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"memory": number,
"memoryReservation": number,
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"name": "string",
"portMappings": [
{
"containerPort": number,
"hostPort": number,
"protocol": "string"
}
],
"privileged": boolean,
"pseudoTerminal": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"startTimeout": number,
"stopTimeout": number,
"systemControls": [
{
"namespace": "string",
"value": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string",
"volumesFrom": [
{
"readOnly": boolean,
"sourceContainer": "string"
}
],
"workingDirectory": "string"
}
],
"cpu": "string",
"deregisteredAt": number,
"executionRoleArn": "string",
"family": "string",
"inferenceAccelerators": [
{
"deviceName": "string",
"deviceType": "string"
}
],
"ipcMode": "string",
"memory": "string",
"networkMode": "string",
"pidMode": "string",
"placementConstraints": [
{
"expression": "string",
"type": "string"
}
],
"proxyConfiguration": {
"containerName": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"type": "string"
},
"registeredAt": number,
"registeredBy": "string",
"requiresAttributes": [
{
"name": "string",
"targetId": "string",
"targetType": "string",
"value": "string"
}
],
"requiresCompatibilities": [ "string" ],
"revision": number,
"status": "string",
"taskDefinitionArn": "string",
"taskRoleArn": "string",
"volumes": [
{
"dockerVolumeConfiguration": {
"autoprovision": boolean,
"driver": "string",
"driverOpts": {
"string" : "string"
},
"labels": {
"string" : "string"
},
"scope": "string"
},
"efsVolumeConfiguration": {
"authorizationConfig": {
"accessPointId": "string",
"iam": "string"
},
"fileSystemId": "string",
"rootDirectory": "string",
"transitEncryption": "string",
"transitEncryptionPort": number
},
"fsxWindowsFileServerVolumeConfiguration": {
"authorizationConfig": {
"credentialsParameter": "string",
"domain": "string"
},
"fileSystemId": "string",
"rootDirectory": "string"
},
"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.
- tags
-
The list of tags associated with the task definition.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- 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
Examples
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)
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: