CodeConnections ejemplos que utilizan AWS CLI - AWS Command Line Interface

Esta documentación es AWS CLI únicamente para la versión 1 de la versión. Para ver la documentación relacionada con la versión 2 de AWS CLI, consulte la Guía del usuario de la versión 2.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CodeConnections ejemplos que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso del AWS Command Line Interface with CodeConnections.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

En el siguiente ejemplo de código se muestra cómo usarlocreate-connection.

AWS CLI

Para crear una conexión

El siguiente create-connection ejemplo muestra cómo crear una conexión a un repositorio de terceros. En este ejemplo, se crea una conexión en la que el proveedor externo es Bitbucket.

Una conexión creada a través de AWS CLI o AWS CloudFormation está en estado Pendiente de forma predeterminada. Tras crear una conexión con el CLI o AWS CloudFormation, utilice la consola para editar la conexión y hacer que su estado sea Disponible.

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

Salida:

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

Para obtener más información, consulte Crear una conexión en la Guía del usuario de la consola Developer Tools.

  • Para API obtener más información, consulte CreateConnectionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlocreate-host.

AWS CLI

Para crear un host

En el siguiente create-host ejemplo, se muestra cómo crear un host que represente el punto final de la infraestructura en la que está instalado el proveedor externo. En este ejemplo, se crea un host en el que el proveedor externo instalado es GitHub Enterprise Server.

Un host creado mediante el AWS CLI está en estado Pendiente de forma predeterminada. Después de crear un host con elCLI, utilice la consola o el CLI para configurar el host y hacer que su estado sea Disponible.

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

Salida:

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

Para obtener más información, consulte Crear un host (CLI) en la Guía del usuario de la consola Developer Tools.

  • Para API obtener más información, consulte CreateHostla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlodelete-connection.

AWS CLI

Para eliminar una conexión

En el siguiente delete-connection ejemplo, se muestra cómo eliminar una conexión.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Eliminar una conexión (CLI) en la Guía del usuario de la consola de Developer Tools.

  • Para API obtener más información, consulte DeleteConnectionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlodelete-host.

AWS CLI

Para eliminar un host

En el siguiente delete-host ejemplo, se muestra cómo eliminar un host. Para poder eliminar un alojamiento, debe eliminar todas las conexiones asociadas al alojamiento.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Eliminar un host (CLI) en la Guía del usuario de la consola Developer Tools.

  • Para API obtener más información, consulte DeleteHostla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloget-connection.

AWS CLI

Para obtener información sobre una conexión

En el siguiente get-connection ejemplo, se muestran detalles sobre una conexión.

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

Salida:

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

Para obtener más información, consulte Ver los detalles de la conexión en la Guía del usuario de la consola Developer Tools.

  • Para API obtener más información, consulte GetConnectionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarloget-host.

AWS CLI

Para obtener información sobre un anfitrión

En el siguiente get-host ejemplo, se muestran detalles sobre un anfitrión:

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

Salida:

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

Para obtener más información, consulte Ver los detalles del host (CLI) en la Guía del usuario de la consola Developer Tools.

  • Para API obtener más información, consulte GetHostla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlolist-connections.

AWS CLI

Para enumerar las conexiones

En el siguiente list-connections ejemplo, se recupera una lista de todas las conexiones de tu cuenta para el tipo de proveedor de Bitbucket. :

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

Salida:

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

Para obtener más información, consulte Listar conexiones (CLI) en la Guía del usuario de la consola Developer Tools.

  • Para API obtener más información, consulte ListConnectionsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlolist-hosts.

AWS CLI

Para enumerar los hosts

En el siguiente list-hosts ejemplo, se recupera una lista de todos los hosts de su cuenta.

aws codestar-connections list-hosts

Salida:

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

Para obtener más información, consulte List hosts (CLI) en la Guía del usuario de la consola Developer Tools.

  • Para API obtener más información, consulte ListHostsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlolist-tags-for-resource.

AWS CLI

Para enumerar etiquetas

En el siguiente list-tags-for-resource ejemplo, se recupera una lista de todas las etiquetas adjuntas al recurso de conexiones especificado.

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

Salida:

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

Para obtener más información, consulte Ver las etiquetas de un recurso de conexiones en la Guía del usuario de la consola Developer Tools.

  • Para API obtener más información, consulte ListTagsForResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlotag-resource.

AWS CLI

Para etiquetar un recurso

El siguiente tag-resource ejemplo asocia un conjunto de etiquetas proporcionadas a una conexión. Utilice este comando para añadir o editar etiquetas.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Añadir etiquetas a un recurso de conexiones en la Guía del usuario de la consola de Developer Tools.

  • Para API obtener más información, consulte TagResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usarlountag-resource.

AWS CLI

Para eliminar AWS etiquetas de un recurso de conexiones

Lo siguiente untag-resource elimina una etiqueta del recurso especificado.

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

Salida:

{ "Tags": [] }

Para obtener más información, consulte Eliminar etiquetas de un recurso de conexiones en la Guía del usuario de la consola de Developer Tools.

  • Para API obtener más información, consulte UntagResourcela Referencia de AWS CLI comandos.