CodeConnections ejemplos que utilizan AWS CLI

PDF

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 distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

Acciones

create-connection

En el siguiente ejemplo de código, se muestra cómo utilizar create-connection.

AWS CLI

Creación de una conexión

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

Una conexión creada a través de la AWS CLI o AWS CloudFormation que está en estado pendiente de forma predeterminada. Después de crear una conexión con la CLI o AWS CloudFormation, utilice la consola para editar la conexión y hacer que su estado esté 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 Create a connection en la Guía del usuario de la consola de herramientas del desarrollador.

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

create-connection

En el siguiente ejemplo de código, se muestra cómo utilizar create-connection.

AWS CLI

Creación de una conexión

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

Una conexión creada a través de la AWS CLI o AWS CloudFormation que está en estado pendiente de forma predeterminada. Después de crear una conexión con la CLI o AWS CloudFormation, utilice la consola para editar la conexión y hacer que su estado esté 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 Create a connection en la Guía del usuario de la consola de herramientas del desarrollador.

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

create-host

En el siguiente ejemplo de código, se muestra cómo utilizar create-host.

AWS CLI

Creación de un host

En el siguiente ejemplo de create-host, se muestra cómo crear un host para representar el punto de conexión de la infraestructura donde 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 la AWS CLI está en estado Pendiente de forma predeterminada. Después de crear un host con la CLI, utilice la consola o la CLI para configurar el host de manera que su estado cambie a 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 Create a host (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

create-host

En el siguiente ejemplo de código, se muestra cómo utilizar create-host.

AWS CLI

Creación de un host

En el siguiente ejemplo de create-host, se muestra cómo crear un host para representar el punto de conexión de la infraestructura donde 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 la AWS CLI está en estado Pendiente de forma predeterminada. Después de crear un host con la CLI, utilice la consola o la CLI para configurar el host de manera que su estado cambie a 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 Create a host (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

delete-connection

En el siguiente ejemplo de código, se muestra cómo utilizar delete-connection.

AWS CLI

Para eliminar una conexión

En el siguiente ejemplo de delete-connection, 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 Delete a connection (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

delete-connection

En el siguiente ejemplo de código, se muestra cómo utilizar delete-connection.

AWS CLI

Para eliminar una conexión

En el siguiente ejemplo de delete-connection, 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 Delete a connection (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

delete-host

En el siguiente ejemplo de código, se muestra cómo utilizar delete-host.

AWS CLI

Eliminación de un host

En el ejemplo siguiente de delete-host, se muestra cómo se elimina 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 Delete a host (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

delete-host

En el siguiente ejemplo de código, se muestra cómo utilizar delete-host.

AWS CLI

Eliminación de un host

En el ejemplo siguiente de delete-host, se muestra cómo se elimina 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 Delete a host (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

get-connection

En el siguiente ejemplo de código, se muestra cómo utilizar get-connection.

AWS CLI

Obtención de información sobre una conexión

En el siguiente ejemplo de get-connection, se muestra información 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 View connection details en la Guía del usuario de la consola de herramientas del desarrollador.

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

get-connection

En el siguiente ejemplo de código, se muestra cómo utilizar get-connection.

AWS CLI

Obtención de información sobre una conexión

En el siguiente ejemplo de get-connection, se muestra información 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 View connection details en la Guía del usuario de la consola de herramientas del desarrollador.

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

get-host

En el siguiente ejemplo de código, se muestra cómo utilizar get-host.

AWS CLI

Obtención de información acerca de un host

En el siguiente ejemplo de get-host, se muestra información sobre un host:

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 View host details (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

get-host

En el siguiente ejemplo de código, se muestra cómo utilizar get-host.

AWS CLI

Obtención de información acerca de un host

En el siguiente ejemplo de get-host, se muestra información sobre un host:

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 View host details (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

list-connections

En el siguiente ejemplo de código, se muestra cómo utilizar list-connections.

AWS CLI

Para enumerar las conexiones

En el siguiente ejemplo de list-connections, se recupera una lista de todas las conexiones de su 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 List connections (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

list-connections

En el siguiente ejemplo de código, se muestra cómo utilizar list-connections.

AWS CLI

Para enumerar las conexiones

En el siguiente ejemplo de list-connections, se recupera una lista de todas las conexiones de su 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 List connections (CLI) en la Guía del usuario de la consola de herramientas del desarrollador.

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

list-hosts

En el siguiente ejemplo de código, se muestra cómo utilizar list-hosts.

AWS CLI

Para enumerar los hosts

En el siguiente ejemplo de list-hosts, se obtiene 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 de herramientas del desarrollador.

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

list-hosts

En el siguiente ejemplo de código, se muestra cómo utilizar list-hosts.

AWS CLI

Para enumerar los hosts

En el siguiente ejemplo de list-hosts, se obtiene 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 de herramientas del desarrollador.

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

list-tags-for-resource

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

AWS CLI

Para enumerar etiquetas

En el siguiente ejemplo de list-tags-for-resource, 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 View tags for a connections resource en la Guía del usuario de la consola de herramientas del desarrollador.

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

list-tags-for-resource

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

AWS CLI

Para enumerar etiquetas

En el siguiente ejemplo de list-tags-for-resource, 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 View tags for a connections resource en la Guía del usuario de la consola de herramientas del desarrollador.

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

tag-resource

En el siguiente ejemplo de código, se muestra cómo utilizar tag-resource.

AWS CLI

Para etiquetar un recurso

En el siguiente ejemplo de tag-resource, se asocia un conjunto de etiquetas proporcionadas a una conexión. Use 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 Add tags to a connections resource en la Guía del usuario de la consola de herramientas del desarrollador.

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

tag-resource

En el siguiente ejemplo de código, se muestra cómo utilizar tag-resource.

AWS CLI

Para etiquetar un recurso

En el siguiente ejemplo de tag-resource, se asocia un conjunto de etiquetas proporcionadas a una conexión. Use 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 Add tags to a connections resource en la Guía del usuario de la consola de herramientas del desarrollador.

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

untag-resource

En el siguiente ejemplo de código, se muestra cómo utilizar untag-resource.

AWS CLI

Para eliminar AWS etiquetas de un recurso de conexiones

En el siguiente ejemplo de untag-resource, se elimina una etiqueta de un 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 Remove tags from a connections resource en la Guía del usuario de la consola de herramientas del desarrollador.

• Para obtener detalles sobre la API, consulte UntagResourcela Referencia de AWS CLI comandos.

untag-resource

En el siguiente ejemplo de código, se muestra cómo utilizar untag-resource.

AWS CLI

Para eliminar AWS etiquetas de un recurso de conexiones

En el siguiente ejemplo de untag-resource, se elimina una etiqueta de un 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 Remove tags from a connections resource en la Guía del usuario de la consola de herramientas del desarrollador.

• Para obtener detalles sobre la API, consulte UntagResourcela Referencia de AWS CLI comandos.