Dichiarazione della pipeline

La pipeline e il livello di metadati di una pipeline hanno una struttura di base che include i parametri e la sintassi seguenti.

L'esempio seguente mostra la pipeline e il livello di metadati della struttura della tubazione in entrambi JSON e per un tipo di tubazione V1. YAML

YAML

pipeline:
  name: my-pipeline
  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
metadata:
  pipelineArn: 'arn:aws:codepipeline:us-west-2:ACCOUNT_ID:my-pipeline'
  created: '2019-12-12T06:49:02.733000+00:00'
  updated: '2020-09-10T06:34:07.447000+00:00'

JSON

{
    "pipeline": {
        "name": "NAME",
        "roleArn": "ARN",
        "artifactStore | artifactStores": {
            "type": "S3",
            "location": "amzn-s3-demo-bucket"
        },
        "stages": 
           [...]   
    },
        "version": 6
    },
    "metadata": {
        "pipelineArn": "ARN",
        "created": "2019-12-12T06:49:02.733000+00:00",
        "updated": "2020-09-10T06:34:07.447000+00:00"
    }
}

L'esempio seguente mostra la pipeline e il livello di metadati della struttura della tubazione in entrambe e per una tubazione di tipo V2. JSON YAML

YAML

pipeline:
  name: MyPipeline
  roleArn: >-
    arn:aws:iam::ACCOUNT_ID:role/service-role/AWSCodePipelineServiceRole-us-west-2-MyPipeline
  artifactStore:
    type: S3
    location: codepipeline-us-west-2-944137501947
  stages:
    ...
  version: 6
  executionMode:
  triggers
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": "NAME",
        "roleArn": "ARN",
        "artifactStoreOPPURE artifactStores": {
            "type": "S3",
            "location": "amzn-s3-demo-bucket"
        },
        "stages": 
            ...   
    },
        "version": 6,
        "executionMode": "SUPERSEDED",
        "triggers": [
            {
                "providerType": "CodeStarSourceConnection",
                "gitConfiguration": {
                    "sourceActionName": "Source",
                    "push": [
                        {
                            "tags": {
                                "includes": [
                                    "v1"
                                ],
                                "excludes": [
                                    "v2"
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
    },
    "metadata": {
        "pipelineArn": "ARN",
        "created": "2019-12-12T06:49:02.733000+00:00",
        "updated": "2020-09-10T06:34:07.447000+00:00"
    }
}

pipeline

(Obbligatorio)

Il parametro pipeline rappresenta la struttura delle azioni e delle fasi da eseguire nella pipeline. Per ulteriori informazioni, consultate l'PipelineDeclarationoggetto nella CodePipeline API Guida.

name

(Obbligatorio)

Il nome della pipeline. Quando modifichi o aggiorni una pipeline, il nome della pipeline non può essere modificato.

Nota

Se volete rinominare una pipeline esistente, potete usare il CLI get-pipeline comando per creare un JSON file che contenga la struttura della pipeline. È quindi possibile utilizzare il CLI create-pipeline comando per creare una pipeline con quella struttura e assegnarle un nuovo nome.

roleArn

(Obbligatorio)

E IAM ARN per un ruolo di servizio, ad esempio arn:aws:iam: :80398:role/ _Service_Role. EXAMPLE CodePipeline

Per utilizzare la console per visualizzare il ruolo del servizio di pipeline ARN anziché la struttura, scegli la pipeline nella console, quindi scegli Impostazioni. JSON Nella scheda Generale, viene visualizzato il ARN campo Ruolo di servizio.

artifactStoreOPPURE artifactStores

(Condizionale)

Il artifactStore campo contiene il tipo e la posizione del bucket di artefatti per una pipeline con tutte le azioni nella stessa regione. AWS Se aggiungi azioni in una regione diversa dalla pipeline, la artifactStores mappatura viene utilizzata per elencare il bucket di artefatti per ogni regione in cui vengono eseguite le azioni. AWS Quando crei o modifichi una pipeline, devi disporre di un bucket di artefatti nella regione della pipeline e di un bucket di artefatti per ogni regione in cui prevedi di eseguire un'operazione.

Nota

Nella struttura della pipeline, è necessario includere una delle due artifactStore o artifactStores nella pipeline, ma non è possibile utilizzarle entrambe. Se crei un'operazione tra Regioni nella pipeline, devi utilizzare artifactStores.

L'esempio seguente mostra la struttura di base per una pipeline con operazioni tra più regioni che usa il parametro 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

(Obbligatorio)

Il tipo di posizione per il bucket di artefatti, specificato come Amazon S3.

location

(Obbligatorio)

Il nome del bucket Amazon S3 generato automaticamente la prima volta che crei una pipeline utilizzando la console, ad esempio codepipeline-us-east -2-1234567890, o qualsiasi bucket Amazon S3 fornito per questo scopo

stages

(Obbligatorio)

Questo parametro contiene il nome di ogni fase della pipeline. Per informazioni sui parametri e sulla sintassi a livello di fase della struttura della pipeline, StageDeclaration consultate la Guida. CodePipeline API

La struttura della pipeline per le fasi presenta i seguenti requisiti:

• Una pipeline deve contenere almeno due fasi.

• La prima fase di una pipeline deve contenere almeno un'operazione di origine. Può contenere solo operazioni di origine.

• Solo la prima fase di una pipeline può contenere operazioni di origine.

• Almeno una fase in ogni pipeline deve contenere un'operazione diversa da un'operazione di origine.

• Tutti i nomi delle fasi all'interno di una pipeline devono essere univoci.

• I nomi delle fasi non possono essere modificati nella CodePipeline console. Se modificate il nome di uno stadio utilizzando il AWS CLI e lo stage contiene un'azione con uno o più parametri segreti (ad esempio un OAuth token), il valore di tali parametri segreti non viene mantenuto. È necessario inserire manualmente il valore dei parametri (che sono mascherati da quattro asterischi nei parametri JSON restituiti da AWS CLI) e includerli nella struttura. JSON

version

(Obbligatorio)

Il numero di versione di una pipeline viene generato automaticamente e cambia ogni volta che si aggiorna la pipeline.

metadata

I campi dei metadati della pipeline sono distinti dalla struttura della pipeline e non possono essere modificati. Quando aggiorni una pipeline, la data nel campo dei metadati updated viene modificata automaticamente.

pipelineArn

(Obbligatorio)

L'Amazon Resource Name (ARN) della pipeline.

Per utilizzare la console per visualizzare la pipeline ARN anziché la JSON struttura, scegli la pipeline nella console, quindi scegli Impostazioni. Nella scheda Generale, viene visualizzato il campo Pipeline. ARN

created

(Obbligatorio)

La data e l'ora di creazione della pipeline.

updated

(Obbligatorio)

La data e l'ora dell'ultimo aggiornamento della pipeline.