CodeConnections exemples utilisant AWS CLI - AWS Exemples de code SDK
Actions

D'autres exemples de AWS SDK sont disponibles dans le référentiel AWS Doc SDK Examples GitHub .

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 façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utilisercreate-connection.

AWS CLI

Pour créer une connexion

L'create-connectionexemple suivant 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-type Bitbucket \
    --connection-name MyConnection

Sortie :

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

Pour plus d'informations, consultez la section Création d'une connexion dans le guide de l'utilisateur de la console Developer Tools.

  • 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'create-hostexemple suivant 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 à l'aide de la CLI, utilisez la console ou l'interface de ligne de commande pour configurer l'hôte afin qu'il rende son statut disponible.

aws codestar-connections create-host \
    --name MyHost \
    --provider-type GitHubEnterpriseServer \
    --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 la section Créer un hôte (CLI) dans le guide de l'utilisateur de la console Developer Tools.

  • 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'delete-connectionexemple suivant montre comment supprimer une connexion.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, voir Supprimer une connexion (CLI) dans le guide de l'utilisateur de la console Developer Tools.

  • 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'delete-hostexemple suivant montre comment supprimer 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 aucun résultat.

Pour plus d'informations, voir Supprimer un hôte (CLI) dans le guide de l'utilisateur de la console Developer Tools.

  • 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 des informations sur une connexion

L'get-connectionexemple suivant montre les détails d'une connexion.

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

Sortie :

{
    "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, voir Afficher les détails de connexion dans le guide de l'utilisateur de la console Developer Tools.

  • 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'get-hostexemple suivant montre les détails d'un hôte :

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

Sortie :

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

Pour plus d'informations, voir Afficher les détails de l'hôte (CLI) dans le guide de l'utilisateur de la console Developer Tools.

  • 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'list-connectionsexemple suivant extrait une liste de toutes les connexions de votre compte pour le type de fournisseur Bitbucket. :

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

Sortie :

{
    "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 la section Lister les connexions (CLI) dans le guide de l'utilisateur de la console Developer Tools.

  • 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'list-hostsexemple suivant permet de récupérer la liste de tous les hôtes de votre compte.

aws codestar-connections list-hosts

Sortie :

{
    "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 la section List hosts (CLI) dans le guide de l'utilisateur de la console Developer Tools.

  • 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 les tags

L'list-tags-for-resourceexemple suivant extrait une liste de toutes les balises associées à la ressource de connexions spécifiée.

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

Sortie :

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

Pour plus d'informations, voir Afficher les balises d'une ressource de connexion dans le guide de l'utilisateur de la console Developer Tools.

  • 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 étiqueter une ressource

L'tag-resourceexemple suivant associe un ensemble de balises fournies à une connexion. Utilisez cette commande pour ajouter ou modifier des balises.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, voir Ajouter des balises à une ressource de connexion dans le Guide de l'utilisateur de la console Developer Tools.

  • 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

Ce qui suit untag-resource supprime une balise de la ressource spécifiée.

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

Sortie :

{
    "Tags": []
}

Pour plus d'informations, voir Supprimer les balises d'une ressource de connexion dans le Guide de l'utilisateur de la console Developer Tools.

  • Pour plus de détails sur l'API, reportez-vous UntagResourceà la section Référence des AWS CLI commandes.