AWS Toolkit for Visual Studio Code の Amazon Elastic Container Service Exec - AWS Toolkit for VS Code

AWS Toolkit for Visual Studio Code の Amazon Elastic Container Service Exec

Amazon ECS Exec 機能を使用して、AWS Toolkit for Visual Studio Code を使用して Amazon Elastic Container Service (Amazon ECS) コンテナ内で単一のコマンドを発行できます。

重要

Amazon ECS Exec を有効または無効にすると、AWS アカウントのリソースの状態が変わります。これには、サービスの停止と再起動が含まれます。さらに、Amazon ECS Exec が有効になっている間にリソースの状態を変更すると、予期しない結果が生じる可能性があります。Amazon ECS の詳細については、デベロッパーガイドの「Amazon ECS Exec を使用してデバッグする」を参照してください。

Amazon Exec の前提条件

Amazon ECS の機能を使用する前に、いくつかの前提条件を満たす必要があります。

Amazon ECS の要件

Amazon ECS Exec には、タスクが Amazon EC2 でホストされているか AWS Fargate でホストされているかに応じて、異なるバージョン要件があります。

  • Amazon EC2 を使用している場合は、2021 年 1 月 20 日以降にリリースされた Amazon ECS 最適化 AMI を、エージェントバージョン 1.50.2 以上で使用する必要があります。補足情報はデベロッパーガイド「Amazon ECS に最適化された AMI」に記載されています。

  • AWS Fargate を使用している場合は、プラットフォームバージョン 1.4.0 以上を使用する必要があります。Fargate の要件に関する補足情報は、デベロッパーガイド「AWS Fargate プラットフォームバージョン」に記載されています。

AWS アカウントの設定と IAM のアクセス許可

Amazon ECS Exec 機能を使用するには、AWS アカウントに関連付けられた既存の Amazon ECS クラスターが必要です。Amazon ECS Exec は Systems Manager を使用してクラスター内のコンテナとの接続を確立します。SSM サービスと通信するには、特定のタスクの IAM ロールのアクセス許可が必要です。

Amazon ECS Exec に固有の IAM ロールとポリシーの情報については、「ECS Exec に必要な IAM アクセス許可 デベロッパーガイド」に記載されています。

Amazon ECS Exec の操作

Amazon ECS Exec は、Toolkit for VS Code の AWS Explorer から直接有効または無効にすることができます。Amazon ECS Exec を有効にすると、Amazon ECS メニューからコンテナを選択し、それらに対してコマンドを実行できます。

Amazon ECS Exec の有効化

  1. AWS Explorer から、Amazon ECS メニューを見つけて展開します。

  2. 変更するサービスを含むクラスターを拡張します。

  3. サービスのコンテキストメニュー (右クリック) を開き、[Enable Command Execution] (コマンドの実行を有効にする) を選択します

重要

これによりサービスの新規デプロイが開始されます。完了まで数分かかることがあります。詳細については、このセクションの冒頭にある注意事項を参照してください。

Amazon ECS Exec の無効化

  1. AWS Explorer から、Amazon ECS メニューを見つけて展開します。

  2. 必要なサービスを収容するクラスターを展開します。

  3. サービスのコンテキストメニュー (右クリック) を開き、[Disable Commance Execution] (コマンド実行を無効にする) を選択します

重要

これによりサービスの新規デプロイが開始されます。完了まで数分かかることがあります。詳細については、このセクションの冒頭にある注意事項を参照してください。

コンテナに対するコマンドの実行

AWS Explorer を使用してコンテナに対してコマンドを実行するには、Amazon ECS Exec を有効にする必要があります。有効になっていない場合は、このセクションの「ECS Exec を有効にする」の手順を参照してください。

  1. AWS Explorer から、Amazon ECS メニューを見つけて展開します。

  2. 必要なサービスを収容するクラスターを展開します。

  3. サービスを展開して、関連するコンテナを一覧表示します。

  4. コンテナのコンテキストメニュー (右クリック) を開き、[Run Command in Container] (コンテナでコマンドを実行) を選択します

  5. 実行中のタスクのリストが表示されたプロンプトが開くので、目的のタスク ARN を選択します。

    注記

    そのサービスに対して実行中のタスクが 1 つだけの場合、そのタスクは自動的に選択され、このステップはスキップされます。

  6. プロンプトが表示されたら、実行するコマンドを入力し、Enter キーを押して処理します。