Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface PipelineDeclaration

Represents the structure of actions and stages to be performed in the pipeline.

Hierarchy

  • PipelineDeclaration

Properties

artifactStore?: ArtifactStore

Represents information about the S3 bucket where artifacts are stored for the pipeline.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

artifactStores?: Record<string, ArtifactStore>

A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

name: undefined | string

The name of the pipeline.

roleArn: undefined | string

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

stages: undefined | StageDeclaration[]

The stage in which to perform the action.

version?: number

The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.