ecs-cli configure profile - Amazon Elastic Container Service

ecs-cli configure profile

名前付き Amazon ECS プロファイルで、~/.ecs/credentials ファイルに保存されている AWS 認証情報を設定します。複数のプロファイルを作成している場合は、ecs-cli configure profile default コマンドにより、デフォルトで使用されるプロファイルを変更できます。詳細については、「ecs-cli configure profile default」を参照してください。

重要

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

AWS の認証情報はさまざまな方法で設定できます。

  • AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEY および AWS_SESSION_TOKEN 環境変数を設定できます。ecs-cli configure profile を実行する場合、これらの変数の値は Amazon ECS CLI 設定ファイルに保存されます。

  • --access-key--secret-key および --session-token オプションを使用して、コマンドラインで認証情報を直接渡すことができます。

  • --profile-name フラグで新しいプロファイルの名前を指定できます。プロファイル名を指定しない場合、プロファイルには default という名前が付けられます。

  • 設定した最初のプロファイルがデフォルトとして設定されます。--ecs-profile フラグを使用しない場合は、このプロファイルで指定した認証情報が Amazon ECS CLI によって使用されます。

複数のプロファイルの使用

複数のプロファイルを使用する場合は、以下の点に注意してください。

  • 複数のプロファイルを設定できますが、1 つのプロファイルのみが常にデフォルトになります。このプロファイルは、認証情報が必要な Amazon ECS CLI コマンドを実行するときに使用されます。

  • 作成した最初のプロファイルがデフォルトとして設定されます。

  • デフォルトプロファイルを変更するには、ecs-cli configure profile default コマンドを使用します。詳細については、「ecs-cli configure profile default」を参照してください。

  • デフォルト以外のプロファイルは、--ecs-profile フラグを使用してコマンドで参照できます。

Syntax

ecs-cli configure profile --profile-name profile_name --access-key aws_access_key_id --secret-key aws_secret_access_key [--session-token token] [--help]

Options

名前

説明

--profile-name profile_name

この ECS プロファイルの名前を指定します。この名前は、--ecs-profile フラグを使用してコマンドで参照できます。このオプションを省略すると、名前は default に設定されます。

型: 文字列

必須: はい

--access-key aws_access_key_id

使用する AWS アクセスキーを指定します。AWS_ACCESS_KEY_ID の実行時に ecs-cli configure profile 環境変数を設定する場合、AWS アクセスキー ID はその環境変数の値に設定されます。

型: 文字列

必須: はい

--secret-key aws_secret_access_key

使用する AWS シークレットキーを指定します。AWS_SECRET_ACCESS_KEY の実行時に ecs-cli configure profile 環境変数を設定する場合、AWS シークレットアクセスキーはその環境変数の値に設定されます。

型: 文字列

必須: はい

--session-token token

使用する AWS セッショントークンを指定します。AWS_SESSION_TOKEN の実行時に ecs-cli configure profile 環境変数が設定されている場合、AWS セッショントークンはその環境変数の値に設定されます。一時的なアクセス用のセッショントークンに関する詳細は、「一時的なセキュリティ認証情報のリクエスト」を参照してください。

型: 文字列

必須: いいえ

--help, -h

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

必須: いいえ

Examples

例 1

この例では、一連のアクセスキーで default という名前のプロファイルを作成して使用するように、Amazon ECS CLI を設定します。

ecs-cli configure profile --profile-name default --access-key $AWS_ACCESS_KEY_ID --secret-key $AWS_SECRET_ACCESS_KEY

出力:

INFO[0000] Saved ECS CLI profile configuration default.

例 2

この例では、一連のアクセスキーおよび AWS セッショントークンで default という名前のプロファイルを作成して使用するように、Amazon ECS CLI を設定します。

ecs-cli configure profile --profile-name default --access-key $AWS_ACCESS_KEY_ID --secret-key $AWS_SECRET_ACCESS_KEY --session-token $AWS_SESSION_TOKEN

出力:

INFO[0000] Saved ECS CLI profile configuration default.