AWS::ECS::TaskDefinition
AWS::ECS::TaskDefinition リソースは、Amazon Elastic Container Service (Amazon ECS) タスクのコンテナとボリュームの定義について説明します。Amazon
ECS サービスまたはタスクを通じて、使用する Docker イメージ、必要なリソース、タスク定義の開始に関連する他の設定を指定できます。
構文
AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。
JSON
{ "Type" : "AWS::ECS::TaskDefinition", "Properties" : { "ContainerDefinitions" :[ ContainerDefinition, ... ], "Cpu" :String, "ExecutionRoleArn" :String, "Family" :String, "Memory" :String, "NetworkMode" :String, "PlacementConstraints" :[ TaskDefinitionPlacementConstraint, ... ], "ProxyConfiguration" :ProxyConfiguration, "RequiresCompatibilities" :[ String, ... ], "Tags" :[ Tag, ... ], "TaskRoleArn" :String, "Volumes" :[ Volume, ... ]} }
YAML
Type: AWS::ECS::TaskDefinition Properties: ContainerDefinitions:- ContainerDefinitionCpu:StringExecutionRoleArn:StringFamily:StringMemory:StringNetworkMode:StringPlacementConstraints:- TaskDefinitionPlacementConstraintProxyConfiguration:ProxyConfigurationRequiresCompatibilities:- StringTags:- TagTaskRoleArn:StringVolumes:- Volume
プロパティ
ContainerDefinitions-
タスクを構成するさまざまなコンテナを記述する JSON 形式のコンテナの定義のリスト。コンテナの定義パラメータとデフォルト値の詳細については、『Amazon Elastic Container Service 開発者ガイド』の「Amazon ECS のタスク定義」を参照してください。
必須: いいえ
タイプ: ContainerDefinition のリスト
Update requires: Replacement
Cpu-
タスクで使用されている
cpuユニットの数。EC2 起動タイプを使用する場合、このフィールドはオプションであり、任意の値を使用できます。Fargate 起動タイプを使用している場合、このフィールドは必須であり、次のいずれかの値を使用する必要があります。この値によりmemoryパラメータの有効な値の範囲が決まります。-
256 (.25 vCPU) - 使用可能な
memory値: 512 (0.5 GB)、1024 (1 GB)、2048 (2 GB) -
512 (.5 vCPU) - 使用可能な
memory値: 1024 (1 GB)、2048 (2 GB)、3072 (3 GB)、4096 (4 GB) -
1024 (1 vCPU) - 使用可能な
memory値: 2048 (2 GB)、3072 (3 GB)、4096 (4 GB)、5120 (5 GB)、6144 (6 GB)、7168 (7 GB)、8192 (8 GB) -
2048 (2 vCPU) - 使用可能な
memory値: 4096 (4 GB) ～ 16384 (16 GB) (1024 (1 GB) のインクリメント) -
4096 (4 vCPU) - 使用可能な
memory値: 8192 (8 GB) ～ 30720 (30 GB) (1024 (1 GB) のインクリメント)
必須: いいえ
タイプ: 文字列
Update requires: Replacement
-
ExecutionRoleArn-
このタスクでコンテナが引き受けることのできるタスク実行ロールの Amazon リソースネーム (ARN)。このタスクのすべてのコンテナには、このロールに指定されているアクセス許可が付与されます。
必須: いいえ
タイプ: 文字列
Update requires: Replacement
Family-
このタスク定義が登録されたファミリーの名前。ファミリーはタスク定義の複数のバージョンをグループ化します。Amazon ECS は、ファミリーに登録した最初のタスク定義にリビジョン番号 1 を付与します。Amazon ECS は、追加された各タスク定義に順番にリビジョン番号を付与していきます。
注記
タスク定義を更新するときにリビジョン番号を使用するには、このプロパティを指定します。値を指定しない場合、更新するたびに AWS CloudFormation によって新しいタスク定義が生成されます。
必須: いいえ
タイプ: 文字列
Update requires: Replacement
Memory-
タスクが使用するメモリの量 (MiB 単位)。EC2 起動タイプを使用している場合、このフィールドはオプションであり、任意の値を使用できます。Fargate 起動タイプを使用している場合、このフィールドは必須であり、次のいずれかの値を使用する必要があります。この値により
cpuパラメータの有効な値の範囲が決まります。-
512 (0.5 GB)、1024 (1 GB)、2048 (2 GB) - 使用可能な
cpu値: 256 (.25 vCPU) -
1024 (1 GB)、2048 (2 GB)、3072 (3 GB)、4096 (4 GB) - 使用可能な
cpu値: 512 (.5 vCPU) -
2048 (2 GB)、3072 (3 GB)、4096 (4 GB)、5120 (5 GB)、6144 (6 GB)、7168 (7 GB)、8192 (8 GB) - 使用可能な
cpu値: 1024 (1 vCPU) -
4096 (4 GB) ～ 16384 (16 GB) (1024 (1 GB) のインクリメント) - 使用可能な
cpu値: 2048 (2 vCPU) -
8192 (8 GB) ～ 30720 (30 GB) (1024 (1 GB) のインクリメント) - 使用可能な
cpu値: 4096 (4 vCPU)
必須: いいえ
タイプ: 文字列
Update requires: Replacement
-
NetworkMode-
タスクのコンテナで使用する Docker ネットワーキングモード。有効な値は、
none、bridge、awsvpc、およびhostです。デフォルトの Docker ネットワークモードはbridgeです。Fargate 起動タイプを使用している場合、awsvpcネットワークモードが必要です。EC2 起動タイプを使用している場合、どのネットワークモードも使用できます。ネットワークモードをnoneに設定した場合、コンテナの定義にポートマッピングを指定することはできず、タスクのコンテナに外部接続がなくなります。hostおよびawsvpcネットワークモードでは、コンテナのネットワークパフォーマンスは最大限に高まります。bridgeモードとは異なり、仮想化ネットワークスタックではなく、EC2 ネットワークスタックを使用するためです。hostおよびawsvpcネットワークモードでは、公開されるコンテナポートは対応するホストポート (hostネットワークモードの場合) またはアタッチされた Elastic Network Interface ポート (awsvpcネットワークモードの場合) に直接マッピングされるため、動的ホストポートマッピングは利用できません。ネットワークモードが
awsvpcの場合、タスクに Elastic Network Interface が割り当てられるため、タスク定義を使用したサービスの作成時またはタスクの実行時に、NetworkConfiguration 値を指定する必要があります。詳細については、Amazon Elastic Container Service 開発者ガイドの「タスクネットワーキング」を参照してください。注記
現在、Amazon ECS に最適化された AMI、
ecs-initパッケージがある他の Amazon Linux バリアント、または AWS Fargate インフラストラクチャのみが、awsvpcネットワークモードをサポートします。hostネットワークモードでポートマッピングが使用されている場合は、1 つのコンテナインスタンスで同じタスクの複数のインスタンスを実行することはできません。Windows 用の Docker では Linux 用の Docker とは異なるネットワークモードを使用します。Windows コンテナにタスク定義を登録するときに、ネットワークモードを指定しないでください。コンソールを使用して Windows コンテナにタスク定義を登録する場合は、
<default>ネットワークモードオブジェクトを選択する必要があります。詳細については、『Docker run リファレンス』の「ネットワーク設定」を参照してください。
必須: いいえ
タイプ: 文字列
許可された値:
awsvpc | bridge | host | noneUpdate requires: Replacement
PlacementConstraints-
タスクに使用する、配置制約オブジェクトの配列。Fargate 起動タイプを使用している場合、このフィールドは有効ではありません。
必須: いいえ
タイプ: TaskDefinitionPlacementConstraint のリスト
Update requires: Replacement
ProxyConfiguration-
ProxyConfigurationプロパティは、App Mesh プロキシの設定の詳細を指定します。プロキシ設定を有効にするには、Amazon ECS コンテナインスタンスにコンテナエージェントのバージョン 1.26.0 以上と
ecs-initパッケージのバージョン 1.26.0-1 以上が必要です。コンテナインスタンスが Amazon ECS に最適化された AMI バージョン20190301以降から起動される場合、コンテナエージェントおよびecs-initの必要なバージョンが含まれます。詳細については、Amazon Elastic Container Service 開発者ガイドの「Amazon ECS に最適化された Linux AMI」を参照してください。必須: いいえ
タイプ: ProxyConfiguration
Update requires: Replacement
RequiresCompatibilities-
タスクに必要な起動タイプ。値を指定しない場合、デフォルト値は
EC2です。有効な値は、EC2およびFARGATEです。必須: いいえ
タイプ: 文字列のリスト
Update requires: Replacement
Tags-
タスク定義に適用し、サービスの分類と整理に役立つメタデータ。タグはそれぞれ、1 つのキーとオプションの 1 つの値で構成されており、どちらもお客様側が定義します。
タグには以下のような基本制限があります。
-
リソースあたりのタグの最大数は 50 です
-
タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
-
キーの最大長 - 128 文字 (Unicode) (UTF-8)
-
値の最大長 - 256 文字 (Unicode) (UTF-8)
-
複数のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスでも許可される文字に制限が適用されることがあるのでご注意ください。一般的に使用が許可される文字は、UTF-8 で表現できる文字、数字、スペース、および +、-、=、.、_、:、/、@。
-
タグのキーと値は大文字と小文字が区別されます。
-
aws:、AWS:、またはその大文字または小文字の組み合わせを、キーまたは値のプレフィックスとして使用しないでください。これらの文字列は AWS による使用のために予約されています。このプレフィックスが含まれるタグのキーや値を編集または削除することはできません。このプレフィックスを持つタグは、リソースあたりのタグ数の制限時には計算されません。
必須: いいえ
タイプ: Tag のリスト
最大:
50Update requires: No interruption
-
TaskRoleArn-
ユーザーに代わってタスク内のコンテナに AWS API を 呼び出す許可を与える AWS Identity and Access Management (IAM) ロールの短い名前または完全な Amazon リソースネーム (ARN)。詳細については、『Amazon Elastic Container Service 開発者ガイド』の「Amazon ECS のタスクロール」を参照してください。
Windows 上のタスクの IAM ロールでは、Amazon ECS に最適化された Windows AMI を起動するときに
-EnableTaskIAMRoleオプションを設定する必要があります。また、コンテナでは、この機能を利用するために一部の設定コードを実行する必要があります。詳細については、『Amazon Elastic Container Service 開発者ガイド』の「Windows タスク用の IAM ロール」を参照してください。必須: いいえ
タイプ: 文字列
Update requires: Replacement
Volumes-
タスクのボリューム定義のリスト。
タスクが Fargate 起動タイプを使用している場合、
hostおよびsourcePathパラメータはサポートされません。ボリューム定義パラメータとデフォルト値の詳細については、『Amazon Elastic Container Service 開発者ガイド』の「Amazon ECS のタスク定義」を参照してください。
必須: いいえ
タイプ: Volume のリスト
Update requires: Replacement
戻り値
参照番号
このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref が返ります。 Amazon リソースネーム (ARN)。
次のサンプルでは、Ref 関数が MyTaskDefinition タスク定義の ARN (arn:aws:ecs:us-west-2:123456789012:task-definition/TaskDefinitionFamily:1 など) を返します。
{ "Ref": "MyTaskDefinition" }
For more information about using the Ref function, see Ref.
例
Amazon ECS タスク定義の作成
次の例では、コンテナの定義 2 つとボリューム定義 1 つを含む Amazon ECS タスク定義を定義します。
JSON
"taskdefinition": { "Type": "AWS::ECS::TaskDefinition", "Properties" : { "ContainerDefinitions" : [ { "Name": {"Ref": "AppName"}, "MountPoints": [ { "SourceVolume": "my-vol", "ContainerPath": "/var/www/my-vol" } ], "Image":"amazon/amazon-ecs-sample", "Cpu": "10", "PortMappings":[ { "ContainerPort": {"Ref":"AppContainerPort"}, "HostPort": {"Ref":"AppHostPort"} } ], "EntryPoint": [ "/usr/sbin/apache2", "-D", "FOREGROUND" ], "Memory":"500", "Essential": "true" }, { "Name": "busybox", "Image": "busybox", "Cpu": "10", "EntryPoint": [ "sh", "-c" ], "Memory": "500", "Command": [ "/bin/sh -c \"while true; do /bin/date > /var/www/my-vol/date; sleep 1; done\"" ], "Essential" : "false", "VolumesFrom": [ { "SourceContainer": {"Ref":"AppName"} } ] }], "Volumes": [ { "Host": { "SourcePath": "/var/lib/docker/vfs/dir/" }, "Name": "my-vol" }] } }
YAML
taskdefinition: Type: AWS::ECS::TaskDefinition Properties: ContainerDefinitions: - Name: Ref: "AppName" MountPoints: - SourceVolume: "my-vol" ContainerPath: "/var/www/my-vol" Image: "amazon/amazon-ecs-sample" Cpu: "10" PortMappings: - ContainerPort: Ref: "AppContainerPort" HostPort: Ref: "AppHostPort" EntryPoint: - "/usr/sbin/apache2" - "-D" - "FOREGROUND" Memory: "500" Essential: "true" - Name: "busybox" Image: "busybox" Cpu: "10" EntryPoint: - "sh" - "-c" Memory: "500" Command: - "/bin/sh -c \"while true; do /bin/date > /var/www/my-vol/date; sleep 1; done\"" Essential: "false" VolumesFrom: - SourceContainer: Ref: "AppName" Volumes: - Host: SourcePath: "/var/lib/docker/vfs/dir/" Name: "my-vol"
Amazon ECS タスク定義の作成
次の例では、必要な互換性として EC2 と FARGATE を指定する Amazon ECS タスク定義を指定します。
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "taskdefinition": { "Type": "AWS::ECS::TaskDefinition", "Properties": { "RequiresCompatibilities": [ "EC2", "FARGATE" ], "ContainerDefinitions": [ { "Name": "my-app", "MountPoints": [ { "SourceVolume": "my-vol", "ContainerPath": "/var/www/my-vol" } ], "Image": "amazon/amazon-ecs-sample", "Cpu": "10", "EntryPoint": [ "/usr/sbin/apache2", "-D", "FOREGROUND" ], "Memory": "500", "Essential": "true" }, { "Name": "busybox", "Image": "busybox", "Cpu": "10", "EntryPoint": [ "sh", "-c" ], "Memory": "500", "Command": [ "/bin/sh -c \"while true; do /bin/date > /var/www/my-vol/date; sleep 1; done\"" ], "Essential": "false", "VolumesFrom": [ { "SourceContainer": "my-app" } ] } ], "Volumes": [ { "Host": { "SourcePath": "/var/lib/docker/vfs/dir/" }, "Name": "my-vol" } ] } } } }
YAML
AWSTemplateFormatVersion: 2010-09-09 Resources: taskdefinition: Type: AWS::ECS::TaskDefinition Properties: RequiresCompatibilities: - "EC2" - "FARGATE" ContainerDefinitions: - Name: "my-app" MountPoints: - SourceVolume: "my-vol" ContainerPath: "/var/www/my-vol" Image: "amazon/amazon-ecs-sample" Cpu: "10" EntryPoint: - "/usr/sbin/apache2" - "-D" - "FOREGROUND" Memory: "500" Essential: "true" - Name: "busybox" Image: "busybox" Cpu: "10" EntryPoint: - "sh" - "-c" Memory: "500" Command: - "/bin/sh -c \"while true; do /bin/date > /var/www/my-vol/date; sleep 1; done\"" Essential: "false" VolumesFrom: - SourceContainer: "my-app" Volumes: - Host: SourcePath: "/var/lib/docker/vfs/dir/" Name: "my-vol"
