Declaración de canalización

La canalización y el nivel de metadatos de una canalización tienen una estructura básica que incluye los siguientes parámetros y sintaxis. El parámetro de canalización representa la estructura de las acciones y etapas que se van a realizar en la canalización.

Para obtener más información, consulte el PipelineDeclarationobjeto en la CodePipeline APIGuía.

El siguiente ejemplo muestra la canalización y el nivel de metadatos de la estructura de canalización en JSON y YAML para una canalización de tipo V2.

YAML

pipeline:
  name: MyPipeline
  roleArn: >-
    arn:aws:iam::ACCOUNT_ID:role/service-role/AWSCodePipelineServiceRole-us-west-2-MyPipeline
  artifactStore:
    type: S3
    location: amzn-s3-demo-bucket
  stages:
    ...
  version: 6
  executionMode: SUPERSEDED
  pipelineType: V2
  variables:
  - name: MyVariable
    defaultValue: '1'
  triggers:
  - providerType: CodeStarSourceConnection
    gitConfiguration:
      sourceActionName: Source
      push:
      - branches:
          includes:
          - main
          excludes:
          - feature-branch
      pullRequest:
      - events:
        - CLOSED
        branches:
          includes:
          - main*
metadata:
  pipelineArn: 'arn:aws:codepipeline:us-west-2:ACCOUNT_ID:MyPipeline'
  created: '2019-12-12T06:49:02.733000+00:00'
  updated: '2020-09-10T06:34:07.447000+00:00'

JSON

{
    "pipeline": {
        "name": "MyPipeline",
        "roleArn": "arn:aws:iam::ACCOUNT_ID:role/service-role/AWSCodePipelineServiceRole-us-west-2-MyPipeline",
        "artifactStore": {
            "type": "S3",
            "location": "amzn-s3-demo-bucket"
        },
        "stages": {
            ...   
    },
        "version": 6,
        "executionMode": "SUPERSEDED",
                "pipelineType": "V2",
        "variables": [
            {
                "name": "MyVariable",
                "defaultValue": "1"
            }
        ],
        "triggers": [
            {
                "providerType": "CodeStarSourceConnection",
                "gitConfiguration": {
                    "sourceActionName": "Source",
                    "push": [
                        {
                            "branches": {
                                "includes": [
                                    "main"
                                ],
                                "excludes": [
                                    "feature-branch"
                                ]
                            }
                        }
                    ],
                    "pullRequest": [
                        {
                            "events": [
                                "CLOSED"
                            ],
                            "branches": {
                                "includes": [
                                    "main*"
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    },
    "metadata": {
        "pipelineArn": "arn:aws:codepipeline:us-west-2:ACCOUNT_ID:MyPipeline",
        "created": "2019-12-12T06:49:02.733000+00:00",
        "updated": "2020-09-10T06:34:07.447000+00:00"
    }
}

name

El nombre de la canalización. El nombre de una canalización no se puede modificar al editarla o actualizarla.

nota

Si quieres cambiar el nombre de una canalización existente, puedes usar el CLI get-pipeline comando para crear un JSON archivo que contenga la estructura de la canalización. A continuación, puedes usar el CLI create-pipeline comando para crear una canalización con esa estructura y darle un nuevo nombre.

roleArn

El IAM ARN para el rol de CodePipeline servicio, como arn:aws:iam: :80398:role/ _Service_Role. EXAMPLE CodePipeline

Para usar la consola para ver el rol del servicio de canalización en ARN lugar de la estructura, elige tu canalización en la consola y, a continuación, selecciona ConfiguraciónJSON. En la pestaña General, aparece el ARN campo Función de servicio.

artifactStore O artifactStores

El artifactStore campo contiene el tipo de depósito de artefactos y la ubicación de una canalización con todas las acciones en la misma AWS región. Si añades acciones en una región diferente a la de tu proceso, el artifactStores mapeo se utiliza para mostrar el depósito de artefactos de cada AWS región en la que se ejecutan las acciones. Al crear o editar una canalización, debe tener un bucket de artefactos en la región de la canalización, así como un bucket de artefactos por cada región en la que tiene previsto ejecutar una acción.

nota

En la estructura de canalización, debes incluir una artifactStore o varias artifactStores en tu canalización, pero no puedes usar ambas. Si crea una acción entre regiones en la canalización, debe utilizar artifactStores.

En el siguiente ejemplo, se muestra la estructura básica de una canalización con acciones entre regiones que utiliza el parámetro artifactStores:

    "pipeline": {
        "name": "YourPipelineName",
        "roleArn": "CodePipeline_Service_Role",
        "artifactStores": {
            "us-east-1": {
                "type": "S3",
                "location": "S3 artifact bucket name, such as amzn-s3-demo-bucket"
            },
            "us-west-2": {
                "type": "S3",
                "location": "S3 artifact bucket name, such as amzn-s3-demo-bucket"
            }
        },
        "stages": [
            {

...

type

El tipo de ubicación del depósito de artefactos, especificado como Amazon S3.

location

El nombre del bucket de Amazon S3 que se generó automáticamente la primera vez que creó una canalización con la consola, como codepipeline-us-east -2-1234567890, o cualquier bucket de Amazon S3 que aprovisione para este fin

stages

Este parámetro contiene el nombre de cada etapa de la canalización. Para obtener más información sobre los parámetros y la sintaxis a nivel de fase de la estructura de la canalización, consulte el StageDeclarationobjeto en la CodePipeline APIGuía.

La estructura de canalización de las etapas tiene los siguientes requisitos:

• La canalización debe tener dos etapas como mínimo.

• La primera fase de una canalización debe incluir al menos una acción de origen. Solo puede incluir acciones de origen.

• La primera etapa de la canalización es la única que puede incluir acciones de origen.

• Al menos una etapa de cada canalización debe contener una acción que no sea de origen.

• Los nombres de las etapas de una canalización deben ser diferentes.

• Los nombres de las etapas no se pueden editar en la CodePipeline consola. Si edita el nombre de una etapa con AWS CLI, y la etapa contiene una acción con uno o más parámetros secretos (como un OAuth token), el valor de esos parámetros secretos no se conserva. Debe introducir manualmente el valor de los parámetros (que aparecen enmascarados por cuatro asteriscos en los valores JSON devueltos por el AWS CLI) e incluirlos en la estructura. JSON

version

El número de versión de una canalización se genera automáticamente y se actualiza cada vez que se actualiza la canalización.

executionMode

Puede configurar el modo de ejecución de la canalización para poder especificar el comportamiento de la canalización para ejecuciones consecutivas, como poner en cola, reemplazar o ejecutar en modo paralelo. Para obtener más información, consulte Establecer o cambiar el modo de ejecución de la canalización.

pipelineType

El tipo de canalización especifica la estructura y las características disponibles en la canalización, por ejemplo, en una canalización de tipo V2. Para obtener más información, consulte Tipos de canalización.

variables

Las variables a nivel de canalización se definen cuando la canalización se crea y se resuelven en el tiempo de ejecución de la canalización. Para obtener más información, consulte Referencia de variables. Para ver un tutorial con una variable a nivel de canalización que se transfiere en el momento de la ejecución de la canalización, consulte Tutorial: Uso de variables a nivel de canalización.

triggers

Los activadores te permiten configurar tu canalización para que comience con un tipo de evento concreto o con un tipo de evento filtrado, por ejemplo, cuando se detecta un cambio en una rama o solicitud de extracción en particular. Los activadores se pueden configurar para las acciones de origen con conexiones en las que se utiliza la CodeStarSourceConnection acción CodePipeline GitHub, como Bitbucket y GitLab. Para obtener más información sobre las acciones de origen que utilizan conexiones, consulteConéctese a proveedores de fuentes de terceros mediante CodeConnections.

Para obtener más información, consulte Automatice el inicio de las canalizaciones mediante activadores y filtros.

nota

Las acciones de origen CodeCommit y las de S3 requieren un recurso de detección de cambios configurado (una EventBridge regla) o utilizan la opción de sondear el repositorio en busca de cambios de origen. En el caso de las canalizaciones con una acción fuente de Bitbucket o GitHub Enterprise Server, no es necesario configurar un webhook ni utilizar el sondeo de forma predeterminada. GitHub La acción de conexiones administra la detección de cambios por usted.

metadata

Los campos de metadatos de la canalización son distintos de la estructura de la canalización y no se pueden editar. Al actualizar una canalización, la fecha del campo de metadatos updated cambia automáticamente.

pipelineArn

El nombre del recurso de Amazon (ARN) de la canalización.

Para usar la consola para ver la canalización ARN en lugar de la JSON estructura, elige la canalización en la consola y, a continuación, selecciona Configuración. En la pestaña General, aparece el ARN campo Canalización.

created

La fecha y la hora en que se creó la canalización.

updated

La fecha y la hora en que se actualizó la canalización por última vez.