CodeConnections Beispiele mit AWS CLI

Um eine Verbindung herzustellen

Das folgende Beispiel für create-connection 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 erstellt wurde oder AWS CloudFormation sich standardmäßig im Status Ausstehend befindet. Nachdem Sie eine Verbindung mit der CLI oder mit der Konsole hergestellt haben AWS CloudFormation, bearbeiten Sie die Verbindung, um ihren Status Verfügbar zu machen.

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 Eine Verbindung erstellen im Benutzerhandbuch für die Entwicklertools-Konsole.

So erstellen Sie einen Host

Das folgende Beispiel für create-host zeigt, 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, auf dem GitHub Enterprise Server als Drittanbieter installiert ist.

Ein über die AWS CLI erstellter Host hat standardmäßig den 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 für die Entwicklertools-Konsole.

So löschen Sie eine Verbindung

Das folgende Beispiel für delete-connection 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 für die Entwicklertools-Konsole.

So löschen Sie einen Host

Im folgenden Beispiel für delete-host 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 für die Entwicklertools-Konsole.

So rufen Sie Informationen zu einer Verbindung ab

Das folgende Beispiel für get-connection zeigt Details zu einer Verbindung.

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 für die Entwicklertools-Konsole.

So rufen Sie Informationen zu einem Host ab

Das folgende Beispiel für get-host zeigt Details zu einem Host.

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 View host details (CLI) im Benutzerhandbuch für die Entwicklertools-Konsole.

So listen Sie Verbindungen auf

Im folgenden Beispiel für list-connections 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 für die Entwickler-Tools-Konsole.

So listen Sie Hosts auf

Im folgenden Beispiel für list-hosts 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 für die Entwicklertools-Konsole.

So listen Sie Tags auf

Im folgenden Beispiel für list-tags-for-resource 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 für die Entwicklertools-Konsole.

So taggen Sie eine Ressource

Im folgenden Beispiel für tag-resource wird ein Satz bereitgestellter Tags einer Verbindung zugeordnet. 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 für die Entwicklertools-Konsole.

Um AWS Tags aus einer Verbindungsressource zu entfernen

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 für die Entwicklertools-Konsole.