@aws-cdk/aws-codepipeline

  • Version 1.156.1
  • Published
  • 1.37 MB
  • 7 dependencies
  • Apache-2.0 license

Install

npm i @aws-cdk/aws-codepipeline
yarn add @aws-cdk/aws-codepipeline
pnpm add @aws-cdk/aws-codepipeline

Overview

Better interface to AWS Code Pipeline

Index

Classes

Interfaces

Enums

Namespaces

Classes

class Action

abstract class Action implements IAction {}
  • Low-level class for generic CodePipeline Actions implementing the IAction interface. Contains some common logic that can be re-used by all IAction implementations. If you're writing your own Action class, feel free to extend this class.

constructor

protected constructor();

    property actionProperties

    readonly actionProperties: ActionProperties;

      property providedActionProperties

      protected abstract readonly providedActionProperties: ActionProperties;

      method bind

      bind: (
      scope: Construct,
      stage: IStage,
      options: ActionBindOptions
      ) => ActionConfig;

        method bound

        protected abstract bound: (
        scope: Construct,
        stage: IStage,
        options: ActionBindOptions
        ) => ActionConfig;

        method onStateChange

        onStateChange: (
        name: string,
        target?: events.IRuleTarget,
        options?: events.RuleProps
        ) => events.Rule;

          method variableExpression

          protected variableExpression: (variableName: string) => string;

            class Artifact

            class Artifact {}
            • An output artifact of an action. Artifacts can be used as input by some actions.

            constructor

            constructor(artifactName?: string);

              property artifactName

              readonly artifactName: string;

                property bucketName

                readonly bucketName: string;
                • The artifact attribute for the name of the S3 bucket where the artifact is stored.

                property objectKey

                readonly objectKey: string;
                • The artifact attribute for The name of the .zip file that contains the artifact that is generated by AWS CodePipeline, such as 1ABCyZZ.zip.

                property s3Location

                readonly s3Location: s3.Location;
                • Returns the location of the .zip file in S3 that this Artifact represents. Used by Lambda's CfnParametersCode when being deployed in a CodePipeline.

                property url

                readonly url: string;
                • The artifact attribute of the Amazon Simple Storage Service (Amazon S3) URL of the artifact, such as https://s3-us-west-2.amazonaws.com/artifactstorebucket-yivczw8jma0c/test/TemplateSo/1ABCyZZ.zip.

                method artifact

                static artifact: (name: string) => Artifact;
                • A static factory method used to create instances of the Artifact class. Mainly meant to be used from decdk.

                  Parameter name

                  the (required) name of the Artifact

                method atPath

                atPath: (fileName: string) => ArtifactPath;
                • Returns an ArtifactPath for a file within this artifact. CfnOutput is in the form "::"

                  Parameter fileName

                  The name of the file

                method getMetadata

                getMetadata: (key: string) => any;
                • Retrieve the metadata stored in this artifact under the given key. If there is no metadata stored under the given key, null will be returned.

                method getParam

                getParam: (jsonFile: string, keyName: string) => string;
                • Returns a token for a value inside a JSON file within this artifact.

                  Parameter jsonFile

                  The JSON file name.

                  Parameter keyName

                  The hash key.

                method setMetadata

                setMetadata: (key: string, value: any) => void;
                • Add arbitrary extra payload to the artifact under a given key. This can be used by CodePipeline actions to communicate data between themselves. If metadata was already present under the given key, it will be overwritten with the new value.

                method toString

                toString: () => string | undefined;

                  class ArtifactPath

                  class ArtifactPath {}
                  • A specific file within an output artifact.

                    The most common use case for this is specifying the template file for a CloudFormation action.

                  constructor

                  constructor(artifact: Artifact, fileName: string);

                    property artifact

                    readonly artifact: Artifact;

                      property fileName

                      readonly fileName: string;

                        property location

                        readonly location: string;

                          method artifactPath

                          static artifactPath: (artifactName: string, fileName: string) => ArtifactPath;

                            class CfnCustomActionType

                            class CfnCustomActionType extends cdk.CfnResource implements cdk.IInspectable {}
                            • A CloudFormation AWS::CodePipeline::CustomActionType

                              The AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline. For more information, see [Create and Add a Custom Action in AWS CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) in the *AWS CodePipeline User Guide* .

                              AWS::CodePipeline::CustomActionType external

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html

                            constructor

                            constructor(scope: cdk.Construct, id: string, props: CfnCustomActionTypeProps);
                            • Create a new AWS::CodePipeline::CustomActionType.

                              Parameter scope

                              scope in which this resource is defined

                              Parameter id

                              scoped id of the resource

                              Parameter props

                              resource properties

                            property category

                            category: string;
                            • The category of the custom action, such as a build action or a test action.

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category

                            property CFN_RESOURCE_TYPE_NAME

                            static readonly CFN_RESOURCE_TYPE_NAME: string;
                            • The CloudFormation resource type name for this resource class.

                            property cfnProperties

                            readonly cfnProperties: { [key: string]: any };

                              property configurationProperties

                              configurationProperties: any;
                              • The configuration properties for the custom action.

                                > You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see [Create a Custom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) .

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties

                              property inputArtifactDetails

                              inputArtifactDetails: any;
                              • The details of the input artifact for the action, such as its commit ID.

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails

                              property outputArtifactDetails

                              outputArtifactDetails: any;
                              • The details of the output artifact of the action, such as its commit ID.

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails

                              property provider

                              provider: string;
                              • The provider of the service used in the custom action, such as CodeDeploy.

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider

                              property settings

                              settings: any;
                              • URLs that provide users information about this custom action.

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings

                              property tags

                              readonly tags: cdk.TagManager;
                              • The tags for the custom action.

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-tags

                              property version

                              version: string;
                              • The version identifier of the custom action.

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version

                              method inspect

                              inspect: (inspector: cdk.TreeInspector) => void;
                              • Examines the CloudFormation resource and discloses attributes.

                                Parameter inspector

                                tree inspector to collect and process attributes

                              method renderProperties

                              protected renderProperties: (props: { [key: string]: any }) => {
                              [key: string]: any;
                              };

                                class CfnPipeline

                                class CfnPipeline extends cdk.CfnResource implements cdk.IInspectable {}
                                • A CloudFormation AWS::CodePipeline::Pipeline

                                  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 *AWS CodePipeline User Guide* .

                                  AWS::CodePipeline::Pipeline external

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html

                                constructor

                                constructor(scope: cdk.Construct, id: string, props: CfnPipelineProps);
                                • Create a new AWS::CodePipeline::Pipeline.

                                  Parameter scope

                                  scope in which this resource is defined

                                  Parameter id

                                  scoped id of the resource

                                  Parameter props

                                  resource properties

                                property artifactStore

                                artifactStore: any;
                                • 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 .

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore

                                property artifactStores

                                artifactStores: any;
                                • 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 .

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores

                                property attrVersion

                                readonly attrVersion: string;
                                • The version of the pipeline.

                                  > A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated. Version

                                property CFN_RESOURCE_TYPE_NAME

                                static readonly CFN_RESOURCE_TYPE_NAME: string;
                                • The CloudFormation resource type name for this resource class.

                                property cfnProperties

                                readonly cfnProperties: { [key: string]: any };

                                  property disableInboundStageTransitions

                                  disableInboundStageTransitions: any;
                                  • Represents the input of a DisableStageTransition action.

                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions

                                  property name

                                  name: string;
                                  • The name of the pipeline.

                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name

                                  property restartExecutionOnUpdate

                                  restartExecutionOnUpdate: any;
                                  • Indicates whether to rerun the CodePipeline pipeline after you update it.

                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate

                                  property roleArn

                                  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 .

                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn

                                  property stages

                                  stages: any;
                                  • Represents information about a stage and its definition.

                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages

                                  property tags

                                  readonly tags: cdk.TagManager;
                                  • Specifies the tags applied to the pipeline.

                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-tags

                                  method inspect

                                  inspect: (inspector: cdk.TreeInspector) => void;
                                  • Examines the CloudFormation resource and discloses attributes.

                                    Parameter inspector

                                    tree inspector to collect and process attributes

                                  method renderProperties

                                  protected renderProperties: (props: { [key: string]: any }) => {
                                  [key: string]: any;
                                  };

                                    class CfnWebhook

                                    class CfnWebhook extends cdk.CfnResource implements cdk.IInspectable {}
                                    • A CloudFormation AWS::CodePipeline::Webhook

                                      The AWS::CodePipeline::Webhook resource creates and registers your webhook. After the webhook is created and registered, it triggers your pipeline to start every time an external event occurs. For more information, see [Configure Your GitHub Pipelines to Use Webhooks for Change Detection](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-webhooks-migration.html) in the *AWS CodePipeline User Guide* .

                                      We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have already configured and stored your secret parameters in Secrets Manager. For more information, see [Using Dynamic References to Specify Template Values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) .

                                      > When passing secret parameters, do not enter the value directly into the template. The value is rendered as plaintext and is therefore readable. For security reasons, do not use plaintext in your AWS CloudFormation template to store your credentials.

                                      AWS::CodePipeline::Webhook external

                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html

                                    constructor

                                    constructor(scope: cdk.Construct, id: string, props: CfnWebhookProps);
                                    • Create a new AWS::CodePipeline::Webhook.

                                      Parameter scope

                                      scope in which this resource is defined

                                      Parameter id

                                      scoped id of the resource

                                      Parameter props

                                      resource properties

                                    property attrUrl

                                    readonly attrUrl: string;
                                    • The webhook URL generated by AWS CodePipeline , such as https://eu-central-1.webhooks.aws/trigger123456 . Url

                                    property authentication

                                    authentication: string;
                                    • Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

                                      - For information about the authentication scheme implemented by GITHUB_HMAC, see [Securing your webhooks](https://docs.aws.amazon.com/https://developer.github.com/webhooks/securing/) on the GitHub Developer website. - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration. - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication

                                    property authenticationConfiguration

                                    authenticationConfiguration: any;
                                    • Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration

                                    property CFN_RESOURCE_TYPE_NAME

                                    static readonly CFN_RESOURCE_TYPE_NAME: string;
                                    • The CloudFormation resource type name for this resource class.

                                    property cfnProperties

                                    readonly cfnProperties: { [key: string]: any };

                                      property filters

                                      filters: any;
                                      • A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters

                                      property name

                                      name: string;
                                      • The name of the webhook.

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name

                                      property registerWithThirdParty

                                      registerWithThirdParty: any;
                                      • Configures a connection between the webhook that was created and the external tool with events to be detected.

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty

                                      property targetAction

                                      targetAction: string;
                                      • The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction

                                      property targetPipeline

                                      targetPipeline: string;
                                      • The name of the pipeline you want to connect to the webhook.

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline

                                      property targetPipelineVersion

                                      targetPipelineVersion: number;
                                      • The version number of the pipeline to be connected to the trigger request.

                                        Required: Yes

                                        Type: Integer

                                        Update requires: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion

                                      method inspect

                                      inspect: (inspector: cdk.TreeInspector) => void;
                                      • Examines the CloudFormation resource and discloses attributes.

                                        Parameter inspector

                                        tree inspector to collect and process attributes

                                      method renderProperties

                                      protected renderProperties: (props: { [key: string]: any }) => {
                                      [key: string]: any;
                                      };

                                        class CustomActionRegistration

                                        class CustomActionRegistration extends CoreConstruct {}
                                        • The resource representing registering a custom Action with CodePipeline. For the Action to be usable, it has to be registered for every region and every account it's used in. In addition to this class, you should most likely also provide your clients a class representing your custom Action, extending the Action class, and taking the actionProperties as properly typed, construction properties.

                                        constructor

                                        constructor(scope: Construct, id: string, props: CustomActionRegistrationProps);

                                          class GlobalVariables

                                          class GlobalVariables {}
                                          • The CodePipeline variables that are global, not bound to a specific action. This class defines a bunch of static fields that represent the different variables. These can be used can be used in any action configuration.

                                          property executionId

                                          static readonly executionId: string;
                                          • The identifier of the current pipeline execution.

                                          class Pipeline

                                          class Pipeline extends PipelineBase {}
                                          • An AWS CodePipeline pipeline with its associated IAM role and S3 bucket.

                                            Example 1

                                            // create a pipeline import * as codecommit from '@aws-cdk/aws-codecommit';

                                            const pipeline = new codepipeline.Pipeline(this, 'Pipeline');

                                            // add a stage const sourceStage = pipeline.addStage({ stageName: 'Source' });

                                            // add a source action to the stage declare const repo: codecommit.Repository; declare const sourceArtifact: codepipeline.Artifact; sourceStage.addAction(new codepipeline_actions.CodeCommitSourceAction({ actionName: 'Source', output: sourceArtifact, repository: repo, }));

                                            // ... add more stages

                                          constructor

                                          constructor(scope: Construct, id: string, props?: PipelineProps);

                                            property artifactBucket

                                            readonly artifactBucket: s3.IBucket;
                                            • Bucket used to store output artifacts

                                            property crossRegionSupport

                                            readonly crossRegionSupport: { [region: string]: CrossRegionSupport };
                                            • Returns all of the CrossRegionSupportStacks that were generated automatically when dealing with Actions that reside in a different region than the Pipeline itself.

                                            property pipelineArn

                                            readonly pipelineArn: string;
                                            • ARN of this pipeline

                                            property pipelineName

                                            readonly pipelineName: string;
                                            • The name of the pipeline

                                            property pipelineVersion

                                            readonly pipelineVersion: string;
                                            • The version of the pipeline

                                            property role

                                            readonly role: iam.IRole;
                                            • The IAM role AWS CodePipeline will use to perform actions or assume roles for actions with a more specific IAM role.

                                            property stageCount

                                            readonly stageCount: number;
                                            • Get the number of Stages in this Pipeline.

                                            property stages

                                            readonly stages: IStage[];
                                            • Returns the stages that comprise the pipeline.

                                              **Note**: the returned array is a defensive copy, so adding elements to it has no effect. Instead, use the addStage method if you want to add more stages to the pipeline.

                                            method addStage

                                            addStage: (props: StageOptions) => IStage;
                                            • Creates a new Stage, and adds it to this Pipeline.

                                              Parameter props

                                              the creation properties of the new Stage

                                              Returns

                                              the newly created Stage

                                            method addToRolePolicy

                                            addToRolePolicy: (statement: iam.PolicyStatement) => void;
                                            • Adds a statement to the pipeline role.

                                            method fromPipelineArn

                                            static fromPipelineArn: (
                                            scope: Construct,
                                            id: string,
                                            pipelineArn: string
                                            ) => IPipeline;
                                            • Import a pipeline into this app.

                                              Parameter scope

                                              the scope into which to import this pipeline

                                              Parameter id

                                              the logical ID of the returned pipeline construct

                                              Parameter pipelineArn

                                              The ARN of the pipeline (e.g. arn:aws:codepipeline:us-east-1:123456789012:MyDemoPipeline)

                                            method stage

                                            stage: (stageName: string) => IStage;
                                            • Access one of the pipeline's stages by stage name

                                            method validate

                                            protected validate: () => string[];
                                            • Validate the pipeline structure

                                              Validation happens according to the rules documented at

                                              https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#pipeline-requirements

                                              Modifiers

                                              • @override

                                            Interfaces

                                            interface ActionArtifactBounds

                                            interface ActionArtifactBounds {}
                                            • Specifies the constraints on the number of input and output artifacts an action can have.

                                              The constraints for each action type are documented on the page.

                                            property maxInputs

                                            readonly maxInputs: number;

                                              property maxOutputs

                                              readonly maxOutputs: number;

                                                property minInputs

                                                readonly minInputs: number;

                                                  property minOutputs

                                                  readonly minOutputs: number;

                                                    interface ActionBindOptions

                                                    interface ActionBindOptions {}

                                                      property bucket

                                                      readonly bucket: s3.IBucket;

                                                        property role

                                                        readonly role: iam.IRole;

                                                          interface ActionConfig

                                                          interface ActionConfig {}

                                                            property configuration

                                                            readonly configuration?: any;

                                                              interface ActionProperties

                                                              interface ActionProperties {}

                                                                property account

                                                                readonly account?: string;
                                                                • The account the Action is supposed to live in. For Actions backed by resources, this is inferred from the Stack resource is part of. However, some Actions, like the CloudFormation ones, are not backed by any resource, and they still might want to be cross-account. In general, a concrete Action class should specify either resource, or account - but not both.

                                                                property actionName

                                                                readonly actionName: string;

                                                                  property artifactBounds

                                                                  readonly artifactBounds: ActionArtifactBounds;

                                                                    property category

                                                                    readonly category: ActionCategory;
                                                                    • The category of the action. The category defines which action type the owner (the entity that performs the action) performs.

                                                                    property inputs

                                                                    readonly inputs?: Artifact[];

                                                                      property outputs

                                                                      readonly outputs?: Artifact[];

                                                                        property owner

                                                                        readonly owner?: string;

                                                                          property provider

                                                                          readonly provider: string;
                                                                          • The service provider that the action calls.

                                                                          property region

                                                                          readonly region?: string;
                                                                          • The AWS region the given Action resides in. Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the PipelineProps#crossRegionReplicationBuckets property. If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need to cdk deploy before deploying the main, Pipeline-containing Stack.

                                                                            the Action resides in the same region as the Pipeline

                                                                          property resource

                                                                          readonly resource?: IResource;
                                                                          • The optional resource that is backing this Action. This is used for automatically handling Actions backed by resources from a different account and/or region.

                                                                          property role

                                                                          readonly role?: iam.IRole;

                                                                            property runOrder

                                                                            readonly runOrder?: number;
                                                                            • The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide.

                                                                              https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements

                                                                            property variablesNamespace

                                                                            readonly variablesNamespace?: string;
                                                                            • The name of the namespace to use for variables emitted by this action.

                                                                              - a name will be generated, based on the stage and action names

                                                                            property version

                                                                            readonly version?: string;

                                                                              interface CfnCustomActionTypeProps

                                                                              interface CfnCustomActionTypeProps {}
                                                                              • Properties for defining a CfnCustomActionType

                                                                                external

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html

                                                                              property category

                                                                              readonly category: string;
                                                                              • The category of the custom action, such as a build action or a test action.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category

                                                                              property configurationProperties

                                                                              readonly configurationProperties?:
                                                                              | Array<
                                                                              CfnCustomActionType.ConfigurationPropertiesProperty | cdk.IResolvable
                                                                              >
                                                                              | cdk.IResolvable;
                                                                              • The configuration properties for the custom action.

                                                                                > You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see [Create a Custom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) .

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties

                                                                              property inputArtifactDetails

                                                                              readonly inputArtifactDetails:
                                                                              | CfnCustomActionType.ArtifactDetailsProperty
                                                                              | cdk.IResolvable;
                                                                              • The details of the input artifact for the action, such as its commit ID.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails

                                                                              property outputArtifactDetails

                                                                              readonly outputArtifactDetails:
                                                                              | CfnCustomActionType.ArtifactDetailsProperty
                                                                              | cdk.IResolvable;
                                                                              • The details of the output artifact of the action, such as its commit ID.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails

                                                                              property provider

                                                                              readonly provider: string;
                                                                              • The provider of the service used in the custom action, such as CodeDeploy.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider

                                                                              property settings

                                                                              readonly settings?: CfnCustomActionType.SettingsProperty | cdk.IResolvable;
                                                                              • URLs that provide users information about this custom action.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings

                                                                              property tags

                                                                              readonly tags?: cdk.CfnTag[];
                                                                              • The tags for the custom action.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-tags

                                                                              property version

                                                                              readonly version: string;
                                                                              • The version identifier of the custom action.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version

                                                                              interface CfnPipelineProps

                                                                              interface CfnPipelineProps {}
                                                                              • Properties for defining a CfnPipeline

                                                                                external

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html

                                                                              property artifactStore

                                                                              readonly artifactStore?: CfnPipeline.ArtifactStoreProperty | cdk.IResolvable;
                                                                              • 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 .

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore

                                                                              property artifactStores

                                                                              readonly artifactStores?:
                                                                              | Array<CfnPipeline.ArtifactStoreMapProperty | cdk.IResolvable>
                                                                              | cdk.IResolvable;
                                                                              • 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 .

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores

                                                                              property disableInboundStageTransitions

                                                                              readonly disableInboundStageTransitions?:
                                                                              | Array<CfnPipeline.StageTransitionProperty | cdk.IResolvable>
                                                                              | cdk.IResolvable;
                                                                              • Represents the input of a DisableStageTransition action.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions

                                                                              property name

                                                                              readonly name?: string;
                                                                              • The name of the pipeline.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name

                                                                              property restartExecutionOnUpdate

                                                                              readonly restartExecutionOnUpdate?: boolean | cdk.IResolvable;
                                                                              • Indicates whether to rerun the CodePipeline pipeline after you update it.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate

                                                                              property roleArn

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

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn

                                                                              property stages

                                                                              readonly stages:
                                                                              | Array<CfnPipeline.StageDeclarationProperty | cdk.IResolvable>
                                                                              | cdk.IResolvable;
                                                                              • Represents information about a stage and its definition.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages

                                                                              property tags

                                                                              readonly tags?: cdk.CfnTag[];
                                                                              • Specifies the tags applied to the pipeline.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-tags

                                                                              interface CfnWebhookProps

                                                                              interface CfnWebhookProps {}
                                                                              • Properties for defining a CfnWebhook

                                                                                external

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html

                                                                              property authentication

                                                                              readonly authentication: string;
                                                                              • Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

                                                                                - For information about the authentication scheme implemented by GITHUB_HMAC, see [Securing your webhooks](https://docs.aws.amazon.com/https://developer.github.com/webhooks/securing/) on the GitHub Developer website. - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration. - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication

                                                                              property authenticationConfiguration

                                                                              readonly authenticationConfiguration:
                                                                              | CfnWebhook.WebhookAuthConfigurationProperty
                                                                              | cdk.IResolvable;
                                                                              • Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration

                                                                              property filters

                                                                              readonly filters:
                                                                              | Array<CfnWebhook.WebhookFilterRuleProperty | cdk.IResolvable>
                                                                              | cdk.IResolvable;
                                                                              • A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters

                                                                              property name

                                                                              readonly name?: string;
                                                                              • The name of the webhook.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name

                                                                              property registerWithThirdParty

                                                                              readonly registerWithThirdParty?: boolean | cdk.IResolvable;
                                                                              • Configures a connection between the webhook that was created and the external tool with events to be detected.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty

                                                                              property targetAction

                                                                              readonly targetAction: string;
                                                                              • The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction

                                                                              property targetPipeline

                                                                              readonly targetPipeline: string;
                                                                              • The name of the pipeline you want to connect to the webhook.

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline

                                                                              property targetPipelineVersion

                                                                              readonly targetPipelineVersion: number;
                                                                              • The version number of the pipeline to be connected to the trigger request.

                                                                                Required: Yes

                                                                                Type: Integer

                                                                                Update requires: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion

                                                                              interface CommonActionProps

                                                                              interface CommonActionProps {}
                                                                              • Common properties shared by all Actions.

                                                                              property actionName

                                                                              readonly actionName: string;
                                                                              • The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.

                                                                              property runOrder

                                                                              readonly runOrder?: number;
                                                                              • The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.

                                                                                1

                                                                                See Also

                                                                                • https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

                                                                              property variablesNamespace

                                                                              readonly variablesNamespace?: string;
                                                                              • The name of the namespace to use for variables emitted by this action.

                                                                                - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

                                                                              interface CommonAwsActionProps

                                                                              interface CommonAwsActionProps extends CommonActionProps {}
                                                                              • Common properties shared by all Actions whose ActionProperties.owner field is 'AWS' (or unset, as 'AWS' is the default).

                                                                              property role

                                                                              readonly role?: iam.IRole;
                                                                              • The Role in which context's this Action will be executing in. The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

                                                                                a new Role will be generated

                                                                              interface CrossRegionSupport

                                                                              interface CrossRegionSupport {}
                                                                              • An interface representing resources generated in order to support the cross-region capabilities of CodePipeline. You get instances of this interface from the Pipeline#crossRegionSupport property.

                                                                              property replicationBucket

                                                                              readonly replicationBucket: s3.IBucket;
                                                                              • The replication Bucket used by CodePipeline to operate in this region. Belongs to stack.

                                                                              property stack

                                                                              readonly stack: Stack;
                                                                              • The Stack that has been created to house the replication Bucket required for this region.

                                                                              interface CustomActionProperty

                                                                              interface CustomActionProperty {}
                                                                              • The creation attributes used for defining a configuration property of a custom Action.

                                                                              property description

                                                                              readonly description?: string;
                                                                              • The description of the property.

                                                                                the description will be empty

                                                                              property key

                                                                              readonly key?: boolean;
                                                                              • Whether this property is a key.

                                                                                false

                                                                                See Also

                                                                                • https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-key

                                                                              property name

                                                                              readonly name: string;
                                                                              • The name of the property. You use this name in the configuration attribute when defining your custom Action class.

                                                                              property queryable

                                                                              readonly queryable?: boolean;
                                                                              • Whether this property is queryable. Note that only a single property of a custom Action can be queryable.

                                                                                false

                                                                                See Also

                                                                                • https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable

                                                                              property required

                                                                              readonly required: boolean;
                                                                              • Whether this property is required.

                                                                              property secret

                                                                              readonly secret?: boolean;
                                                                              • Whether this property is secret, like a password, or access key.

                                                                                false

                                                                              property type

                                                                              readonly type?: string;
                                                                              • The type of the property, like 'String', 'Number', or 'Boolean'.

                                                                                'String'

                                                                              interface CustomActionRegistrationProps

                                                                              interface CustomActionRegistrationProps {}
                                                                              • Properties of registering a custom Action.

                                                                              property actionProperties

                                                                              readonly actionProperties?: CustomActionProperty[];
                                                                              • The properties used for customizing the instance of your Action.

                                                                                []

                                                                              property artifactBounds

                                                                              readonly artifactBounds: ActionArtifactBounds;
                                                                              • The artifact bounds of the Action.

                                                                              property category

                                                                              readonly category: ActionCategory;
                                                                              • The category of the Action.

                                                                              property entityUrl

                                                                              readonly entityUrl?: string;
                                                                              • The URL shown for the entire Action in the Pipeline UI. none

                                                                              property executionUrl

                                                                              readonly executionUrl?: string;
                                                                              • The URL shown for a particular execution of an Action in the Pipeline UI. none

                                                                              property provider

                                                                              readonly provider: string;
                                                                              • The provider of the Action. For example, 'MyCustomActionProvider'

                                                                              property version

                                                                              readonly version?: string;
                                                                              • The version of your Action.

                                                                                '1'

                                                                              interface IAction

                                                                              interface IAction {}
                                                                              • A Pipeline Action. If you want to implement this interface, consider extending the Action class, which contains some common logic.

                                                                              property actionProperties

                                                                              readonly actionProperties: ActionProperties;
                                                                              • The simple properties of the Action, like its Owner, name, etc. Note that this accessor will be called before the bind callback.

                                                                              method bind

                                                                              bind: (
                                                                              scope: Construct,
                                                                              stage: IStage,
                                                                              options: ActionBindOptions
                                                                              ) => ActionConfig;
                                                                              • The callback invoked when this Action is added to a Pipeline.

                                                                                Parameter scope

                                                                                the Construct tree scope the Action can use if it needs to create any resources

                                                                                Parameter stage

                                                                                the IStage this Action is being added to

                                                                                Parameter options

                                                                                additional options the Action can use, like the artifact Bucket of the pipeline it's being added to

                                                                              method onStateChange

                                                                              onStateChange: (
                                                                              name: string,
                                                                              target?: events.IRuleTarget,
                                                                              options?: events.RuleProps
                                                                              ) => events.Rule;
                                                                              • Creates an Event that will be triggered whenever the state of this Action changes.

                                                                                Parameter name

                                                                                the name to use for the new Event

                                                                                Parameter target

                                                                                the optional target for the Event

                                                                                Parameter options

                                                                                additional options that can be used to customize the created Event

                                                                              interface IPipeline

                                                                              interface IPipeline extends IResource, notifications.INotificationRuleSource {}
                                                                              • The abstract view of an AWS CodePipeline as required and used by Actions. It extends events.IRuleTarget, so this interface can be used as a Target for CloudWatch Events.

                                                                              property pipelineArn

                                                                              readonly pipelineArn: string;
                                                                              • The ARN of the Pipeline.

                                                                              property pipelineName

                                                                              readonly pipelineName: string;
                                                                              • The name of the Pipeline.

                                                                              method notifyOn

                                                                              notifyOn: (
                                                                              id: string,
                                                                              target: notifications.INotificationRuleTarget,
                                                                              options: PipelineNotifyOnOptions
                                                                              ) => notifications.INotificationRule;
                                                                              • Defines a CodeStar notification rule triggered when the pipeline events emitted by you specified, it very similar to onEvent API.

                                                                                You can also use the methods notifyOnExecutionStateChange, notifyOnAnyStageStateChange, notifyOnAnyActionStateChange and notifyOnAnyManualApprovalStateChange to define rules for these specific event emitted.

                                                                                Parameter id

                                                                                The id of the CodeStar notification rule

                                                                                Parameter target

                                                                                The target to register for the CodeStar Notifications destination.

                                                                                Parameter options

                                                                                Customization options for CodeStar notification rule

                                                                                Returns

                                                                                CodeStar notification rule associated with this build project.

                                                                              method notifyOnAnyActionStateChange

                                                                              notifyOnAnyActionStateChange: (
                                                                              id: string,
                                                                              target: notifications.INotificationRuleTarget,
                                                                              options?: notifications.NotificationRuleOptions
                                                                              ) => notifications.INotificationRule;
                                                                              • Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.

                                                                                Parameter id

                                                                                Identifier for this notification handler.

                                                                                Parameter target

                                                                                The target to register for the CodeStar Notifications destination.

                                                                                Parameter options

                                                                                Additional options to pass to the notification rule.

                                                                                See Also

                                                                                • https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

                                                                              method notifyOnAnyManualApprovalStateChange

                                                                              notifyOnAnyManualApprovalStateChange: (
                                                                              id: string,
                                                                              target: notifications.INotificationRuleTarget,
                                                                              options?: notifications.NotificationRuleOptions
                                                                              ) => notifications.INotificationRule;
                                                                              • Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.

                                                                                Parameter id

                                                                                Identifier for this notification handler.

                                                                                Parameter target

                                                                                The target to register for the CodeStar Notifications destination.

                                                                                Parameter options

                                                                                Additional options to pass to the notification rule.

                                                                                See Also

                                                                                • https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

                                                                              method notifyOnAnyStageStateChange

                                                                              notifyOnAnyStageStateChange: (
                                                                              id: string,
                                                                              target: notifications.INotificationRuleTarget,
                                                                              options?: notifications.NotificationRuleOptions
                                                                              ) => notifications.INotificationRule;
                                                                              • Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.

                                                                                Parameter id

                                                                                Identifier for this notification handler.

                                                                                Parameter target

                                                                                The target to register for the CodeStar Notifications destination.

                                                                                Parameter options

                                                                                Additional options to pass to the notification rule.

                                                                                See Also

                                                                                • https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

                                                                              method notifyOnExecutionStateChange

                                                                              notifyOnExecutionStateChange: (
                                                                              id: string,
                                                                              target: notifications.INotificationRuleTarget,
                                                                              options?: notifications.NotificationRuleOptions
                                                                              ) => notifications.INotificationRule;
                                                                              • Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.

                                                                                Parameter id

                                                                                Identifier for this notification handler.

                                                                                Parameter target

                                                                                The target to register for the CodeStar Notifications destination.

                                                                                Parameter options

                                                                                Additional options to pass to the notification rule.

                                                                                See Also

                                                                                • https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

                                                                              method onEvent

                                                                              onEvent: (id: string, options?: events.OnEventOptions) => events.Rule;
                                                                              • Define an event rule triggered by this CodePipeline.

                                                                                Parameter id

                                                                                Identifier for this event handler.

                                                                                Parameter options

                                                                                Additional options to pass to the event rule.

                                                                              method onStateChange

                                                                              onStateChange: (id: string, options?: events.OnEventOptions) => events.Rule;
                                                                              • Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

                                                                                Parameter id

                                                                                Identifier for this event handler.

                                                                                Parameter options

                                                                                Additional options to pass to the event rule.

                                                                              interface IStage

                                                                              interface IStage {}
                                                                              • The abstract interface of a Pipeline Stage that is used by Actions.

                                                                              property actions

                                                                              readonly actions: IAction[];
                                                                              • The actions belonging to this stage.

                                                                              property pipeline

                                                                              readonly pipeline: IPipeline;

                                                                                property stageName

                                                                                readonly stageName: string;
                                                                                • The physical, human-readable name of this Pipeline Stage.

                                                                                method addAction

                                                                                addAction: (action: IAction) => void;

                                                                                  method onStateChange

                                                                                  onStateChange: (
                                                                                  name: string,
                                                                                  target?: events.IRuleTarget,
                                                                                  options?: events.RuleProps
                                                                                  ) => events.Rule;

                                                                                    interface PipelineNotifyOnOptions

                                                                                    interface PipelineNotifyOnOptions extends notifications.NotificationRuleOptions {}
                                                                                    • Additional options to pass to the notification rule.

                                                                                    property events

                                                                                    readonly events: PipelineNotificationEvents[];
                                                                                    • A list of event types associated with this notification rule for CodePipeline Pipeline. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

                                                                                      See Also

                                                                                      • https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api

                                                                                    interface PipelineProps

                                                                                    interface PipelineProps {}

                                                                                      property artifactBucket

                                                                                      readonly artifactBucket?: s3.IBucket;
                                                                                      • The S3 bucket used by this Pipeline to store artifacts.

                                                                                        - A new S3 bucket will be created.

                                                                                      property crossAccountKeys

                                                                                      readonly crossAccountKeys?: boolean;
                                                                                      • Create KMS keys for cross-account deployments.

                                                                                        This controls whether the pipeline is enabled for cross-account deployments.

                                                                                        By default cross-account deployments are enabled, but this feature requires that KMS Customer Master Keys are created which have a cost of $1/month.

                                                                                        If you do not need cross-account deployments, you can set this to false to not create those keys and save on that cost (the artifact bucket will be encrypted with an AWS-managed key). However, cross-account deployments will no longer be possible.

                                                                                        true

                                                                                      property crossRegionReplicationBuckets

                                                                                      readonly crossRegionReplicationBuckets?: {
                                                                                      [region: string]: s3.IBucket;
                                                                                      };
                                                                                      • A map of region to S3 bucket name used for cross-region CodePipeline. For every Action that you specify targeting a different region than the Pipeline itself, if you don't provide an explicit Bucket for that region using this property, the construct will automatically create a Stack containing an S3 Bucket in that region.

                                                                                        - None.

                                                                                      property enableKeyRotation

                                                                                      readonly enableKeyRotation?: boolean;
                                                                                      • Enable KMS key rotation for the generated KMS keys.

                                                                                        By default KMS key rotation is disabled, but will add an additional $1/month for each year the key exists when enabled.

                                                                                        - false (key rotation is disabled)

                                                                                      property pipelineName

                                                                                      readonly pipelineName?: string;
                                                                                      • Name of the pipeline.

                                                                                        - AWS CloudFormation generates an ID and uses that for the pipeline name.

                                                                                      property restartExecutionOnUpdate

                                                                                      readonly restartExecutionOnUpdate?: boolean;
                                                                                      • Indicates whether to rerun the AWS CodePipeline pipeline after you update it.

                                                                                        false

                                                                                      property reuseCrossRegionSupportStacks

                                                                                      readonly reuseCrossRegionSupportStacks?: boolean;
                                                                                      • Reuse the same cross region support stack for all pipelines in the App.

                                                                                        - true (Use the same support stack for all pipelines in App)

                                                                                      property role

                                                                                      readonly role?: iam.IRole;
                                                                                      • The IAM role to be assumed by this Pipeline.

                                                                                        a new IAM role will be created.

                                                                                      property stages

                                                                                      readonly stages?: StageProps[];
                                                                                      • The list of Stages, in order, to create this Pipeline with. You can always add more Stages later by calling Pipeline#addStage.

                                                                                        - None.

                                                                                      interface StageOptions

                                                                                      interface StageOptions extends StageProps {}

                                                                                        property placement

                                                                                        readonly placement?: StagePlacement;

                                                                                          interface StagePlacement

                                                                                          interface StagePlacement {}
                                                                                          • Allows you to control where to place a new Stage when it's added to the Pipeline. Note that you can provide only one of the below properties - specifying more than one will result in a validation error.

                                                                                            See Also

                                                                                            • #rightBefore

                                                                                            • #justAfter

                                                                                          property justAfter

                                                                                          readonly justAfter?: IStage;
                                                                                          • Inserts the new Stage as a child of the given Stage (changing its current child Stage, if it had one).

                                                                                          property rightBefore

                                                                                          readonly rightBefore?: IStage;
                                                                                          • Inserts the new Stage as a parent of the given Stage (changing its current parent Stage, if it had one).

                                                                                          interface StageProps

                                                                                          interface StageProps {}
                                                                                          • Construction properties of a Pipeline Stage.

                                                                                          property actions

                                                                                          readonly actions?: IAction[];
                                                                                          • The list of Actions to create this Stage with. You can always add more Actions later by calling IStage#addAction.

                                                                                          property stageName

                                                                                          readonly stageName: string;
                                                                                          • The physical, human-readable name to assign to this Pipeline Stage.

                                                                                          property transitionDisabledReason

                                                                                          readonly transitionDisabledReason?: string;
                                                                                          • The reason for disabling transition to this stage. Only applicable if transitionToEnabled is set to false.

                                                                                            'Transition disabled'

                                                                                          property transitionToEnabled

                                                                                          readonly transitionToEnabled?: boolean;
                                                                                          • Whether to enable transition to this stage.

                                                                                            true

                                                                                          Enums

                                                                                          enum ActionCategory

                                                                                          enum ActionCategory {
                                                                                          SOURCE = 'Source',
                                                                                          BUILD = 'Build',
                                                                                          TEST = 'Test',
                                                                                          APPROVAL = 'Approval',
                                                                                          DEPLOY = 'Deploy',
                                                                                          INVOKE = 'Invoke',
                                                                                          }

                                                                                            member APPROVAL

                                                                                            APPROVAL = 'Approval'

                                                                                              member BUILD

                                                                                              BUILD = 'Build'

                                                                                                member DEPLOY

                                                                                                DEPLOY = 'Deploy'

                                                                                                  member INVOKE

                                                                                                  INVOKE = 'Invoke'

                                                                                                    member SOURCE

                                                                                                    SOURCE = 'Source'

                                                                                                      member TEST

                                                                                                      TEST = 'Test'

                                                                                                        enum PipelineNotificationEvents

                                                                                                        enum PipelineNotificationEvents {
                                                                                                        PIPELINE_EXECUTION_FAILED = 'codepipeline-pipeline-pipeline-execution-failed',
                                                                                                        PIPELINE_EXECUTION_CANCELED = 'codepipeline-pipeline-pipeline-execution-canceled',
                                                                                                        PIPELINE_EXECUTION_STARTED = 'codepipeline-pipeline-pipeline-execution-started',
                                                                                                        PIPELINE_EXECUTION_RESUMED = 'codepipeline-pipeline-pipeline-execution-resumed',
                                                                                                        PIPELINE_EXECUTION_SUCCEEDED = 'codepipeline-pipeline-pipeline-execution-succeeded',
                                                                                                        PIPELINE_EXECUTION_SUPERSEDED = 'codepipeline-pipeline-pipeline-execution-superseded',
                                                                                                        STAGE_EXECUTION_STARTED = 'codepipeline-pipeline-stage-execution-started',
                                                                                                        STAGE_EXECUTION_SUCCEEDED = 'codepipeline-pipeline-stage-execution-succeeded',
                                                                                                        STAGE_EXECUTION_RESUMED = 'codepipeline-pipeline-stage-execution-resumed',
                                                                                                        STAGE_EXECUTION_CANCELED = 'codepipeline-pipeline-stage-execution-canceled',
                                                                                                        STAGE_EXECUTION_FAILED = 'codepipeline-pipeline-stage-execution-failed',
                                                                                                        ACTION_EXECUTION_SUCCEEDED = 'codepipeline-pipeline-action-execution-succeeded',
                                                                                                        ACTION_EXECUTION_FAILED = 'codepipeline-pipeline-action-execution-failed',
                                                                                                        ACTION_EXECUTION_CANCELED = 'codepipeline-pipeline-action-execution-canceled',
                                                                                                        ACTION_EXECUTION_STARTED = 'codepipeline-pipeline-action-execution-started',
                                                                                                        MANUAL_APPROVAL_FAILED = 'codepipeline-pipeline-manual-approval-failed',
                                                                                                        MANUAL_APPROVAL_NEEDED = 'codepipeline-pipeline-manual-approval-needed',
                                                                                                        MANUAL_APPROVAL_SUCCEEDED = 'codepipeline-pipeline-manual-approval-succeeded',
                                                                                                        }
                                                                                                        • The list of event types for AWS Codepipeline Pipeline

                                                                                                          See Also

                                                                                                          • https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

                                                                                                        member ACTION_EXECUTION_CANCELED

                                                                                                        ACTION_EXECUTION_CANCELED = 'codepipeline-pipeline-action-execution-canceled'
                                                                                                        • Trigger notification when pipeline action execution canceled

                                                                                                        member ACTION_EXECUTION_FAILED

                                                                                                        ACTION_EXECUTION_FAILED = 'codepipeline-pipeline-action-execution-failed'
                                                                                                        • Trigger notification when pipeline action execution failed

                                                                                                        member ACTION_EXECUTION_STARTED

                                                                                                        ACTION_EXECUTION_STARTED = 'codepipeline-pipeline-action-execution-started'
                                                                                                        • Trigger notification when pipeline action execution started

                                                                                                        member ACTION_EXECUTION_SUCCEEDED

                                                                                                        ACTION_EXECUTION_SUCCEEDED = 'codepipeline-pipeline-action-execution-succeeded'
                                                                                                        • Trigger notification when pipeline action execution succeeded

                                                                                                        member MANUAL_APPROVAL_FAILED

                                                                                                        MANUAL_APPROVAL_FAILED = 'codepipeline-pipeline-manual-approval-failed'
                                                                                                        • Trigger notification when pipeline manual approval failed

                                                                                                        member MANUAL_APPROVAL_NEEDED

                                                                                                        MANUAL_APPROVAL_NEEDED = 'codepipeline-pipeline-manual-approval-needed'
                                                                                                        • Trigger notification when pipeline manual approval needed

                                                                                                        member MANUAL_APPROVAL_SUCCEEDED

                                                                                                        MANUAL_APPROVAL_SUCCEEDED = 'codepipeline-pipeline-manual-approval-succeeded'
                                                                                                        • Trigger notification when pipeline manual approval succeeded

                                                                                                        member PIPELINE_EXECUTION_CANCELED

                                                                                                        PIPELINE_EXECUTION_CANCELED = 'codepipeline-pipeline-pipeline-execution-canceled'
                                                                                                        • Trigger notification when pipeline execution canceled

                                                                                                        member PIPELINE_EXECUTION_FAILED

                                                                                                        PIPELINE_EXECUTION_FAILED = 'codepipeline-pipeline-pipeline-execution-failed'
                                                                                                        • Trigger notification when pipeline execution failed

                                                                                                        member PIPELINE_EXECUTION_RESUMED

                                                                                                        PIPELINE_EXECUTION_RESUMED = 'codepipeline-pipeline-pipeline-execution-resumed'
                                                                                                        • Trigger notification when pipeline execution resumed

                                                                                                        member PIPELINE_EXECUTION_STARTED

                                                                                                        PIPELINE_EXECUTION_STARTED = 'codepipeline-pipeline-pipeline-execution-started'
                                                                                                        • Trigger notification when pipeline execution started

                                                                                                        member PIPELINE_EXECUTION_SUCCEEDED

                                                                                                        PIPELINE_EXECUTION_SUCCEEDED = 'codepipeline-pipeline-pipeline-execution-succeeded'
                                                                                                        • Trigger notification when pipeline execution succeeded

                                                                                                        member PIPELINE_EXECUTION_SUPERSEDED

                                                                                                        PIPELINE_EXECUTION_SUPERSEDED = 'codepipeline-pipeline-pipeline-execution-superseded'
                                                                                                        • Trigger notification when pipeline execution superseded

                                                                                                        member STAGE_EXECUTION_CANCELED

                                                                                                        STAGE_EXECUTION_CANCELED = 'codepipeline-pipeline-stage-execution-canceled'
                                                                                                        • Trigger notification when pipeline stage execution canceled

                                                                                                        member STAGE_EXECUTION_FAILED

                                                                                                        STAGE_EXECUTION_FAILED = 'codepipeline-pipeline-stage-execution-failed'
                                                                                                        • Trigger notification when pipeline stage execution failed

                                                                                                        member STAGE_EXECUTION_RESUMED

                                                                                                        STAGE_EXECUTION_RESUMED = 'codepipeline-pipeline-stage-execution-resumed'
                                                                                                        • Trigger notification when pipeline stage execution resumed

                                                                                                        member STAGE_EXECUTION_STARTED

                                                                                                        STAGE_EXECUTION_STARTED = 'codepipeline-pipeline-stage-execution-started'
                                                                                                        • Trigger notification when pipeline stage execution started

                                                                                                        member STAGE_EXECUTION_SUCCEEDED

                                                                                                        STAGE_EXECUTION_SUCCEEDED = 'codepipeline-pipeline-stage-execution-succeeded'
                                                                                                        • Trigger notification when pipeline stage execution succeeded

                                                                                                        Namespaces

                                                                                                        namespace CfnCustomActionType

                                                                                                        namespace CfnCustomActionType {}

                                                                                                          interface ArtifactDetailsProperty

                                                                                                          interface ArtifactDetailsProperty {}
                                                                                                          • Returns information about the details of an artifact.

                                                                                                            external

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html

                                                                                                          property maximumCount

                                                                                                          readonly maximumCount: number;
                                                                                                          • The maximum number of artifacts allowed for the action type.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-maximumcount

                                                                                                          property minimumCount

                                                                                                          readonly minimumCount: number;
                                                                                                          • The minimum number of artifacts allowed for the action type.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-minimumcount

                                                                                                          interface ConfigurationPropertiesProperty

                                                                                                          interface ConfigurationPropertiesProperty {}
                                                                                                          • The configuration properties for the custom action.

                                                                                                            > You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see [Create a Custom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) .

                                                                                                            external

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html

                                                                                                          property description

                                                                                                          readonly description?: string;
                                                                                                          • The description of the action configuration property that is displayed to users.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-description

                                                                                                          property key

                                                                                                          readonly key: boolean | cdk.IResolvable;
                                                                                                          • Whether the configuration property is a key.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-key

                                                                                                          property name

                                                                                                          readonly name: string;
                                                                                                          • The name of the action configuration property.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-name

                                                                                                          property queryable

                                                                                                          readonly queryable?: boolean | cdk.IResolvable;
                                                                                                          • Indicates that the property is used with PollForJobs . When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

                                                                                                            If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable

                                                                                                          property required

                                                                                                          readonly required: boolean | cdk.IResolvable;
                                                                                                          • Whether the configuration property is a required value.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-required

                                                                                                          property secret

                                                                                                          readonly secret: boolean | cdk.IResolvable;
                                                                                                          • Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails , GetThirdPartyJobDetails , PollForJobs , and PollForThirdPartyJobs .

                                                                                                            When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-secret

                                                                                                          property type

                                                                                                          readonly type?: string;
                                                                                                          • The type of the configuration property.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-type

                                                                                                          interface SettingsProperty

                                                                                                          interface SettingsProperty {}
                                                                                                          • Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action.

                                                                                                            external

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html

                                                                                                          property entityUrlTemplate

                                                                                                          readonly entityUrlTemplate?: string;
                                                                                                          • The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-entityurltemplate

                                                                                                          property executionUrlTemplate

                                                                                                          readonly executionUrlTemplate?: string;
                                                                                                          • The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate

                                                                                                          property revisionUrlTemplate

                                                                                                          readonly revisionUrlTemplate?: string;
                                                                                                          • The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-revisionurltemplate

                                                                                                          property thirdPartyConfigurationUrl

                                                                                                          readonly thirdPartyConfigurationUrl?: string;
                                                                                                          • The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-thirdpartyconfigurationurl

                                                                                                          namespace CfnPipeline

                                                                                                          namespace CfnPipeline {}

                                                                                                            interface ActionDeclarationProperty

                                                                                                            interface ActionDeclarationProperty {}
                                                                                                            • Represents information about an action declaration.

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html

                                                                                                            property actionTypeId

                                                                                                            readonly actionTypeId: CfnPipeline.ActionTypeIdProperty | cdk.IResolvable;
                                                                                                            • Specifies the action type and the provider of the action.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid

                                                                                                            property configuration

                                                                                                            readonly configuration?: any | cdk.IResolvable;
                                                                                                            • The action's configuration. These are key-value pairs that specify input values for an action. For more information, see [Action Structure Requirements in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements) . For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see [Configuration Properties Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html) in the *AWS CloudFormation User Guide* . For template snippets with examples, see [Using Parameter Override Functions with CodePipeline Pipelines](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html) in the *AWS CloudFormation User Guide* .

                                                                                                              The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

                                                                                                              *JSON:*

                                                                                                              "Configuration" : { Key : Value },

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-configuration

                                                                                                            property inputArtifacts

                                                                                                            readonly inputArtifacts?:
                                                                                                            | Array<CfnPipeline.InputArtifactProperty | cdk.IResolvable>
                                                                                                            | cdk.IResolvable;
                                                                                                            • The name or ID of the artifact consumed by the action, such as a test or build artifact.

                                                                                                              > For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the [CodeBuild action reference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User Guide* .

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts

                                                                                                            property name

                                                                                                            readonly name: string;
                                                                                                            • The action declaration's name.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-name

                                                                                                            property namespace

                                                                                                            readonly namespace?: string;
                                                                                                            • The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-actiondeclaration-namespace

                                                                                                            property outputArtifacts

                                                                                                            readonly outputArtifacts?:
                                                                                                            | Array<CfnPipeline.OutputArtifactProperty | cdk.IResolvable>
                                                                                                            | cdk.IResolvable;
                                                                                                            • The name or ID of the result of the action declaration, such as a test or build artifact.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts

                                                                                                            property region

                                                                                                            readonly region?: string;
                                                                                                            • The action declaration's AWS Region, such as us-east-1.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-region

                                                                                                            property roleArn

                                                                                                            readonly roleArn?: string;
                                                                                                            • The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-rolearn

                                                                                                            property runOrder

                                                                                                            readonly runOrder?: number;
                                                                                                            • The order in which actions are run.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-runorder

                                                                                                            interface ActionTypeIdProperty

                                                                                                            interface ActionTypeIdProperty {}
                                                                                                            • Represents information about an action type.

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html

                                                                                                            property category

                                                                                                            readonly category: string;
                                                                                                            • A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.

                                                                                                              - Source - Build - Test - Deploy - Invoke - Approval

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-category

                                                                                                            property owner

                                                                                                            readonly owner: string;
                                                                                                            • The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS , ThirdParty , and Custom . For more information, see [Valid Action Types and Providers in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers) .

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-owner

                                                                                                            property provider

                                                                                                            readonly provider: string;
                                                                                                            • The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy . For more information, see [Valid Action Types and Providers in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers) .

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-provider

                                                                                                            property version

                                                                                                            readonly version: string;
                                                                                                            • A string that describes the action version.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-version

                                                                                                            interface ArtifactStoreMapProperty

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

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html

                                                                                                            property artifactStore

                                                                                                            readonly artifactStore: CfnPipeline.ArtifactStoreProperty | cdk.IResolvable;
                                                                                                            • 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 .

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-artifactstore

                                                                                                            property region

                                                                                                            readonly region: string;
                                                                                                            • The action declaration's AWS Region, such as us-east-1.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-region

                                                                                                            interface ArtifactStoreProperty

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

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html

                                                                                                            property encryptionKey

                                                                                                            readonly encryptionKey?: CfnPipeline.EncryptionKeyProperty | cdk.IResolvable;
                                                                                                            • The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key. If this is undefined, the default key for Amazon S3 is used. To see an example artifact store encryption key field, see the example structure here: [AWS::CodePipeline::Pipeline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html) .

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey

                                                                                                            property location

                                                                                                            readonly location: string;
                                                                                                            • The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-location

                                                                                                            property type

                                                                                                            readonly type: string;
                                                                                                            • The type of the artifact store, such as S3.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-type

                                                                                                            interface BlockerDeclarationProperty

                                                                                                            interface BlockerDeclarationProperty {}
                                                                                                            • Reserved for future use.

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html

                                                                                                            property name

                                                                                                            readonly name: string;
                                                                                                            • Reserved for future use.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-name

                                                                                                            property type

                                                                                                            readonly type: string;
                                                                                                            • Reserved for future use.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-type

                                                                                                            interface EncryptionKeyProperty

                                                                                                            interface EncryptionKeyProperty {}
                                                                                                            • Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.

                                                                                                              EncryptionKey is a property of the [ArtifactStore](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html) property type.

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html

                                                                                                            property id

                                                                                                            readonly id: string;
                                                                                                            • The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.

                                                                                                              > Aliases are recognized only in the account that created the AWS KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-id

                                                                                                            property type

                                                                                                            readonly type: string;
                                                                                                            • The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-type

                                                                                                            interface InputArtifactProperty

                                                                                                            interface InputArtifactProperty {}
                                                                                                            • Represents information about an artifact to be worked on, such as a test or build artifact.

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html

                                                                                                            property name

                                                                                                            readonly name: string;
                                                                                                            • The name of the artifact to be worked on (for example, "My App").

                                                                                                              The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts-name

                                                                                                            interface OutputArtifactProperty

                                                                                                            interface OutputArtifactProperty {}
                                                                                                            • Represents information about the output of an action.

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html

                                                                                                            property name

                                                                                                            readonly name: string;
                                                                                                            • The name of the output of an artifact, such as "My App".

                                                                                                              The output artifact name must exactly match the input artifact declared for a downstream action. However, the downstream action's input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

                                                                                                              Output artifact names must be unique within a pipeline.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts-name

                                                                                                            interface StageDeclarationProperty

                                                                                                            interface StageDeclarationProperty {}
                                                                                                            • Represents information about a stage and its definition.

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html

                                                                                                            property actions

                                                                                                            readonly actions:
                                                                                                            | Array<CfnPipeline.ActionDeclarationProperty | cdk.IResolvable>
                                                                                                            | cdk.IResolvable;
                                                                                                            • The actions included in a stage.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-actions

                                                                                                            property blockers

                                                                                                            readonly blockers?:
                                                                                                            | Array<CfnPipeline.BlockerDeclarationProperty | cdk.IResolvable>
                                                                                                            | cdk.IResolvable;
                                                                                                            • Reserved for future use.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-blockers

                                                                                                            property name

                                                                                                            readonly name: string;
                                                                                                            • The name of the stage.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-name

                                                                                                            interface StageTransitionProperty

                                                                                                            interface StageTransitionProperty {}
                                                                                                            • The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

                                                                                                              external

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html

                                                                                                            property reason

                                                                                                            readonly reason: string;
                                                                                                            • The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-reason

                                                                                                            property stageName

                                                                                                            readonly stageName: string;
                                                                                                            • The name of the stage where you want to disable the inbound or outbound transition of artifacts.

                                                                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-stagename

                                                                                                            namespace CfnWebhook

                                                                                                            namespace CfnWebhook {}

                                                                                                              interface WebhookAuthConfigurationProperty

                                                                                                              interface WebhookAuthConfigurationProperty {}
                                                                                                              • The authentication applied to incoming webhook trigger requests.

                                                                                                                external

                                                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html

                                                                                                              property allowedIpRange

                                                                                                              readonly allowedIpRange?: string;
                                                                                                              • The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.

                                                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-allowediprange

                                                                                                              property secretToken

                                                                                                              readonly secretToken?: string;
                                                                                                              • The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.

                                                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-secrettoken

                                                                                                              interface WebhookFilterRuleProperty

                                                                                                              interface WebhookFilterRuleProperty {}
                                                                                                              • The event criteria that specify when a webhook notification is sent to your URL.

                                                                                                                external

                                                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html

                                                                                                              property jsonPath

                                                                                                              readonly jsonPath: string;
                                                                                                              • A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see [Java JsonPath implementation](https://docs.aws.amazon.com/https://github.com/json-path/JsonPath) in GitHub.

                                                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-jsonpath

                                                                                                              property matchEquals

                                                                                                              readonly matchEquals?: string;
                                                                                                              • The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see [Pipeline Structure Reference Action Requirements](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements) .

                                                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-matchequals

                                                                                                              Package Files (6)

                                                                                                              Dependencies (7)

                                                                                                              Dev Dependencies (8)

                                                                                                              Peer Dependencies (7)

                                                                                                              Badge

                                                                                                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-cdk/aws-codepipeline.

                                                                                                              • Markdown
                                                                                                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-cdk/aws-codepipeline)
                                                                                                              • HTML
                                                                                                                <a href="https://www.jsdocs.io/package/@aws-cdk/aws-codepipeline"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>