メニュー
Amazon Elastic Container Service
開発者ガイド (API Version 2014-11-13)

Amazon ECS CLI の設定

Amazon ECS CLI を使用するには、AWS 認証情報、クラスターを作成する AWS リージョン、および Amazon ECS クラスターで使用する名前などの基本設定情報がいくつか必要です。設定情報は macOS および Linux システムでは ~/.ecs ディレクトリに、Windows システムでは C:\Users\<username>\AppData\local\ecs に保存されます。

Amazon ECS CLI を構成するには

  1. 次のコマンドを使用して CLI プロファイルを設定し、profile_name を希望のプロファイル名に、$AWS_ACCESS_KEY_ID および $AWS_SECRET_ACCESS_KEY 環境変数を AWS 認証情報に置き換えます。

    ecs-cli configure profile --profile-name profile_name --access-key $AWS_ACCESS_KEY_ID --secret-key $AWS_SECRET_ACCESS_KEY
  2. 次のコマンドで設定を完了し、launch type をデフォルトで使用する起動タイプに、region_name を希望の AWS リージョンに、cluster_name を使用する既存の Amazon ECS クラスターまたは新しいクラスターの名前に、configuration_name をこの設定に付ける名前に置き換えます。

    ecs-cli configure --cluster cluster_name --default-launch-type launch_type --region region_name --config-name configuration_name

CLI をインストールして設定すると、「チュートリアル: ECS CLI を使用して Fargate タスクのクラスターを作成する」を実行できます。詳細については、Amazon ECS コマンドラインリファレンス を参照してください。

プロファイル

Amazon ECS CLI は、ecs-cli configure profile コマンドを使用して、プロファイルという名前の複数の AWS 認証情報のセットの設定をサポートします。デフォルトのプロファイルは、ecs-cli configure profile default コマンドを使用して設定できます。これらのプロファイルは、--ecs-profile フラグを使用する認証情報を必要とする Amazon ECS CLI コマンドを実行するときに参照できます。それ以外の場合、デフォルトのプロファイルが使用されます。

詳細については、「ecs-cli configure profile」および「ecs-cli configure profile default」を参照してください。

クラスター設定

クラスター設定は、クラスターの名前とリージョンを含む、Amazon ECS クラスターを説明する一連のフィールドです。デフォルトのクラスタープロファイルは、ecs-cli configure default コマンドを使用して設定できます。Amazon ECS CLI は、--config-name オプションを使用した複数の名前付きクラスター設定の指定をサポートしています。

詳細については、「ecs-cli configure」および「ecs-cli configure default」を参照してください。

優先順位

認証情報とリージョンの両方を Amazon ECS CLI コマンドで渡すには、複数の方法があります。以下に示しているのは、それぞれの優先順位です。

認証情報の優先順位は次のとおりです。

  1. ECS CLI プロファイルフラグ

    1. ECS プロファイル (--ecs-profile)

    2. AWS プロファイル (--aws-profile)

  2. 環境変数

    1. ECS_PROFILE

    2. AWS_PROFILE

    3. AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEY、および AWS_SESSION_TOKEN

  3. ECS config‐デフォルトの ECS プロファイルから認証情報の取得を試みます

  4. デフォルトの AWS プロファイル ‐ AWS プロファイル名から認証情報 (aws_access_key_idaws_secret_access_key) または assume_role (role_arnsource_profile) の使用を試みます

    1. AWS_DEFAULT_PROFILE 環境変数 (デフォルトは default)

  5. EC2 インスタンスロール

リージョンの優先順位は次のとおりです。

  1. ECS CLI フラグ

    1. リージョンフラグ (--region)

    2. クラスター config フラグ (--cluster-config)

  2. ECS config‐デフォルトの ECS プロファイルからリージョンの取得を試みます

  3. 環境変数‐次の環境変数からリージョンの取得を試みます

    1. AWS_REGION

    2. AWS_DEFAULT_REGION

  4. AWS プロファイル ‐ AWS プロファイル名からリージョンの使用を試みます

    1. AWS_PROFILE 環境変数

    2. AWS_DEFAULT_PROFILE 環境変数 (デフォルトは default)