Esempi per CodeConnections con AWS CLI
Gli esempi di codice seguenti mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface con 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 link al codice sorgente completo, dove è possibile trovare le istruzioni su come configurare ed eseguire il codice nel contesto.
Argomenti
Operazioni
L’esempio di codice seguente mostra come utilizzare create-connection.
- AWS CLI
-
Per creare una connessione
L’esempio
create-connectionseguente mostra come creare una connessione a un repository di terze parti. Questo esempio crea una connessione in cui il provider di terze parti è Bitbucket.Per impostazione predefinita una connessione creata tramite AWS CLI o AWS CloudFormation si trova nello stato In sospeso. Dopo aver creato una connessione con la CLI o AWS CloudFormation, utilizzare la console per modificare la connessione e impostarne lo stato su Disponibile.
aws codestar-connections create-connection \ --provider-typeBitbucket\ --connection-nameMyConnectionOutput:
{ "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f" }Per ulteriori informazioni, consulta Creazione di una connessione nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per informazioni dettagliate sull’API, consulta CreateConnection
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare create-host.
- AWS CLI
-
Per creare un host
L’esempio
create-hostseguente mostra come creare un host per rappresentare l’endpoint per l’infrastruttura in cui è installato il provider di terze parti. Questo esempio crea un host in cui il provider di terze parti installato è GitHub Enterprise Server.Per impostazione predefinita, un host creato tramite la CLI di AWS si trova nello stato In sospeso. Dopo aver creato un host con la CLI, utilizza la console o la CLI per configurare l’host e impostarne lo stato su Disponibile.
aws codestar-connections create-host \ --nameMyHost\ --provider-typeGitHubEnterpriseServer\ --provider-endpoint"https://my-instance.dev"Output:
{ "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605" }Per ulteriori informazioni, consulta Create a host (CLI) nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per informazioni dettagliate sull’API, consulta CreateHost
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare delete-connection.
- AWS CLI
-
Per eliminare una connessione
L’esempio
delete-connectionseguente mostra come eliminare una connessione.aws codestar-connections delete-connection \ --connection-arnarn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441fQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Delete a connection (CLI) nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per informazioni dettagliate sull’API, consulta DeleteConnection
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare delete-host.
- AWS CLI
-
Per eliminare un host
L’esempio
delete-hostseguente 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 Strumenti per sviluppatori.
-
Per informazioni dettagliate sull’API, consulta DeleteHost
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare get-connection.
- AWS CLI
-
Come ottenere informazioni su una connessione
L’esempio
get-connectionseguente mostra i dettagli di una connessione.aws codestar-connections get-connection \ --connection-arnarn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441fOutput:
{ "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 di connessione nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per informazioni dettagliate sull’API, consulta GetConnection
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare get-host.
- AWS CLI
-
Come ottenere informazioni su un host
L’esempio
get-hostseguente mostra i dettagli di un host.aws codestar-connections get-host \ --host-arnarn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605Output:
{ "Name": "MyHost", "Status": "AVAILABLE", "ProviderType": "GitHubEnterpriseServer", "ProviderEndpoint": "https://test-instance-1.dev/" }Per ulteriori informazioni, consulta View host details (CLI) nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per informazioni dettagliate sull’API, consulta GetHost
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-connections.
- AWS CLI
-
Per elencare le connessioni
L’esempio
list-connectionsseguente recupera un elenco di tutte le connessioni nell’account per il tipo di provider Bitbucket.aws codestar-connections list-connections \ --provider-typeBitbucket\ --max-results5\ --next-token: next-tokenOutput:
{ "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 Elenco delle connessioni (CLI) nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per informazioni dettagliate sull’API, consulta ListConnections
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-hosts.
- AWS CLI
-
Come elencare gli host
Nell’esempio seguente
list-hostsrecupera un elenco di tutti i gruppi di host nell’account.aws codestar-connections list-hostsOutput:
{ "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 Elenca gli host (CLI) nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per informazioni dettagliate sull’API, consulta ListHosts
in AWS CLI Command Reference.
-
L’esempio di codice seguente mostra come utilizzare list-tags-for-resource.
- AWS CLI
-
Per elencare i tag
L’esempio
list-tags-for-resourceseguente recupera un elenco di tutti i tag associati alla risorsa di connessione specificata.aws codestar-connections list-tags-for-resource \ --resource-arnarn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441fOutput:
{ "Tags": [ { "Key": "Project", "Value": "ProjectA" }, { "Key": "ReadOnly", "Value": "true" } ] }Per ulteriori informazioni, consulta Visualizzazione dei tag per una risorsa di connessione nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per informazioni dettagliate sull'API, consulta ListTagsForResource
nella Documentazione di riferimento dei comandi della AWS CLI.
-
L’esempio di codice seguente mostra come utilizzare tag-resource.
- AWS CLI
-
Come aggiungere un tag a una risorsa
L’esempio
tag-resourceseguente associa un set di tag forniti a una connessione. Utilizza questo comando per aggiungere o modificare tag.aws codestar-connections tag-resource \ --resource-arnarn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f\ --tagsKey=Project,Value=ProjectAKey=IscontainerBased,Value=trueQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Aggiunta dei tag a una risorsa di connessione nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per informazioni dettagliate sulle API, consulta TagResource
nel Riferimento ai comandi AWS CLI.
-
L’esempio di codice seguente mostra come utilizzare untag-resource.
- AWS CLI
-
Come rimuovere i tag AWS da una risorsa di connessione
Nell’esempio seguente
untag-resourcerimuove un tag dalla risorsa specificata.aws codestar-connections untag-resource \ --resource-arnarn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f\ --tag-keysProjectReadOnlyOutput:
{ "Tags": [] }Per ulteriori informazioni, consulta Rimozione dei tag da una risorsa di connessione nella Guida per l’utente della console Strumenti per sviluppatori.
-
Per i dettagli dell'API, consulta UntagResource
in Riferimento ai comandi della AWS CLI.
-