AWS Fundamentals Logo
AWS Fundamentals
AWS::ECS::TaskDefinition

ECS TaskDefinition

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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*. You can specify a role for your task with the taskRoleArn parameter. W...

Properties

18 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
ContainerDefinitions
Array<ContainerDefinition>
Create-only
Cpu
string
Create-only
EnableFaultInjection
boolean
Create-only
EphemeralStorage
EphemeralStorage
Create-only
ExecutionRoleArn
string
Create-only
Family
string
Create-only
InferenceAccelerators
Array<InferenceAccelerator>
Create-onlyDeprecated
IpcMode
string
Create-only
Memory
string
Create-only
NetworkMode
string
Create-only
PidMode
string
Create-only
PlacementConstraints
Array<TaskDefinitionPlacementConstraint>
Create-only
ProxyConfiguration
ProxyConfiguration
Create-only
RequiresCompatibilities
Array<string>
Create-only
RuntimePlatform
RuntimePlatform
Create-only
Tags
Array<Tag>
TaskRoleArn
string
Create-only
Volumes
Array<Volume>
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
TaskDefinitionArnstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ECS::TaskDefinition

Resources:
  MyResource:
    Type: AWS::ECS::TaskDefinition
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

ecs:DescribeTaskDefinition

create

ecs:RegisterTaskDefinitionecs:DescribeTaskDefinitionecs:TagResourceiam:GetRoleiam:PassRole

update

ecs:TagResourceecs:UntagResourceecs:ListTagsForResourceecs:DescribeTaskDefinitioniam:GetRoleiam:PassRole

list

ecs:ListTaskDefinitionsecs:DescribeTaskDefinition

delete

ecs:DeregisterTaskDefinitionecs:DescribeTaskDefinitioniam:GetRoleiam:PassRole

Get the ECS Cheat Sheet

Everything you need to know about ECS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceECS
Properties19
Required0
TaggingSupported
Primary IDTaskDefinitionArn

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

FamilyContainerDefinitionsCpuEnableFaultInjectionExecutionRoleArnInferenceAcceleratorsMemoryNetworkModePlacementConstraintsProxyConfigurationRequiresCompatibilitiesRuntimePlatformTaskRoleArnVolumesPidModeIpcModeEphemeralStorage

Related Resources

External Links