Exemples d’utilisation de l’AWS CLI avec CodeConnections

Pour créer une connexion

L’exemple create-connection 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 l’AWS CLI ou AWS CloudFormation a le statut En attente par défaut. Après avoir créé une connexion avec l’interface de ligne de commande ou AWS CloudFormation, utilisez la console pour modifier la connexion et définir son statut sur 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 Création d’une connexion dans le Guide de l’utilisateur de la console Outils pour développeurs.

Pour créer un hôte

L’exemple create-host 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 l’AWS CLI a le statut 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 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 Créer un hôte (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.

Pour supprimer une connexion

L’exemple delete-connection 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 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 supprimer un hôte

L’exemple delete-host suivant 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 obtenir les informations sur une connexion

L’exemple get-connection suivant montre les informations sur 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, consultez Affichage des informations de connexion dans le Guide de l’utilisateur de la console Outils pour développeurs.

Pour obtenir les informations sur un hôte

L’exemple get-host suivant montre les informations sur 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, consultez Afficher les détails de l’hôte (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.

Pour répertorier les connexions

L’exemple list-connections suivant récupère 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 Affichage de la liste des connexions (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.

Pour répertorier les hôtes

L’exemple list-hosts suivant récupère une 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 Répertorier les hôtes (CLI) dans le Guide de l’utilisateur de la console Outils pour développeurs.

Pour afficher la liste des balises

L’exemple list-tags-for-resource suivant récupère une liste de toutes les balises associées à la ressource de connexion 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, consultez Affichage des balises d’une ressource de connexions dans le Guide de l’utilisateur de la console Outils pour développeurs.

Pour baliser une ressource

L’exemple tag-resource 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 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 supprimer des balises AWS d’une ressource de connexions

L’exemple untag-resource suivant 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, consultez Suppression des balises d’une ressource de connexions dans le Guide de l’utilisateur de la console Outils pour développeurs.