Amazon Elastic Container Service
開発者ガイド (API バージョン 2014-11-13)

ecs-cli compose

ECS クラスターで docker-compose スタイルのコマンドを使用して、Amazon ECS タスクを管理します。Amazon ECS CLI と Docker Compose ファイル構文の連携方法の詳細については、「Docker Compose ファイル構文の使用」を参照してください。

注記

Amazon ECS CLI を使用して Amazon ECS サービスを作成するには、「ecs-cli compose service」を参照してください。

ecs-cli compose コマンドは、作成するタスク定義とサービスで、プロジェクト名を使用します。CLI によって構成ファイルからタスク定義が作成されるとき、タスク定義には project-name という名前が付けられます。CLI によって構成ファイルからサービスが作成されるとき、サービスには service-project-name という名前が付けられます。デフォルトでは、プロジェクト名は使用する Docker Compose ファイルが含まれているディレクトリの名前です。ただし、--project-name オプションを使用して独自のプロジェクト名を指定することもできます。

注記

Amazon ECS CLI は、CLI で作成されたタスク、サービス、およびコンテナインスタンスのみを管理できます。Amazon ECS CLI で作成されていないタスク、サービス、およびコンテナインスタンスを管理するには、AWS Command Line Interface または AWS マネジメントコンソールを使用します。

重要

記載されている機能の一部は、ECS CLI の最新バージョンでのみ使用可能です。最新バージョンを取得するには、「Amazon ECS CLI のインストール」を参照してください。

構文

ecs-cli compose [--verbose] [--file compose_file] [--project-name project_name] [--task-role-arn task_role_arn] [--ecs-params ecs_params_file] [--registry-creds value] [--region region] [--cluster-config cluster_config_name] [--ecs-profile ecs_profile] [--aws-profile aws_profile] [--cluster cluster_name] [--help] [subcommand] [arguments] [--help]

オプション

名前 説明

--verbose, --debug

コマンド出力の詳細を増やし、診断に役立てます。

必須: いいえ

--file, -f compose-file

使用する Docker 構成ファイルを指定します。現時点で、Amazon ECS CLI の最新バージョンでは、Docker 構成ファイル構文のバージョン 1 と 2 がサポートされています。 ecs-cli compose の実行時に COMPOSE_FILE 環境変数が設定されている場合、Docker 構成ファイルは、その環境変数の値に設定されます。

型: 文字列

デフォルト: ./docker-compose.yml

必須: いいえ

--project-name, -p project-name

使用するプロジェクト名を指定します。ecs-cli compose の実行時に COMPOSE_PROJECT_NAME 環境変数を設定する場合、プロジェクト名はその環境変数の値に設定されます。

型: 文字列

デフォルト: 現在のディレクトリ名。

必須: いいえ

--task-role-arn role_value

このタスクでコンテナが引き受けることのできる IAM ロールの略称または Amazon リソースネーム (ARN) 全体を指定します。このタスクのすべてのコンテナには、このロールに指定されているアクセス許可が付与されます。

型: 文字列

必須: いいえ

--ecs-params

Docker 構成ファイルでネイティブではない ECS パラメータが指定されます。詳細については、「Amazon ECS パラメータの使用」を参照してください。

デフォルト: ./ecs-params.yml

必須: いいえ

--region, -r region

Specifies the AWS Region to use. Defaults to the cluster configured using the configure command.

Type: String

Required: No

--cluster-config cluster_config_name

Specifies the name of the Amazon ECS cluster configuration to use. Defaults to the cluster configuration set as the default.

Type: String

Required: No

--ecs-profile ecs_profile

Specifies the name of the Amazon ECS profile configuration to use. Defaults to the profile configured using the configure profile command.

Type: String

Required: No

--aws-profile aws_profile

Specifies the AWS profile to use. Enables you to use the AWS credentials from an existing named profile in ~/.aws/credentials.

Type: String

Required: No

--cluster, -c cluster_name

Specifies the Amazon ECS cluster name to use. Defaults to the cluster configured using the configure command.

Type: String

Required: No

--help, -h

Shows the help text for the specified command.

Required: No

使用できるサブコマンド

ecs-cli compose コマンドでは、以下のサブコマンドを使用できます。これらの各サブコマンドには、関連付けられた独自のフラグがあり、--help フラグを使用して表示できます。

create

構成ファイルから Amazon ECS タスク定義を作成します。詳細については、「ecs-cli compose create」を参照してください。

pslist

構成プロジェクトによって開始されたクラスター内のすべてのコンテナを一覧表示します。

run [containerName] ["command ..."] ...

指定した 1 回限りのコマンドでコマンドを上書きして、すべてのコンテナを開始します。

scale n

実行中のタスクの数を、指定した数にスケーリングします。

start

構成ファイルから作成されたタスク定義から 1 つのタスクを開始します。詳細については、「ecs-cli compose start」を参照してください。

stopdown

構成プロジェクトによって作成されたすべての実行中のタスクを停止します。

up

構成ファイルから ECS タスク定義を作成し (まだない場合)、そのタスクの 1 つのインスタンスをクラスターで実行します (createstart の組み合わせ)。詳細については、「ecs-cli compose up」を参照してください。

service [subcommand]

構成ファイルから ECS サービスを作成します。詳細については、「ecs-cli compose service」を参照してください。

help

指定したコマンドのヘルプテキストを表示します。