Beispiele für die Verwendung der AWS CLI mit CodeConnections

So stellen Sie eine Verbindung her

Das folgende create-connection-Beispiel zeigt, wie eine Verbindung mit einem Drittanbieter-Repository hergestellt wird. In diesem Beispiel wird eine Verbindung hergestellt, bei der der Drittanbieter Bitbucket ist.

Eine Verbindung, die über die AWS-CLI oder AWS CloudFormation erstellt wurde, befindet sich standardmäßig im Status „Ausstehend“. Nachdem Sie mit der CLI oder mit AWS CloudFormation eine Verbindung erstellt haben, bearbeiten Sie die Verbindung mit der Konsole, um ihren Status auf „Verfügbar“ zu setzen.

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

Ausgabe:

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

Weitere Informationen zu Verbindungen finden Sie unter Erstellen einer Verbindung im Benutzerhandbuch zur Entwicklertools-Konsole.

So erstellen Sie einen Host

Im folgenden create-host-Bespiel wird gezeigt, wie Sie einen Host erstellen, der den Endpunkt für die Infrastruktur darstellt, in der der Drittanbieter installiert ist. In diesem Beispiel wird ein Host erstellt, bei dem der installierte Drittanbieter GitHub Enterprise Server ist.

Ein Host, der über die AWS-CLI erstellt wird, ist standardmäßig im Status „Ausstehend“. Nachdem Sie mit der CLI einen Host erstellt haben, richten Sie mit der Konsole oder der CLI den Host so ein, dass er sich im Status „Verfügbar“ befindet.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erstellen eines Hosts (CLI) im Benutzerhandbuch zur Entwicklertools-Konsole.

So löschen Sie eine Verbindung

Das folgende delete-connection-Beispiel zeigt, wie Sie eine Verbindung löschen.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Löschen einer Verbindung (CLI) im Benutzerhandbuch zur Entwicklertools-Konsole.

So löschen Sie einen Host

Im folgenden delete-host-Beispiel wird gezeigt, wie ein Host gelöscht wird. Bevor Sie einen Host löschen können, müssen Sie alle Verbindungen löschen, die mit dem Host verknüpft sind.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Löschen eines Hosts (CLI) im Benutzerhandbuch zur Entwicklertools-Konsole.

So rufen Sie Informationen zu einer Verbindung ab

Im folgenden get-connection-Beispiel werden Details zu einer Verbindung angezeigt.

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

Ausgabe:

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

Weitere Informationen zu Verbindungen finden Sie unter Anzeigen von Verbindungsdetails im Benutzerhandbuch zur Entwicklertools-Konsole.

So rufen Sie Informationen zu einem Host ab

Im folgenden get-host-Beispiel werden Details zu einem Host angezeigt:

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

Ausgabe:

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

Weitere Informationen finden Sie unter Anzeigen von Hostdetails (CLI) im Benutzerhandbuch zur Entwicklertools-Konsole.

So listen Sie Verbindungen auf

Im folgenden list-connections-Beispiel wird eine Liste aller Verbindungen in Ihrem Konto für den Bitbucket-Anbietertyp abgerufen:

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

Ausgabe:

{
    "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"
}

Weitere Informationen zu Verbindungen finden Sie unter Auflisten von Verbindungen (CLI) im Benutzerhandbuch zur Entwicklertools-Konsole.

So listen Sie Hosts auf

Im folgenden list-hosts-Beispiel wird eine Liste aller Hosts in Ihrem Konto abgerufen.

aws codestar-connections list-hosts

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen zu Verbindungen finden Sie unter Auflisten von Hosts (CLI) im Benutzerhandbuch zur Entwicklertools-Konsole.

So listen Sie Tags auf

Im folgenden list-tags-for-resource-Beispiel wird eine Liste aller Tags abgerufen, die mit der angegebenen Verbindungsressource verknüpft sind.

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

Ausgabe:

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

Weitere Informationen zu Verbindungen finden Sie unter Anzeigen von Tags für eine Verbindungsressource im Benutzerhandbuch zur Entwicklertools-Konsole.

So markieren Sie eine Ressource

Das folgende tag-resource-Beispiel ordnet einen Satz bereitgestellter Tags einer Verbindung zu. Verwenden Sie diesen Befehl, um Tags hinzuzufügen oder zu bearbeiten.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen zu Verbindungen finden Sie unter Hinzufügen von Tags zu einer Verbindungsressource im Benutzerhandbuch zur Entwicklertools-Konsole.

So entfernen Sie AWS-Tags aus einer Verbindungsressource

Mit dem folgenden untag-resource-Befehl wird ein Tag aus der angegebenen Ressource entfernt.

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

Ausgabe:

{
    "Tags": []
}

Weitere Informationen zu Verbindungen finden Sie unter Entfernen von Tags aus einer Verbindungsressource im Benutzerhandbuch zur Entwicklertools-Konsole.