AWS Cloud9 examples using AWS CLI - AWS Command Line Interface
アクション

このドキュメントはバージョン 1 の AWS CLI のみを対象としています。AWS CLI のバージョン 2 に関連するドキュメントについては、バージョン 2 用ユーザーガイドを参照してください。

AWS Cloud9 examples using AWS CLI

次のコード例では、AWS Cloud9 で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

次のコード例では、create-environment-ec2 を使用する方法を示しています。

AWS CLI

AWS Cloud9 EC2 開発環境を作成する方法

次の create-environment-ec2 の例では、指定された設定で AWS Cloud9 開発環境を作成し、Amazon Elastic Compute Cloud (Amazon EC2) インスタンスを起動し、インスタンスから環境に接続します。

aws cloud9 create-environment-ec2 \
    --name my-demo-env \
    --description "My demonstration development environment." \
    --instance-type t2.micro --image-id amazonlinux-2023-x86_64 \
    --subnet-id subnet-1fab8aEX \
    --automatic-stop-time-minutes 60 \
    --owner-arn arn:aws:iam::123456789012:user/MyDemoUser

出力:

{
    "environmentId": "8a34f51ce1e04a08882f1e811bd706EX"
}

詳細については、「AWS Cloud9 ユーザーガイド」の「EC2 環境の作成」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「CreateEnvironmentEc2」を参照してください。

次のコード例では、create-environment-membership を使用する方法を示しています。

AWS CLI

環境メンバーを AWS Cloud9 開発環境に追加する方法

この例では、指定された環境メンバーを指定された AWS Cloud9 開発環境に追加します。

コマンド:

aws cloud9 create-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-write

出力:

{
  "membership": {
    "environmentId": "8a34f51ce1e04a08882f1e811bd706EX",
    "userId": "AIDAJ3LOROMOUXTBSU6EX",
    "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
    "permissions": "read-write"
  }
}

  • API の詳細については、「AWS CLI コマンドリファレンス」の「CreateEnvironmentMembership」を参照してください。

次のコード例では、delete-environment-membership を使用する方法を示しています。

AWS CLI

環境メンバーを AWS Cloud9 開発環境から削除する方法

この例では、指定された環境メンバーを指定された AWS Cloud9 開発環境に削除します。

コマンド:

aws cloud9 delete-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser

出力:

None.

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteEnvironmentMembership」を参照してください。

次のコード例では、delete-environment を使用する方法を示しています。

AWS CLI

AWS Cloud9 開発環境を削除する方法

この例では、指定された AWS Cloud9 開発環境を削除します。環境が Amazon EC2 インスタンスに接続されている場合、インスタンスを終了します。

コマンド:

aws cloud9 delete-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX

出力:

None.

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteEnvironment」を参照してください。

次のコード例では、describe-environment-memberships を使用する方法を示しています。

AWS CLI

AWS Cloud9 開発環境の環境メンバーに関する情報を取得します。

この例では、指定された AWS Cloud9 開発環境の環境メンバーに関する情報を取得します。

コマンド:

aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX

出力:

{
  "memberships": [
    {
      "environmentId": "8a34f51ce1e04a08882f1e811bd706EX",
      "userId": "AIDAJ3LOROMOUXTBSU6EX",
      "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
      "permissions": "read-write"
    },
    {
      "environmentId": "8a34f51ce1e04a08882f1e811bd706EX",
      "userId": "AIDAJNUEDQAQWFELJDLEX",
      "userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
      "permissions": "owner"
    }
  ]
}

AWS Cloud9 開発環境の所有者に関する情報を取得する方法

この例では、指定された AWS Cloud9 開発環境の所有者に関する情報を取得します。

コマンド:

aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX --permissions owner

出力:

{
  "memberships": [
    {
      "environmentId": "8a34f51ce1e04a08882f1e811bd706EX",
      "userId": "AIDAJNUEDQAQWFELJDLEX",
      "userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
      "permissions": "owner"
    }
  ]
}

複数の AWS Cloud9 開発環境の環境メンバーに関する情報を取得します。

この例では、複数の AWS Cloud9 開発環境の指定された環境メンバーに関する情報を取得します。

コマンド:

aws cloud9 describe-environment-memberships --user-arn arn:aws:iam::123456789012:user/MyDemoUser

出力:

{
  "memberships": [
    {
      "environmentId": "10a75714bd494714929e7f5ec4125aEX",
      "lastAccess": 1516213427.0,
      "userId": "AIDAJNUEDQAQWFELJDLEX",
      "userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
      "permissions": "owner"
    },
    {
      "environmentId": "1980b80e5f584920801c09086667f0EX",
      "lastAccess": 1516144884.0,
      "userId": "AIDAJNUEDQAQWFELJDLEX",
      "userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
      "permissions": "owner"
    }
  ]
}

次のコード例では、describe-environment-status を使用する方法を示しています。

AWS CLI

AWS Cloud9 開発環境に関するステータス情報を取得する方法

この例では、指定された AWS Cloud9 開発環境のステータス情報を取得します。

コマンド:

aws cloud9 describe-environment-status --environment-id 685f892f431b45c2b28cb69eadcdb0EX

出力:

{
  "status": "ready",
  "message": "Environment is ready to use"
}

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeEnvironmentStatus」を参照してください。

次のコード例では、describe-environments を使用する方法を示しています。

AWS CLI

AWS Cloud9 開発環境に関する情報を取得する許可を付与

この例では、指定された AWS Cloud9 開発環境の情報を取得します。

コマンド:

aws cloud9 describe-environments --environment-ids 685f892f431b45c2b28cb69eadcdb0EX 349c86d4579e4e7298d500ff57a6b2EX

出力:

{
  "environments": [
    {
      "id": "685f892f431b45c2b28cb69eadcdb0EX",
      "name": "my-demo-ec2-env",
      "description": "Created from CodeStar.",
      "type": "ec2",
      "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:685f892f431b45c2b28cb69eadcdb0EX",
      "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser",
      "lifecycle": {
        "status": "CREATED"
      }
    },
    {
      "id": "349c86d4579e4e7298d500ff57a6b2EX",
      "name": my-demo-ssh-env",
      "description": "",
      "type": "ssh",
      "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX",
      "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser",
      "lifecycle": {
        "status": "CREATED"
      }
    }
  ]
}

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeEnvironments」を参照してください。

次のコード例では、list-environments を使用する方法を示しています。

AWS CLI

AWS Cloud9 開発環境の識別子の一覧を取得する方法

この例では、AWS Cloud9 開発環境の識別子の一覧を取得します。

コマンド:

aws cloud9 list-environments

出力:

{
  "environmentIds": [
    "685f892f431b45c2b28cb69eadcdb0EX",
    "1980b80e5f584920801c09086667f0EX"
  ]
}

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListEnvironments」を参照してください。

次のコード例では、update-environment-membership を使用する方法を示しています。

AWS CLI

AWS Cloud9 開発環境の既存の環境メンバーの設定を変更する方法

この例では、指定された AWS Cloud9 開発環境の指定された既存の環境メンバーの設定を変更します。

コマンド:

aws cloud9 update-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-only

出力:

{
  "membership": {
    "environmentId": "8a34f51ce1e04a08882f1e811bd706EX",
    "userId": "AIDAJ3LOROMOUXTBSU6EX",
    "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
    "permissions": "read-only"
  }
}

  • API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateEnvironmentMembership」を参照してください。

次のコード例では、update-environment を使用する方法を示しています。

AWS CLI

既存の AWS Cloud9 開発環境の設定を変更する方法

この例では、指定された既存の AWS Cloud9 開発環境の指定された設定を変更します。

コマンド:

aws cloud9 update-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX --name my-changed-demo-env --description "My changed demonstration development environment."

出力:

None.

  • API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateEnvironment」を参照してください。