AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CodePipeline::Pipeline

CfnPipeline

The `AWS::CodePipeline::Pipeline` resource creates a CodePipeline pipeline that describes how software changes go through a release process. For more information, see [What Is CodePipeline?](https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html) in the *CodePipeline User Guide* . For an example in YAML and JSON that contains the parameters in this reference, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#aws-resource-codepipeline-pipeline--examples) .

Import

import { CfnPipeline } from 'aws-cdk-lib/aws-codepipeline';

Or use the module namespace:

import * as codepipeline from 'aws-cdk-lib/aws-codepipeline';
// codepipeline.CfnPipeline

Properties

Configuration passed to the constructor as CfnPipelineProps.

roleArnRequired
string | IRoleRef

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` .

stagesRequired
IResolvable | IResolvable | StageDeclarationProperty[]

Represents information about a stage and its definition.

artifactStoreOptional
IResolvable | ArtifactStoreProperty

The S3 bucket where artifacts for the pipeline are stored. > 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` .

artifactStoresOptional
IResolvable | IResolvable | ArtifactStoreMapProperty[]

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` .

disableInboundStageTransitionsOptional
IResolvable | IResolvable | StageTransitionProperty[]

Represents the input of a `DisableStageTransition` action.

executionModeOptional
string

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

Default: - "SUPERSEDED"

nameOptional
string

The name of the pipeline.

pipelineTypeOptional
string

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications. - V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters. - V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration. > Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs. For information about pricing for CodePipeline, see [Pricing](https://docs.aws.amazon.com/codepipeline/pricing/) . For information about which type of pipeline to choose, see [What type of pipeline is right for me?](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html) .

restartExecutionOnUpdateOptional
boolean | IResolvable

Indicates whether to rerun the CodePipeline pipeline after you update it.

tagsOptional
CfnTag[]

Specifies the tags applied to the pipeline.

triggersOptional
IResolvable | IResolvable | PipelineTriggerDeclarationProperty[]

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline. > When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

variablesOptional
IResolvable | IResolvable | VariableDeclarationProperty[]

A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match `[A-Za-z0-9@\-_]+` .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter