Cette documentation concerne AWS CLI uniquement la version 1. Pour la documentation relative à la version 2 du AWS CLI, consultez le guide de l'utilisateur de la version 2.
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
CodeConnections exemples utilisant AWS CLI
Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du AWS Command Line Interface with CodeConnections.
Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.
Rubriques
Actions
L'exemple de code suivant montre comment utilisercreate-connection.
- AWS CLI
-
Pour créer une connexion
L’exemple
create-connectionsuivant montre comment créer une connexion à un référentiel tiers. Cet exemple crée une connexion dont le fournisseur tiers est Bitbucket.Une connexion créée via la AWS CLI ou dont le statut AWS CloudFormation est En attente par défaut. Après avoir créé une connexion avec la CLI AWS CloudFormation, utilisez la console pour modifier la connexion afin de rendre son statut disponible.
aws codestar-connections create-connection \ --provider-typeBitbucket\ --connection-nameMyConnectionSortie :
{ "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f" }Pour plus d’informations, consultez Création d’une connexion dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous CreateConnection
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-host.
- AWS CLI
-
Pour créer un hôte
L’exemple
create-hostsuivant montre comment créer un hôte pour représenter le point de terminaison de l’infrastructure sur laquelle votre fournisseur tiers est installé. Cet exemple crée un hôte sur lequel le fournisseur tiers installé est GitHub Enterprise Server.Un hôte créé via la AWS CLI est en attente par défaut. Après avoir créé un hôte avec la CLI, utilisez la console ou la CLI pour configurer l’hôte et définir son statut sur Available.
aws codestar-connections create-host \ --nameMyHost\ --provider-typeGitHubEnterpriseServer\ --provider-endpoint"https://my-instance.dev"Sortie :
{ "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605" }Pour plus d’informations, consultez Créer un hôte (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous CreateHost
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-connection.
- AWS CLI
-
Pour supprimer une connexion
L’exemple
delete-connectionsuivant montre comment supprimer une connexion.aws codestar-connections delete-connection \ --connection-arnarn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441fCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Suppression d’une connexion (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous DeleteConnection
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-host.
- AWS CLI
-
Pour supprimer un hôte
L’exemple
delete-hostsuivant illustre la suppression d’un hôte. Avant de pouvoir supprimer un hôte, vous devez supprimer toutes les connexions associées à l’hôte.aws codestar-connections delete-host \ --host-arn"arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605"Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Supprimer un hôte (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous DeleteHost
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-connection.
- AWS CLI
-
Pour obtenir les informations sur une connexion
L’exemple
get-connectionsuivant montre des informations sur une connexion.aws codestar-connections get-connection \ --connection-arnarn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441fSortie :
{ "Connection": { "ConnectionName": "MyConnection", "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f", "ProviderType": "Bitbucket", "OwnerAccountId": "123456789012", "ConnectionStatus": "AVAILABLE" } }Pour plus d’informations, consultez Affichage des informations de connexion dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous GetConnection
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-host.
- AWS CLI
-
Pour obtenir des informations sur un hôte
L’exemple
get-hostsuivant montre des informations sur un hôte.aws codestar-connections get-host \ --host-arnarn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605Sortie :
{ "Name": "MyHost", "Status": "AVAILABLE", "ProviderType": "GitHubEnterpriseServer", "ProviderEndpoint": "https://test-instance-1.dev/" }Pour plus d’informations, consultez Supprimer un hôte (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous GetHost
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-connections.
- AWS CLI
-
Pour répertorier les connexions
L’exemple
list-connectionssuivant extrait une liste de toutes les connexions de votre compte pour le type de fournisseur Bitbucket :aws codestar-connections list-connections \ --provider-typeBitbucket\ --max-results5\ --next-token: next-tokenSortie :
{ "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" }Pour plus d’informations, consultez Affichage de la liste des connexions (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous ListConnections
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-hosts.
- AWS CLI
-
Pour répertorier les hôtes
L’exemple
list-hostssuivant extrait une liste de tous les hôtes de votre compte.aws codestar-connections list-hostsSortie :
{ "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" } ] }Pour plus d’informations, consultez Répertorier les hôtes (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous ListHosts
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-tags-for-resource.
- AWS CLI
-
Pour répertorier des balises
L’exemple
list-tags-for-resourcesuivant extrait une liste de toutes les balises associées à la ressource de connexion spécifiée.aws codestar-connections list-tags-for-resource \ --resource-arnarn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441fSortie :
{ "Tags": [ { "Key": "Project", "Value": "ProjectA" }, { "Key": "ReadOnly", "Value": "true" } ] }Pour plus d’informations, consultez Affichage des balises d’une ressource de connexions dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous ListTagsForResource
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisertag-resource.
- AWS CLI
-
Pour baliser une ressource
L’exemple
tag-resourcesuivant associe un ensemble de balises fournies à une connexion. Utilisez cette commande pour ajouter ou modifier des balises.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=trueCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Ajout de balises à une ressource de connexions dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous TagResource
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseruntag-resource.
- AWS CLI
-
Pour supprimer des AWS balises d'une ressource de connexion
untag-resourceci-dessous supprime une balise de la ressource spécifiée.aws codestar-connections untag-resource \ --resource-arnarn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f\ --tag-keysProjectReadOnlySortie :
{ "Tags": [] }Pour plus d’informations, consultez Suppression des balises d’une ressource de connexions dans le Guide de l’utilisateur de la console Outils pour développeurs.
-
Pour plus de détails sur l'API, reportez-vous UntagResource
à la section Référence des AWS CLI commandes.
-