interface CfnPipelineProps

Language	Type name
.NET	`Amazon.CDK.AWS.CodePipeline.CfnPipelineProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CfnPipelineProps`
Java	`software.amazon.awscdk.services.codepipeline.CfnPipelineProps`
Python	`aws_cdk.aws_codepipeline.CfnPipelineProps`
TypeScript	`aws-cdk-lib` » `aws_codepipeline` » `CfnPipelineProps`

Properties for defining a CfnPipeline.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';

declare const configuration: any;
const cfnPipelineProps: codepipeline.CfnPipelineProps = {
  roleArn: 'roleArn',
  stages: [{
    actions: [{
      actionTypeId: {
        category: 'category',
        owner: 'owner',
        provider: 'provider',
        version: 'version',
      },
      name: 'name',

      // the properties below are optional
      commands: ['commands'],
      configuration: configuration,
      inputArtifacts: [{
        name: 'name',
      }],
      namespace: 'namespace',
      outputArtifacts: [{
        name: 'name',

        // the properties below are optional
        files: ['files'],
      }],
      outputVariables: ['outputVariables'],
      region: 'region',
      roleArn: 'roleArn',
      runOrder: 123,
      timeoutInMinutes: 123,
    }],
    name: 'name',

    // the properties below are optional
    beforeEntry: {
      conditions: [{
        result: 'result',
        rules: [{
          configuration: configuration,
          inputArtifacts: [{
            name: 'name',
          }],
          name: 'name',
          region: 'region',
          roleArn: 'roleArn',
          ruleTypeId: {
            category: 'category',
            owner: 'owner',
            provider: 'provider',
            version: 'version',
          },
        }],
      }],
    },
    blockers: [{
      name: 'name',
      type: 'type',
    }],
    onFailure: {
      conditions: [{
        result: 'result',
        rules: [{
          configuration: configuration,
          inputArtifacts: [{
            name: 'name',
          }],
          name: 'name',
          region: 'region',
          roleArn: 'roleArn',
          ruleTypeId: {
            category: 'category',
            owner: 'owner',
            provider: 'provider',
            version: 'version',
          },
        }],
      }],
      result: 'result',
      retryConfiguration: {
        retryMode: 'retryMode',
      },
    },
    onSuccess: {
      conditions: [{
        result: 'result',
        rules: [{
          configuration: configuration,
          inputArtifacts: [{
            name: 'name',
          }],
          name: 'name',
          region: 'region',
          roleArn: 'roleArn',
          ruleTypeId: {
            category: 'category',
            owner: 'owner',
            provider: 'provider',
            version: 'version',
          },
        }],
      }],
    },
  }],

  // the properties below are optional
  artifactStore: {
    location: 'location',
    type: 'type',

    // the properties below are optional
    encryptionKey: {
      id: 'id',
      type: 'type',
    },
  },
  artifactStores: [{
    artifactStore: {
      location: 'location',
      type: 'type',

      // the properties below are optional
      encryptionKey: {
        id: 'id',
        type: 'type',
      },
    },
    region: 'region',
  }],
  disableInboundStageTransitions: [{
    reason: 'reason',
    stageName: 'stageName',
  }],
  executionMode: 'executionMode',
  name: 'name',
  pipelineType: 'pipelineType',
  restartExecutionOnUpdate: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  triggers: [{
    providerType: 'providerType',

    // the properties below are optional
    gitConfiguration: {
      sourceActionName: 'sourceActionName',

      // the properties below are optional
      pullRequest: [{
        branches: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
        events: ['events'],
        filePaths: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
      }],
      push: [{
        branches: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
        filePaths: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
        tags: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
      }],
    },
  }],
  variables: [{
    name: 'name',

    // the properties below are optional
    defaultValue: 'defaultValue',
    description: 'description',
  }],
};

Properties

Name	Type	Description
roleArn	`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	`IResolvable` `\|` `IResolvable` `\|` `StageDeclarationProperty[]`	Represents information about a stage and its definition.
artifactStore?	`IResolvable` `\|` `ArtifactStoreProperty`	The S3 bucket where artifacts for the pipeline are stored.
artifactStores?	`IResolvable` `\|` `IResolvable` `\|` `ArtifactStoreMapProperty[]`	A mapping of `artifactStore` objects and their corresponding AWS Regions.
disableInboundStageTransitions?	`IResolvable` `\|` `IResolvable` `\|` `StageTransitionProperty[]`	Represents the input of a `DisableStageTransition` action.
executionMode?	`string`	The method that the pipeline will use to handle multiple executions.
name?	`string`	The name of the pipeline.
pipelineType?	`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.
restartExecutionOnUpdate?	`boolean \|` `IResolvable`	Indicates whether to rerun the CodePipeline pipeline after you update it.
tags?	`CfnTag[]`	Specifies the tags applied to the pipeline.
triggers?	`IResolvable` `\|` `IResolvable` `\|` `PipelineTriggerDeclarationProperty[]`	The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
variables?	`IResolvable` `\|` `IResolvable` `\|` `VariableDeclarationProperty[]`	A list that defines the pipeline variables for a pipeline resource.

roleArn

Type: 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

Type: IResolvable | IResolvable | StageDeclarationProperty[]

Represents information about a stage and its definition.

artifactStore?

Type: IResolvable | ArtifactStoreProperty (optional)

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 .

artifactStores?

Type: IResolvable | IResolvable | ArtifactStoreMapProperty[] (optional)

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 .

disableInboundStageTransitions?

Type: IResolvable | IResolvable | StageTransitionProperty[] (optional)

Represents the input of a DisableStageTransition action.

executionMode?

Type: string (optional, default: "SUPERSEDED")

The method that the pipeline will use to handle multiple executions.

The default mode is SUPERSEDED.

name?

Type: string (optional)

The name of the pipeline.

pipelineType?

Type: string (optional)

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 .

For information about which type of pipeline to choose, see What type of pipeline is right for me? .

restartExecutionOnUpdate?

Type: boolean | IResolvable (optional)

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

tags?

Type: CfnTag[] (optional)

Specifies the tags applied to the pipeline.

triggers?

Type: IResolvable | IResolvable | PipelineTriggerDeclarationProperty[] (optional)

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.

variables?

Type: IResolvable | IResolvable | VariableDeclarationProperty[] (optional)

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@\-_]+ .