CodeConnections esempi che utilizzano AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with CodeConnections.

Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un collegamento al codice sorgente completo, in cui è possibile trovare istruzioni su come configurare ed eseguire il codice nel contesto.

Azioni

create-connection

Il seguente esempio di codice mostra come utilizzarecreate-connection.

AWS CLI

Per creare una connessione

L'create-connectionesempio seguente mostra come creare una connessione a un repository di terze parti. Questo esempio crea una connessione in cui il provider di terze parti è Bitbucket.

Una connessione creata tramite la AWS CLI o AWS CloudFormation è in sospeso per impostazione predefinita. Dopo aver creato una connessione con la CLI o AWS CloudFormation, utilizza la console per modificare la connessione e renderne lo stato Disponibile.

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

Output:

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

Per ulteriori informazioni, consulta Creare una connessione nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta CreateConnection AWS CLICommand Reference.

create-host

Il seguente esempio di codice mostra come utilizzarecreate-host.

AWS CLI

Per creare un host

L'create-hostesempio seguente mostra come creare un host che rappresenti l'endpoint per l'infrastruttura in cui è installato il provider di terze parti. Questo esempio crea un host in cui il provider installato da terze parti è GitHub Enterprise Server.

Per impostazione predefinita, un host creato tramite la AWS CLI è in sospeso. Dopo aver creato un host con la CLI, utilizza la console o la CLI per configurare l'host in modo che ne renda lo stato Disponibile.

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

Output:

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

Per ulteriori informazioni, consulta Creare un host (CLI) nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta CreateHost AWS CLICommand Reference.

delete-connection

Il seguente esempio di codice mostra come utilizzaredelete-connection.

AWS CLI

Per eliminare una connessione

L'delete-connectionesempio seguente mostra come eliminare una connessione.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Eliminare una connessione (CLI) nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta DeleteConnection AWS CLICommand Reference.

delete-host

Il seguente esempio di codice mostra come utilizzaredelete-host.

AWS CLI

Per eliminare un host

L'delete-hostesempio seguente mostra come eliminare un host. Per eliminare un host, è necessario eliminare tutte le connessioni associate all'host.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Eliminare un host (CLI) nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta DeleteHost AWS CLICommand Reference.

get-connection

Il seguente esempio di codice mostra come utilizzareget-connection.

AWS CLI

Per ottenere informazioni su una connessione

L'get-connectionesempio seguente mostra i dettagli su una connessione.

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

Output:

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

Per ulteriori informazioni, consulta Visualizza i dettagli della connessione nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta GetConnection AWS CLICommand Reference.

get-host

Il seguente esempio di codice mostra come utilizzareget-host.

AWS CLI

Per ottenere informazioni su un host

L'get-hostesempio seguente mostra i dettagli su un host:

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

Output:

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

Per ulteriori informazioni, consulta Visualizza i dettagli dell'host (CLI) nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta GetHost AWS CLICommand Reference.

list-connections

Il seguente esempio di codice mostra come utilizzarelist-connections.

AWS CLI

Per elencare le connessioni

L'list-connectionsesempio seguente recupera un elenco di tutte le connessioni nel tuo account per il tipo di provider Bitbucket. :

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

Output:

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

Per ulteriori informazioni, consulta List connections (CLI) nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta ListConnections AWS CLICommand Reference.

list-hosts

Il seguente esempio di codice mostra come utilizzarelist-hosts.

AWS CLI

Per elencare gli host

L'list-hostsesempio seguente recupera un elenco di tutti gli host del tuo account.

aws codestar-connections list-hosts

Output:

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

Per ulteriori informazioni, consulta List hosts (CLI) nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta ListHosts AWS CLICommand Reference.

list-tags-for-resource

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Per elencare i tag

L'list-tags-for-resourceesempio seguente recupera un elenco di tutti i tag allegati alla risorsa di connessione specificata.

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

Output:

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

Per ulteriori informazioni, consulta Visualizza i tag per una risorsa di connessioni nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta ListTagsForResource AWS CLICommand Reference.

tag-resource

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

Per etichettare una risorsa

L'tag-resourceesempio seguente associa un set di tag forniti a una connessione. Utilizzate questo comando per aggiungere o modificare i tag.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Aggiungere tag a una risorsa di connessioni nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta TagResource AWS CLICommand Reference.

untag-resource

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Per rimuovere i AWS tag da una risorsa di connessione

Quanto segue untag-resource rimuove un tag dalla risorsa specificata.

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

Output:

{
    "Tags": []
}

Per ulteriori informazioni, consulta Rimuovere tag da una risorsa di connessioni nella Guida per l'utente della console Developer Tools.

• Per i dettagli sull'API, consulta UntagResource AWS CLICommand Reference.