ecs-cli compose service - Amazon Elastic Container Service

ecs-cli compose service

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

注記

サービスを作成する代わりに Amazon ECS CLI でタスクを実行する場合は、「ecs-cli compose」を参照してください。

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

注記

Amazon ECS CLI は、Amazon ECS CLI で作成されたタスク、サービス、およびコンテナインスタンスのみを管理できます。Amazon ECS CLI によって作成されなかったタスク、サービス、およびコンテナインスタンスを管理するには、AWS Command Line Interface または AWS Management Console を使用します。

重要

説明されている機能の中には、最新バージョンの Amazon ECS CLI でのみ使用できるものがあります。最新バージョンの詳細については、「Amazon ECS CLI のインストール」を参照してください。

Syntax

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] service [subcommand] [arguments] [--help]

Options

名前

説明

--verbose, --debug

診断に役立つように、コマンド出力の詳細度を高めます。

必須: いいえ

--file, -f compose_file

実行する Docker Compose ファイルを指定します。現時点で、Amazon ECS CLI の最新バージョンは、Docker Compose ファイル構文バージョン 1、2、および 3 のメジャーバージョンのみをサポートしています。構成ファイルで指定されたバージョンは、文字列 "1""1.0""2""2.0""3"、または "3.0" である必要があります。Docker Compose マイナーバージョンはサポートされていません。ecs-cli compose の実行時に COMPOSE_FILE 環境変数を設定する場合、Docker Compose ファイルはその環境変数の値に設定されます。

型: 文字列

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

必須: いいえ

--project-name, -p project_name

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

型: 文字列

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

必須: いいえ

--task-role-arn role_value

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

型: 文字列

必須: いいえ

--ecs-params ecs_params_file

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

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

必須: いいえ

--registry-creds value

使用する Amazon ECS レジストリー認証情報ファイルを指定します。存在する場合、ecs-cli registry-creds up コマンドからの最新の出力ファイルをデフォルトにします。詳細については、「ecs-cli registry-creds」を参照してください。

デフォルト: ./ecs-registry-creds_[TIMESTAMP].yml

必須: いいえ

--region, -r region

使用する AWS リージョンを指定します。デフォルトは、configure コマンドを使用して設定したクラスターになります。

型: 文字列

必須: いいえ

--cluster-config cluster_config_name

使用する Amazon ECS クラスター構成の名前を指定します。デフォルトクラスター構成がデフォルトとして保存されます。

型: 文字列

必須: いいえ

--ecs-profile ecs_profile

使用する Amazon ECS プロファイル設定の名前を指定します。configure profile コマンドを使用してプロファイルにデフォルトを設定します。

型: 文字列

必須: いいえ

--aws-profile aws_profile

使用する AWS プロファイルを指定します。AWS という名前の既存のプロファイルから、~/.aws/credentials 認証情報を使用することができます。

型: 文字列

必須: いいえ

--cluster, -c cluster_name

使用するAmazon ECS クラスター名を指定します。デフォルトは、configure コマンドを使用して設定したクラスターになります。

型: 文字列

必須: いいえ

--help, -h

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

必須: いいえ

使用できるサブコマンド

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

create

構成ファイルからAmazon ECS サービスを作成します。サービスは必要数を 0 として作成されるため、このコマンドによってコンテナは開始されません。詳細については、「ecs-cli compose service create」を参照してください。

start

作成された Amazon ECS サービスで各コンテナの 1 つのコピーを開始します。このコマンドはサービスの必要数を 1 に更新します。詳細については、「ecs-cli compose service start」を参照してください。

up

構成ファイルから Amazon ECS サービスを作成し (まだない場合)、そのタスクの 1 つのインスタンスをクラスターで実行します (createstart の組み合わせ)。このコマンドはサービスの必要数を 1 に更新します。詳細については、「ecs-cli compose service up」を参照してください。

ps, list

構成プロジェクトで作成されたサービスに属する、クラスター内のすべてのコンテナを一覧表示します。詳細については、「ecs-cli compose service ps, list」を参照してください。

scale

サービスの必要数を、指定した数にスケーリングします。詳細については、「ecs-cli compose service scale」を参照してください。

stop

構成プロジェクトで作成されたサービスに属する、実行中のタスクを停止します。このコマンドはサービスの必要数を 0 に更新します。詳細については、「ecs-cli compose service stop」を参照してください。

rm, delete, down

サービスの必要数を 0 に更新してから、サービスを削除します。詳細については、「ecs-cli compose service rm, delete, down」を参照してください。