CodeConnections を使用した例 AWS CLI

接続を作成するには

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

または を通じて AWS CLI作成された接続 AWS CloudFormation は、デフォルトで保留中のステータスです。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"
}

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

ホストを作成するには

次の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）」を参照してください。

接続を削除するには

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

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

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

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

ホストを削除するには

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

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

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

詳細については、「 デベロッパーツールコンソールユーザーガイド」の「ホストの削除 (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"
    }
}

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

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

次の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）」を参照してください。

接続を一覧表示するには

次の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) を一覧表示する」を参照してください。

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

次の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）」を参照してください。

タグを一覧表示するには

次の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"
        }
    ]
}

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

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

次の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

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

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

接続リソースから 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": []
}

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