CodeConnections Beispiele mit AWS CLI

Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von AWS Command Line Interface with Aktionen ausführen und allgemeine Szenarien implementieren CodeConnections.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Aktionen zeigen Ihnen zwar, wie Sie einzelne Servicefunktionen aufrufen, aber Sie können Aktionen im Kontext der zugehörigen Szenarien sehen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, in dem Sie Anweisungen zum Einrichten und Ausführen des Codes im Kontext finden.

Aktionen

create-connection

Das folgende Codebeispiel zeigt die Verwendungcreate-connection.

AWS CLI

Um eine Verbindung herzustellen

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

Eine Verbindung, die über AWS CLI oder AWS CloudFormation erstellt wurde, hat standardmäßig den Status Ausstehend. Nachdem Sie eine Verbindung mit dem CLI oder hergestellt haben AWS CloudFormation, bearbeiten Sie die Verbindung in der Konsole, sodass ihr Status Verfügbar zugewiesen wird.

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 finden Sie im Benutzerhandbuch für die Developer Tools-Konsole unter Verbindung erstellen.

• APIEinzelheiten finden Sie CreateConnectionin der AWS CLI Befehlsreferenz.

create-host

Das folgende Codebeispiel zeigt die Verwendungcreate-host.

AWS CLI

Um einen Host zu erstellen

Das folgende create-host Beispiel zeigt, wie Sie einen Host erstellen, der den Endpunkt für die Infrastruktur darstellt, in der Ihr Drittanbieter installiert ist. In diesem Beispiel wird ein Host erstellt, auf dem GitHub Enterprise Server als Drittanbieter installiert ist.

Ein über den AWS CLI erstellter Host hat standardmäßig den Status Ausstehend. Nachdem Sie einen Host mit dem erstellt habenCLI, verwenden Sie die Konsole oder die, CLI um den Host so einzurichten, dass er den Status Verfügbar erhält.

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 Create a host (CLI) im Developer Tools-Konsolen-Benutzerhandbuch.

• APIEinzelheiten finden Sie CreateHostunter AWS CLI Befehlsreferenz.

delete-connection

Das folgende Codebeispiel zeigt die Verwendungdelete-connection.

AWS CLI

Um eine Verbindung zu löschen

Das folgende delete-connection Beispiel zeigt, wie eine Verbindung gelöscht wird.

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 Developer Tools-Konsole.

• APIEinzelheiten finden Sie DeleteConnectionunter AWS CLI Befehlsreferenz.

delete-host

Das folgende Codebeispiel zeigt die Verwendungdelete-host.

AWS CLI

Um einen Host zu löschen

Das folgende delete-host Beispiel zeigt, 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 Developer Tools-Konsole.

• APIEinzelheiten finden Sie DeleteHostunter AWS CLI Befehlsreferenz.

get-connection

Das folgende Codebeispiel zeigt die Verwendungget-connection.

AWS CLI

Um Informationen über eine Verbindung zu erhalten

Das folgende get-connection Beispiel 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 finden Sie im Benutzerhandbuch für die Developer Tools Console unter Verbindungsdetails anzeigen.

• APIEinzelheiten finden Sie GetConnectionin der AWS CLI Befehlsreferenz.

get-host

Das folgende Codebeispiel zeigt die Verwendungget-host.

AWS CLI

Um Informationen über einen Host zu erhalten

Das folgende get-host Beispiel 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 Host-Details anzeigen (CLI) im Developer Tools-Konsolen-Benutzerhandbuch.

• APIEinzelheiten finden Sie GetHostunter AWS CLI Befehlsreferenz.

list-connections

Das folgende Codebeispiel zeigt die Verwendunglist-connections.

AWS CLI

Um Verbindungen aufzulisten

Im folgenden list-connections Beispiel wird eine Liste aller Verbindungen in deinem 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 finden Sie unter Verbindungen auflisten (CLI) im Benutzerhandbuch für die Developer Tools Console.

• APIEinzelheiten finden Sie ListConnectionsin der AWS CLI Befehlsreferenz.

list-hosts

Das folgende Codebeispiel zeigt die Verwendunglist-hosts.

AWS CLI

Um Hosts aufzulisten

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 finden Sie unter Hosts auflisten (CLI) im Benutzerhandbuch für die Developer Tools Console.

• APIEinzelheiten finden Sie ListHostsin der AWS CLI Befehlsreferenz.

list-tags-for-resource

Das folgende Codebeispiel zeigt die Verwendunglist-tags-for-resource.

AWS CLI

Um Tags aufzulisten

Im folgenden list-tags-for-resource Beispiel wird eine Liste aller Tags abgerufen, die an die angegebene Verbindungsressource angehängt 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 finden Sie im Benutzerhandbuch für die Developer Tools-Konsole unter Tags für eine Verbindungsressource anzeigen.

• APIEinzelheiten finden Sie ListTagsForResourceunter AWS CLI Befehlsreferenz.

tag-resource

Das folgende Codebeispiel zeigt die Verwendungtag-resource.

AWS CLI

Um eine Ressource zu taggen

Das folgende tag-resource Beispiel verknüpft einen Satz bereitgestellter Tags mit einer Verbindung. 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 finden Sie im Benutzerhandbuch für die Developer Tools-Konsole unter Hinzufügen von Tags zu einer Verbindungsressource.

• APIEinzelheiten finden Sie TagResourceunter AWS CLI Befehlsreferenz.

untag-resource

Das folgende Codebeispiel zeigt die Verwendunguntag-resource.

AWS CLI

Um AWS Tags aus einer Verbindungsressource zu entfernen

Im Folgenden untag-resource 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 finden Sie unter Entfernen von Tags aus einer Verbindungsressource im Benutzerhandbuch für die Developer Tools-Konsole.

• APIEinzelheiten finden Sie UntagResourceunter AWS CLI Befehlsreferenz.