CodeConnections を使用したの例 AWS CLI

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

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

各例には、完全なソースコードへのリンクが含まれています。このリンクには、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

アクション

次の例は、create-connection を使用する方法を説明しています。

AWS CLI

接続を作成するには

次のcreate-connection例は、サードパーティーのリポジトリへの接続を作成する方法を示しています。この例では、サードパーティープロバイダーが Bitbucket である接続を作成します。

またはを介して作成された接続 AWS CloudFormation は、 AWS CLIデフォルトで保留中のステータスになります。CLI またはとの接続を作成したら AWS CloudFormation、コンソールを使用して接続を編集し、ステータスを利用可能にします。


aws codestar-connections create-connection \
    --provider-type Bitbucket \
    --connection-name MyConnection

出力:


{
    "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f"
}

詳細については、「デベロッパーツールコンソールユーザーガイド」の「接続の作成」を参照してください。

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

次の例は、create-host を使用する方法を説明しています。

AWS CLI

ホストを作成するには

次のcreate-host例は、サードパーティープロバイダーがインストールされているインフラストラクチャのエンドポイントを表すホストを作成する方法を示しています。この例では、サードパーティーインストールプロバイダーが GitHub Enterprise Server であるホストを作成します。

を通じて AWS CLI作成されたホストは、デフォルトで保留中ステータスです。を使用してホストを作成したらCLI、コンソールまたはを使用してホストをCLIセットアップし、そのステータスを利用可能にします。


aws codestar-connections create-host \
    --name MyHost \
    --provider-type GitHubEnterpriseServer \
    --provider-endpoint "https://my-instance.dev"

出力:


{
    "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605"
}

詳細については、「デベロッパーツールコンソールユーザーガイド」の「ホストの作成 (CLI）」を参照してください。

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

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

AWS CLI

接続を削除するには

次のdelete-connection例は、接続を削除する方法を示しています。


aws codestar-connections delete-connection \
    --connection-arn arn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f

このコマンドでは何も出力されません。

詳細については、「デベロッパーツールコンソールユーザーガイド」の「接続の削除 (CLI）」を参照してください。

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

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

AWS CLI

ホストを削除するには

次のdelete-host例は、ホストを削除する方法を示しています。ホストを削除する前に、ホストに関連付けられたすべての接続を削除する必要があります。


aws codestar-connections delete-host \
    --host-arn "arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605"

このコマンドでは何も出力されません。

詳細については、「デベロッパーツールコンソールユーザーガイド」の「ホストの削除 (CLI）」を参照してください。

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

次の例は、get-connection を使用する方法を説明しています。

AWS CLI

接続に関する情報を取得するには

次のget-connection例は、接続の詳細を示しています。


aws codestar-connections get-connection \
    --connection-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f

出力:


{
    "Connection": {
        "ConnectionName": "MyConnection",
        "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
        "ProviderType": "Bitbucket",
        "OwnerAccountId": "123456789012",
        "ConnectionStatus": "AVAILABLE"
    }
}

詳細については、「デベロッパーツールコンソールユーザーガイド」の「接続の詳細を表示する」を参照してください。

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

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

AWS CLI

ホストに関する情報を取得するには

次のget-host例は、ホストの詳細を示しています。


aws codestar-connections get-host \
    --host-arn arn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605

出力:


{
    "Name": "MyHost",
    "Status": "AVAILABLE",
    "ProviderType": "GitHubEnterpriseServer",
    "ProviderEndpoint": "https://test-instance-1.dev/"
}

詳細については、「デベロッパーツールコンソールユーザーガイド」の「ホストの詳細の表示 (CLI）」を参照してください。

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

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

AWS CLI

接続を一覧表示するには

次のlist-connections例では、Bitbucket プロバイダータイプのアカウント内のすべての接続のリストを取得します。


aws codestar-connections list-connections \
--provider-type Bitbucket \
--max-results 5 \
--next-token: next-token

出力:


{
    "Connections": [
        {
            "ConnectionName": "my-connection",
            "ProviderType": "Bitbucket",
            "Status": "PENDING",
            "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
            "OwnerAccountId": "123456789012"
        },
        {
            "ConnectionName": "my-other-connection",
            "ProviderType": "Bitbucket",
            "Status": "AVAILABLE",
            "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
            "OwnerAccountId": "123456789012"
        },
    ],
    "NextToken": "next-token"
}

詳細については、「デベロッパーツールコンソールユーザーガイド」の「接続の一覧表示 (CLI）」を参照してください。

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

次の例は、list-hosts を使用する方法を説明しています。

AWS CLI

ホストを一覧表示するには

次のlist-hosts例では、アカウント内のすべてのホストのリストを取得します。


aws codestar-connections list-hosts

出力:


{
    "Hosts": [
        {
            "Name": "My-Host",
            "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605",
            "ProviderType": "GitHubEnterpriseServer",
            "ProviderEndpoint": "https://my-instance.test.dev",
            "Status": "AVAILABLE"
        }
    ]
}

詳細については、「 デベロッパーツールコンソールユーザーガイド」の「ホストのリスト (CLI）」を参照してください。

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

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

タグを一覧表示するには

次のlist-tags-for-resource例では、指定された接続リソースにアタッチされているすべてのタグのリストを取得します。


aws codestar-connections list-tags-for-resource \
    --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f

出力:


{
    "Tags": [
        {
            "Key": "Project",
            "Value": "ProjectA"
        },
        {
            "Key": "ReadOnly",
            "Value": "true"
        }
    ]
}

詳細については、「デベロッパーツールコンソールユーザーガイド」の「接続リソースのタグを表示する」を参照してください。

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

次の例は、tag-resource を使用する方法を説明しています。

AWS CLI

リソースにタグを付けるには

次のtag-resource例では、提供されたタグのセットを接続に関連付けます。タグを追加または編集するには、このコマンドを使用します。


aws codestar-connections tag-resource \
    --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \
    --tags Key=Project,Value=ProjectA Key=IscontainerBased,Value=true

このコマンドでは何も出力されません。

詳細については、「デベロッパーツールコンソールユーザーガイド」の「接続リソースにタグを追加する」を参照してください。

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

次の例は、untag-resource を使用する方法を説明しています。

AWS CLI

接続リソースから AWS タグを削除するには

以下では、指定されたリソースからタグuntag-resourceを削除します。


aws codestar-connections untag-resource \
    --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \
    --tag-keys Project ReadOnly

出力:


{
    "Tags": []
}

詳細については、「デベロッパーツールコンソールユーザーガイド」の「接続リソースからタグを削除する」を参照してください。

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

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

AWS CodeStar 通知

Amazon Cognito ID

CodeConnections を使用した の例 AWS CLI

トピック

アクション

CodeConnections を使用したの例 AWS CLI