Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PipelineDeclaration

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

Hierarchy

  • PipelineDeclaration

Index

Properties

Optional artifactStore

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.

Optional artifactStores

artifactStores: Record<string, ArtifactStore>

A mapping of artifactStore objects and their corresponding AWS 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

name: string | undefined

The name of the pipeline.

roleArn

roleArn: string | undefined

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

stages

stages: StageDeclaration[] | undefined

The stage in which to perform the action.

Optional version

version: undefined | 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.