This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-codepipeline

AWS CodePipeline Construct Library

Pipeline

To construct an empty Pipeline:

import codepipeline = require('@aws-cdk/aws-codepipeline');

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

To give the Pipeline a nice, human-readable name:

const pipeline = new codepipeline.Pipeline(this, 'MyFirstPipeline', {
  pipelineName: 'MyPipeline',
});

Stages

You can provide Stages when creating the Pipeline:

const pipeline = new codepipeline.Pipeline(this, 'MyFirstPipeline', {
  stages: [
    {
      name: 'Source',
      actions: [
        // see below...
      ],
    },
  ],
});

Or append a Stage to an existing Pipeline:

const sourceStage = pipeline.addStage({
  name: 'Source',
  actions: [ // optional property
    // see below...
  ],
});

You can insert the new Stage at an arbitrary point in the Pipeline:

const someStage = pipeline.addStage({
  name: 'SomeStage',
  placement: {
    // note: you can only specify one of the below properties
    rightBefore: anotherStage,
    justAfter: anotherStage,
    atIndex: 3, // indexing starts at 0
                // pipeline.stageCount returns the number of Stages currently in the Pipeline
  }
});

Actions

Actions live in a separate package, @aws-cdk/aws-codepipeline-actions.

To add an Action to a Stage, you can provide it when creating the Stage, in the actions property, or you can use the IStage.addAction() method to mutate an existing Stage:

sourceStage.addAction(someAction);

Cross-region CodePipelines

You can also use the cross-region feature to deploy resources (currently, only CloudFormation Stacks are supported) into a different region than your Pipeline is in.

It works like this:

const pipeline = new codepipeline.Pipeline(this, 'MyFirstPipeline', {
  // ...
  crossRegionReplicationBuckets: {
    'us-west-1': 'my-us-west-1-replication-bucket',
  },
});

// later in the code...
new codepipeline_actions.CloudFormationCreateUpdateStackAction({
  actionName: 'CFN_US_West_1',
  // ...
  region: 'us-west-1',
});

This way, the CFN_US_West_1 Action will operate in the us-west-1 region, regardless of which region your Pipeline is in.

If you don’t provide a bucket name for a region (other than the Pipeline’s region) that you’re using for an Action with the crossRegionReplicationBuckets property, there will be a new Stack, named aws-cdk-codepipeline-cross-region-scaffolding-<region>, defined for you, containing a replication Bucket. Note that you have to make sure to cdk deploy all of these automatically created Stacks before you can deploy your main Stack (the one containing your Pipeline). Use the cdk ls command to see all of the Stacks comprising your CDK application. Example:

$ cdk ls
MyMainStack
aws-cdk-codepipeline-cross-region-scaffolding-us-west-1
$ cdk deploy aws-cdk-codepipeline-cross-region-scaffolding-us-west-1
# output of cdk deploy here...
$ cdk deploy MyMainStack

See the AWS docs here for more information on cross-region CodePipelines.

Events

Using a pipeline as an event target

A pipeline can be used as a target for a CloudWatch event rule:

// kick off the pipeline every day
const rule = new EventRule(this, 'Daily', { scheduleExpression: 'rate(1 day)' });
rule.addTarget(pipeline);

When a pipeline is used as an event target, the “codepipeline:StartPipelineExecution” permission is granted to the AWS CloudWatch Events service.

Event sources

Pipelines emit CloudWatch events. To define event rules for events emitted by the pipeline, stages or action, use the onXxx methods on the respective construct:

myPipeline.onStateChange('MyPipelineStateChage', target);
myStage.onStateChange('MyStageStateChange', target);
myAction.onStateChange('MyActioStateChange', target);

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.CodePipeline" Version="0.28.0" />

dotnet:

dotnet add package Amazon.CDK.AWS.CodePipeline --version 0.28.0

packages.config:

<package id="Amazon.CDK.AWS.CodePipeline" version="0.28.0" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:codepipeline:jar:0.28.0'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="codepipeline" rev="0.28.0"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>codepipeline</artifactId>
  <version>0.28.0</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:codepipeline:0.28.0'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='codepipeline', version='0.28.0')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-codepipeline@0.28.0

package.json:

{
  "@aws-cdk/aws-codepipeline": "^0.28.0"
}

yarn:

$ yarn add @aws-cdk/aws-codepipeline@0.28.0

View in NPM

npm:

$ npm i @aws-cdk/aws-codepipeline@0.28.0

package.json:

{
  "@aws-cdk/aws-codepipeline": "^0.28.0"
}

yarn:

$ yarn add @aws-cdk/aws-codepipeline@0.28.0

Action

class @aws-cdk/aws-codepipeline.Action(props)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.Action;
const { Action } = require('@aws-cdk/aws-codepipeline');
import { Action } from '@aws-cdk/aws-codepipeline';

Low-level class for generic CodePipeline Actions.

It is recommended that concrete types are used instead, such as {@link codecommit.PipelineSourceAction} or

{@link codebuild.PipelineBuildAction}.

Abstract:Yes
Parameters:props (ActionProps) –
addInputArtifact(artifact) → @aws-cdk/aws-codepipeline.Action

Protected method

Parameters:artifact (Artifact) –
Return type:Action
addOutputArtifact(name) → @aws-cdk/aws-codepipeline.Artifact

Protected method

Parameters:name (string) –
Return type:Artifact
bind(info)

The method called when an Action is attached to a Pipeline.

This method is guaranteed to be called only once for each Action instance.

Protected method

Parameters:info (ActionBind) –
Abstract:Yes
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule
Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

Protected method

Return type:string[]
actionInputArtifacts

Protected property

Type:Artifact[] (readonly)
actionName
Type:string (readonly)
actionOutputArtifacts

Protected property

Type:Artifact[] (readonly)
category

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:ActionCategory (readonly)
owner
Type:string (readonly)
provider

The service provider that the action calls.

Type:string (readonly)
runOrder

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

Type:number (readonly)
scope

Retrieves the Construct scope of this Action.

Only available after the Action has been added to a Stage,

and that Stage to a Pipeline.

Protected property

Type:@aws-cdk/cdk.Construct (readonly)
version
Type:string (readonly)
configuration

The action’s configuration. These are key-value pairs that specify input values for an action.

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional) (readonly)
region

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 {@link 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.

Type:string (optional) (readonly)
Default:the Action resides in the same region as the Pipeline
role

The service role that is assumed during execution of action.

This role is not mandatory, however more advanced configuration

may require specifying it.

Type:@aws-cdk/aws-iam.IRole (optional) (readonly)

ActionArtifactBounds (interface)

class @aws-cdk/aws-codepipeline.ActionArtifactBounds

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.ActionArtifactBounds;
// ActionArtifactBounds is an interface
import { ActionArtifactBounds } from '@aws-cdk/aws-codepipeline';

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

{@link https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html Pipeline Structure Reference} page.

maxInputs
Type:number (readonly)
maxOutputs
Type:number (readonly)
minInputs
Type:number (readonly)
minOutputs
Type:number (readonly)

ActionBind (interface)

class @aws-cdk/aws-codepipeline.ActionBind

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.ActionBind;
// ActionBind is an interface
import { ActionBind } from '@aws-cdk/aws-codepipeline';

The interface used in the {@link Action#bind()} callback.

pipeline

The pipeline this action has been added to.

Type:IPipeline (readonly)
role

The IAM Role to add the necessary permissions to.

Type:@aws-cdk/aws-iam.IRole (readonly)
scope

The scope construct for this action.

Can be used by the action implementation to create any resources it needs to work correctly.

Type:@aws-cdk/cdk.Construct (readonly)
stage

The stage this action has been added to.

Type:IStage (readonly)

ActionCategory (enum)

class @aws-cdk/aws-codepipeline.ActionCategory

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.ActionCategory;
const { ActionCategory } = require('@aws-cdk/aws-codepipeline');
import { ActionCategory } from '@aws-cdk/aws-codepipeline';
Source
Build
Test
Approval
Deploy
Invoke

ActionProps (interface)

class @aws-cdk/aws-codepipeline.ActionProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.ActionProps;
// ActionProps is an interface
import { ActionProps } from '@aws-cdk/aws-codepipeline';

Construction properties of the low-level {@link Action Action class}.

Extends:CommonActionProps
artifactBounds
Type:ActionArtifactBounds (readonly)
category
Type:ActionCategory (readonly)
provider
Type:string (readonly)
configuration
Type:any (optional) (readonly)
owner
Type:string (optional) (readonly)
region

The region this Action resides in.

Type:string (optional) (readonly)
Default:the Action resides in the same region as the Pipeline
role

The service role that is assumed during execution of action.

This role is not mandatory, however more advanced configuration

may require specifying it.

Type:@aws-cdk/aws-iam.IRole (optional) (readonly)
version
Type:string (optional) (readonly)
actionName

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The physical, human-readable name of the Action.

Not that Action names must be unique within a single Stage.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Type:number (optional) (readonly)
Default:1

Artifact

class @aws-cdk/aws-codepipeline.Artifact(artifactName)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.Artifact;
const { Artifact } = require('@aws-cdk/aws-codepipeline');
import { Artifact } from '@aws-cdk/aws-codepipeline';

An output artifact of an action. Artifacts can be used as input by some actions.

Parameters:artifactName (string) –
atPath(fileName) → @aws-cdk/aws-codepipeline.ArtifactPath

Returns an ArtifactPath for a file within this artifact.

CfnOutput is in the form “<artifact-name>::<file-name>”

Parameters:fileName (string) – The name of the file
Return type:ArtifactPath
getParam(jsonFile, keyName) → string

Returns a token for a value inside a JSON file within this artifact.

Parameters:
  • jsonFile (string) – The JSON file name.
  • keyName (string) – The hash key.
Return type:

string

toString() → string
Return type:string
artifactName
Type:string (readonly)
bucketName

The artifact attribute for the name of the S3 bucket where the artifact is stored.

Type:string (readonly)
objectKey

The artifact attribute for The name of the .zip file that contains the artifact that is

generated by AWS CodePipeline, such as 1ABCyZZ.zip.

Type:string (readonly)
url

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.

Type:string (readonly)

ArtifactPath

class @aws-cdk/aws-codepipeline.ArtifactPath(artifact, fileName)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.ArtifactPath;
const { ArtifactPath } = require('@aws-cdk/aws-codepipeline');
import { ArtifactPath } from '@aws-cdk/aws-codepipeline';

A specific file within an output artifact.

The most common use case for this is specifying the template file

for a CloudFormation action.

Parameters:
  • artifact (Artifact) –
  • fileName (string) –
artifact
Type:Artifact (readonly)
fileName
Type:string (readonly)
location
Type:string (readonly)

BuildAction

class @aws-cdk/aws-codepipeline.BuildAction(props)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.BuildAction;
const { BuildAction } = require('@aws-cdk/aws-codepipeline');
import { BuildAction } from '@aws-cdk/aws-codepipeline';

Low level class for build actions.

It is recommended that concrete types are used instead,

such as {@link codebuild.PipelineBuildAction}.

Extends:Action
Abstract:Yes
Parameters:props (BuildActionProps) –
outputArtifact
Type:Artifact (readonly)
addInputArtifact(artifact) → @aws-cdk/aws-codepipeline.Action

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Parameters:artifact (Artifact) –
Return type:Action
addOutputArtifact(name) → @aws-cdk/aws-codepipeline.Artifact

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Parameters:name (string) –
Return type:Artifact
bind(info)

Inherited from @aws-cdk/aws-codepipeline.Action

The method called when an Action is attached to a Pipeline.

This method is guaranteed to be called only once for each Action instance.

Protected method

Parameters:info (ActionBind) –
Abstract:Yes
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

Inherited from @aws-cdk/aws-codepipeline.Action

Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Return type:string[]
actionInputArtifacts

Inherited from @aws-cdk/aws-codepipeline.Action

Protected property

Type:Artifact[] (readonly)
actionName

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
actionOutputArtifacts

Inherited from @aws-cdk/aws-codepipeline.Action

Protected property

Type:Artifact[] (readonly)
category

Inherited from @aws-cdk/aws-codepipeline.Action

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:ActionCategory (readonly)
owner

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
provider

Inherited from @aws-cdk/aws-codepipeline.Action

The service provider that the action calls.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline.Action

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

Type:number (readonly)
scope

Inherited from @aws-cdk/aws-codepipeline.Action

Retrieves the Construct scope of this Action.

Only available after the Action has been added to a Stage,

and that Stage to a Pipeline.

Protected property

Type:@aws-cdk/cdk.Construct (readonly)
version

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
configuration

Inherited from @aws-cdk/aws-codepipeline.Action

The action’s configuration. These are key-value pairs that specify input values for an action.

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional) (readonly)
region

Inherited from @aws-cdk/aws-codepipeline.Action

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 {@link 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.

Type:string (optional) (readonly)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-codepipeline.Action

The service role that is assumed during execution of action.

This role is not mandatory, however more advanced configuration

may require specifying it.

Type:@aws-cdk/aws-iam.IRole (optional) (readonly)

BuildActionProps (interface)

class @aws-cdk/aws-codepipeline.BuildActionProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.BuildActionProps;
// BuildActionProps is an interface
import { BuildActionProps } from '@aws-cdk/aws-codepipeline';

Construction properties of the low level {@link BuildAction build action}.

Extends:CommonActionProps
artifactBounds

The upper and lower bounds on the number of input and output artifacts for this Action.

Type:ActionArtifactBounds (readonly)
inputArtifact

The source to use as input for this build.

Type:Artifact (readonly)
outputArtifactName

The name of the build’s output artifact.

Type:string (readonly)
provider

The service provider that the action calls. For example, a valid provider for Source actions is CodeBuild.

Type:string (readonly)
configuration

The action’s configuration. These are key-value pairs that specify input values for an action.

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional) (readonly)
owner

The build Action owner (could be ‘AWS’, ‘ThirdParty’ or ‘Custom’).

Type:string (optional) (readonly)
Default:‘AWS’
version

The build Action version.

Type:string (optional) (readonly)
Default:‘1’
actionName

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The physical, human-readable name of the Action.

Not that Action names must be unique within a single Stage.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Type:number (optional) (readonly)
Default:1

CfnCustomActionType

class @aws-cdk/aws-codepipeline.CfnCustomActionType(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnCustomActionType;
const { CfnCustomActionType } = require('@aws-cdk/aws-codepipeline');
import { CfnCustomActionType } from '@aws-cdk/aws-codepipeline';

A CloudFormation AWS::CodePipeline::CustomActionType

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
customActionTypeName
Type:string (readonly)
propertyOverrides
Type:CfnCustomActionTypeProps (readonly)
class ArtifactDetailsProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnCustomActionType.ArtifactDetailsProperty;
// CfnCustomActionType.ArtifactDetailsProperty is an interface
import { CfnCustomActionType.ArtifactDetailsProperty } from '@aws-cdk/aws-codepipeline';
maximumCount

CfnCustomActionType.ArtifactDetailsProperty.MaximumCount

Type:number or @aws-cdk/cdk.Token (readonly)
minimumCount

CfnCustomActionType.ArtifactDetailsProperty.MinimumCount

Type:number or @aws-cdk/cdk.Token (readonly)
class ConfigurationPropertiesProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnCustomActionType.ConfigurationPropertiesProperty;
// CfnCustomActionType.ConfigurationPropertiesProperty is an interface
import { CfnCustomActionType.ConfigurationPropertiesProperty } from '@aws-cdk/aws-codepipeline';
key

CfnCustomActionType.ConfigurationPropertiesProperty.Key

Type:boolean or @aws-cdk/cdk.Token (readonly)
name

CfnCustomActionType.ConfigurationPropertiesProperty.Name

Type:string (readonly)
required

CfnCustomActionType.ConfigurationPropertiesProperty.Required

Type:boolean or @aws-cdk/cdk.Token (readonly)
secret

CfnCustomActionType.ConfigurationPropertiesProperty.Secret

Type:boolean or @aws-cdk/cdk.Token (readonly)
description

CfnCustomActionType.ConfigurationPropertiesProperty.Description

Type:string (optional) (readonly)
queryable

CfnCustomActionType.ConfigurationPropertiesProperty.Queryable

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
type

CfnCustomActionType.ConfigurationPropertiesProperty.Type

Type:string (optional) (readonly)
class SettingsProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnCustomActionType.SettingsProperty;
// CfnCustomActionType.SettingsProperty is an interface
import { CfnCustomActionType.SettingsProperty } from '@aws-cdk/aws-codepipeline';
entityUrlTemplate

CfnCustomActionType.SettingsProperty.EntityUrlTemplate

Type:string (optional) (readonly)
executionUrlTemplate

CfnCustomActionType.SettingsProperty.ExecutionUrlTemplate

Type:string (optional) (readonly)
revisionUrlTemplate

CfnCustomActionType.SettingsProperty.RevisionUrlTemplate

Type:string (optional) (readonly)
thirdPartyConfigurationUrl

CfnCustomActionType.SettingsProperty.ThirdPartyConfigurationUrl

Type:string (optional) (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnCustomActionTypeProps (interface)

class @aws-cdk/aws-codepipeline.CfnCustomActionTypeProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnCustomActionTypeProps;
// CfnCustomActionTypeProps is an interface
import { CfnCustomActionTypeProps } from '@aws-cdk/aws-codepipeline';

Properties for defining a AWS::CodePipeline::CustomActionType

category

AWS::CodePipeline::CustomActionType.Category

Type:string (readonly)
inputArtifactDetails

AWS::CodePipeline::CustomActionType.InputArtifactDetails

Type:@aws-cdk/cdk.Token or ArtifactDetailsProperty (readonly)
outputArtifactDetails

AWS::CodePipeline::CustomActionType.OutputArtifactDetails

Type:@aws-cdk/cdk.Token or ArtifactDetailsProperty (readonly)
provider

AWS::CodePipeline::CustomActionType.Provider

Type:string (readonly)
configurationProperties

AWS::CodePipeline::CustomActionType.ConfigurationProperties

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ConfigurationPropertiesProperty)[] (optional) (readonly)
settings

AWS::CodePipeline::CustomActionType.Settings

Type:@aws-cdk/cdk.Token or SettingsProperty (optional) (readonly)
version

AWS::CodePipeline::CustomActionType.Version

Type:string (optional) (readonly)

CfnPipeline

class @aws-cdk/aws-codepipeline.CfnPipeline(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline;
const { CfnPipeline } = require('@aws-cdk/aws-codepipeline');
import { CfnPipeline } from '@aws-cdk/aws-codepipeline';

A CloudFormation AWS::CodePipeline::Pipeline

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
pipelineName
Type:string (readonly)
pipelineVersion
Type:string (readonly)
propertyOverrides
Type:CfnPipelineProps (readonly)
class ActionDeclarationProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.ActionDeclarationProperty;
// CfnPipeline.ActionDeclarationProperty is an interface
import { CfnPipeline.ActionDeclarationProperty } from '@aws-cdk/aws-codepipeline';
actionTypeId

CfnPipeline.ActionDeclarationProperty.ActionTypeId

Type:@aws-cdk/cdk.Token or ActionTypeIdProperty (readonly)
name

CfnPipeline.ActionDeclarationProperty.Name

Type:string (readonly)
configuration

CfnPipeline.ActionDeclarationProperty.Configuration

Type:json or @aws-cdk/cdk.Token (optional) (readonly)
inputArtifacts

CfnPipeline.ActionDeclarationProperty.InputArtifacts

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or InputArtifactProperty)[] (optional) (readonly)
outputArtifacts

CfnPipeline.ActionDeclarationProperty.OutputArtifacts

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or OutputArtifactProperty)[] (optional) (readonly)
region

CfnPipeline.ActionDeclarationProperty.Region

Type:string (optional) (readonly)
roleArn

CfnPipeline.ActionDeclarationProperty.RoleArn

Type:string (optional) (readonly)
runOrder

CfnPipeline.ActionDeclarationProperty.RunOrder

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
class ActionTypeIdProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.ActionTypeIdProperty;
// CfnPipeline.ActionTypeIdProperty is an interface
import { CfnPipeline.ActionTypeIdProperty } from '@aws-cdk/aws-codepipeline';
category

CfnPipeline.ActionTypeIdProperty.Category

Type:string (readonly)
owner

CfnPipeline.ActionTypeIdProperty.Owner

Type:string (readonly)
provider

CfnPipeline.ActionTypeIdProperty.Provider

Type:string (readonly)
version

CfnPipeline.ActionTypeIdProperty.Version

Type:string (readonly)
class ArtifactStoreMapProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.ArtifactStoreMapProperty;
// CfnPipeline.ArtifactStoreMapProperty is an interface
import { CfnPipeline.ArtifactStoreMapProperty } from '@aws-cdk/aws-codepipeline';
artifactStore

CfnPipeline.ArtifactStoreMapProperty.ArtifactStore

Type:@aws-cdk/cdk.Token or ArtifactStoreProperty (readonly)
region

CfnPipeline.ArtifactStoreMapProperty.Region

Type:string (readonly)
class ArtifactStoreProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.ArtifactStoreProperty;
// CfnPipeline.ArtifactStoreProperty is an interface
import { CfnPipeline.ArtifactStoreProperty } from '@aws-cdk/aws-codepipeline';
location

CfnPipeline.ArtifactStoreProperty.Location

Type:string (readonly)
type

CfnPipeline.ArtifactStoreProperty.Type

Type:string (readonly)
encryptionKey

CfnPipeline.ArtifactStoreProperty.EncryptionKey

Type:@aws-cdk/cdk.Token or EncryptionKeyProperty (optional) (readonly)
class BlockerDeclarationProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.BlockerDeclarationProperty;
// CfnPipeline.BlockerDeclarationProperty is an interface
import { CfnPipeline.BlockerDeclarationProperty } from '@aws-cdk/aws-codepipeline';
name

CfnPipeline.BlockerDeclarationProperty.Name

Type:string (readonly)
type

CfnPipeline.BlockerDeclarationProperty.Type

Type:string (readonly)
class EncryptionKeyProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.EncryptionKeyProperty;
// CfnPipeline.EncryptionKeyProperty is an interface
import { CfnPipeline.EncryptionKeyProperty } from '@aws-cdk/aws-codepipeline';
id

CfnPipeline.EncryptionKeyProperty.Id

Type:string (readonly)
type

CfnPipeline.EncryptionKeyProperty.Type

Type:string (readonly)
class InputArtifactProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.InputArtifactProperty;
// CfnPipeline.InputArtifactProperty is an interface
import { CfnPipeline.InputArtifactProperty } from '@aws-cdk/aws-codepipeline';
name

CfnPipeline.InputArtifactProperty.Name

Type:string (readonly)
class OutputArtifactProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.OutputArtifactProperty;
// CfnPipeline.OutputArtifactProperty is an interface
import { CfnPipeline.OutputArtifactProperty } from '@aws-cdk/aws-codepipeline';
name

CfnPipeline.OutputArtifactProperty.Name

Type:string (readonly)
class StageDeclarationProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.StageDeclarationProperty;
// CfnPipeline.StageDeclarationProperty is an interface
import { CfnPipeline.StageDeclarationProperty } from '@aws-cdk/aws-codepipeline';
actions

CfnPipeline.StageDeclarationProperty.Actions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ActionDeclarationProperty)[] (readonly)
name

CfnPipeline.StageDeclarationProperty.Name

Type:string (readonly)
blockers

CfnPipeline.StageDeclarationProperty.Blockers

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or BlockerDeclarationProperty)[] (optional) (readonly)
class StageTransitionProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipeline.StageTransitionProperty;
// CfnPipeline.StageTransitionProperty is an interface
import { CfnPipeline.StageTransitionProperty } from '@aws-cdk/aws-codepipeline';
reason

CfnPipeline.StageTransitionProperty.Reason

Type:string (readonly)
stageName

CfnPipeline.StageTransitionProperty.StageName

Type:string (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnPipelineProps (interface)

class @aws-cdk/aws-codepipeline.CfnPipelineProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnPipelineProps;
// CfnPipelineProps is an interface
import { CfnPipelineProps } from '@aws-cdk/aws-codepipeline';

Properties for defining a AWS::CodePipeline::Pipeline

roleArn

AWS::CodePipeline::Pipeline.RoleArn

Type:string (readonly)
stages

AWS::CodePipeline::Pipeline.Stages

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or StageDeclarationProperty)[] (readonly)
artifactStore

AWS::CodePipeline::Pipeline.ArtifactStore

Type:@aws-cdk/cdk.Token or ArtifactStoreProperty (optional) (readonly)
artifactStores

AWS::CodePipeline::Pipeline.ArtifactStores

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ArtifactStoreMapProperty)[] (optional) (readonly)
disableInboundStageTransitions

AWS::CodePipeline::Pipeline.DisableInboundStageTransitions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or StageTransitionProperty)[] (optional) (readonly)
name

AWS::CodePipeline::Pipeline.Name

Type:string (optional) (readonly)
restartExecutionOnUpdate

AWS::CodePipeline::Pipeline.RestartExecutionOnUpdate

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)

CfnWebhook

class @aws-cdk/aws-codepipeline.CfnWebhook(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnWebhook;
const { CfnWebhook } = require('@aws-cdk/aws-codepipeline');
import { CfnWebhook } from '@aws-cdk/aws-codepipeline';

A CloudFormation AWS::CodePipeline::Webhook

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnWebhookProps (readonly)
webhookName
Type:string (readonly)
webhookUrl
Type:string (readonly)
class WebhookAuthConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnWebhook.WebhookAuthConfigurationProperty;
// CfnWebhook.WebhookAuthConfigurationProperty is an interface
import { CfnWebhook.WebhookAuthConfigurationProperty } from '@aws-cdk/aws-codepipeline';
allowedIpRange

CfnWebhook.WebhookAuthConfigurationProperty.AllowedIPRange

Type:string (optional) (readonly)
secretToken

CfnWebhook.WebhookAuthConfigurationProperty.SecretToken

Type:string (optional) (readonly)
class WebhookFilterRuleProperty

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnWebhook.WebhookFilterRuleProperty;
// CfnWebhook.WebhookFilterRuleProperty is an interface
import { CfnWebhook.WebhookFilterRuleProperty } from '@aws-cdk/aws-codepipeline';
jsonPath

CfnWebhook.WebhookFilterRuleProperty.JsonPath

Type:string (readonly)
matchEquals

CfnWebhook.WebhookFilterRuleProperty.MatchEquals

Type:string (optional) (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnWebhookProps (interface)

class @aws-cdk/aws-codepipeline.CfnWebhookProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CfnWebhookProps;
// CfnWebhookProps is an interface
import { CfnWebhookProps } from '@aws-cdk/aws-codepipeline';

Properties for defining a AWS::CodePipeline::Webhook

authentication

AWS::CodePipeline::Webhook.Authentication

Type:string (readonly)
authenticationConfiguration

AWS::CodePipeline::Webhook.AuthenticationConfiguration

Type:@aws-cdk/cdk.Token or WebhookAuthConfigurationProperty (readonly)
filters

AWS::CodePipeline::Webhook.Filters

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or WebhookFilterRuleProperty)[] (readonly)
targetAction

AWS::CodePipeline::Webhook.TargetAction

Type:string (readonly)
targetPipeline

AWS::CodePipeline::Webhook.TargetPipeline

Type:string (readonly)
targetPipelineVersion

AWS::CodePipeline::Webhook.TargetPipelineVersion

Type:number or @aws-cdk/cdk.Token (readonly)
name

AWS::CodePipeline::Webhook.Name

Type:string (optional) (readonly)
registerWithThirdParty

AWS::CodePipeline::Webhook.RegisterWithThirdParty

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)

CommonActionProps (interface)

class @aws-cdk/aws-codepipeline.CommonActionProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CommonActionProps;
// CommonActionProps is an interface
import { CommonActionProps } from '@aws-cdk/aws-codepipeline';

Common properties shared by all Actions.

actionName

The physical, human-readable name of the Action.

Not that Action names must be unique within a single Stage.

Type:string (readonly)
runOrder

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Type:number (optional) (readonly)
Default:1

CrossRegionScaffoldStack

class @aws-cdk/aws-codepipeline.CrossRegionScaffoldStack(scope, props)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CrossRegionScaffoldStack;
const { CrossRegionScaffoldStack } = require('@aws-cdk/aws-codepipeline');
import { CrossRegionScaffoldStack } from '@aws-cdk/aws-codepipeline';

A Stack containing resources required for the cross-region CodePipeline functionality to work.

Extends:

@aws-cdk/cdk.Stack

Parameters:
replicationBucketName

The name of the S3 Bucket used for replicating the Pipeline’s artifacts into the region.

Type:string (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
addDependency(stack[, reason])

Inherited from @aws-cdk/cdk.Stack

Add a dependency between this stack and another stack

Parameters:
dependencies() → @aws-cdk/cdk.Stack[]

Inherited from @aws-cdk/cdk.Stack

Return the stacks this stack depends on

Return type:@aws-cdk/cdk.Stack[]
findResource(path) → @aws-cdk/cdk.CfnResource

Inherited from @aws-cdk/cdk.Stack

Looks up a resource by path.

Parameters:path (string) –
Returns:The Resource or undefined if not found
Return type:@aws-cdk/cdk.CfnResource (optional)
formatArn(components) → string

Inherited from @aws-cdk/cdk.Stack

Creates an ARN from components.

If partition, region or account are not specified, the stack’s

partition, region and account will be used.

If any component is the empty string, an empty string will be inserted

into the generated ARN at the location that component corresponds to.

The ARN will be formatted as follows:

arn:{partition}:{service}:{region}:{account}:{resource}{sep}}{resource-name}

The required ARN pieces that are omitted will be taken from the stack that

the ‘scope’ is attached to. If all ARN pieces are supplied, the supplied scope

can be ‘undefined’.

Parameters:components (@aws-cdk/cdk.ArnComponents) –
Return type:string
parentApp() → @aws-cdk/cdk.App

Inherited from @aws-cdk/cdk.Stack

Return type:@aws-cdk/cdk.App (optional)
parseArn(arn[, sepIfToken[, hasName]]) → @aws-cdk/cdk.ArnComponents

Inherited from @aws-cdk/cdk.Stack

Given an ARN, parses it and returns components.

If the ARN is a concrete string, it will be parsed and validated. The

separator (sep) will be set to ‘/’ if the 6th component includes a ‘/’,

in which case, resource will be set to the value before the ‘/’ and

resourceName will be the rest. In case there is no ‘/’, resource will

be set to the 6th components and resourceName will be set to the rest

of the string.

If the ARN includes tokens (or is a token), the ARN cannot be validated,

since we don’t have the actual value yet at the time of this function

call. You will have to know the separator and the type of ARN. The

resulting ArnComponents object will contain tokens for the

subexpressions of the ARN, not string literals. In this case this

function cannot properly parse the complete final resourceName (path) out

of ARNs that use ‘/’ to both separate the ‘resource’ from the

‘resourceName’ AND to subdivide the resourceName further. For example, in

S3 ARNs:

arn:aws:s3:::my_corporate_bucket/path/to/exampleobject.png

After parsing the resourceName will not contain

‘path/to/exampleobject.png’ but simply ‘path’. This is a limitation

because there is no slicing functionality in CloudFormation templates.

Parameters:
  • arn (string) –
  • sepIfToken (string (optional)) –
  • hasName (boolean (optional)) – Whether there is a name component in the ARN at all. For example, SNS Topics ARNs have the ‘resource’ component contain the topic name, and no ‘resourceName’ component.
Returns:

an ArnComponents object which allows access to the various components of the ARN.

Return type:

@aws-cdk/cdk.ArnComponents

prepare()

Inherited from @aws-cdk/cdk.Stack

Prepare stack

Find all CloudFormation references and tell them we’re consuming them.

Find all dependencies as well and add the appropriate DependsOn fields.

Protected method

renameLogical(oldId, newId)

Inherited from @aws-cdk/cdk.Stack

Rename a generated logical identities

Parameters:
  • oldId (string) –
  • newId (string) –
reportMissingContext(key, details)

Inherited from @aws-cdk/cdk.Stack

Indicate that a context key was expected

Contains instructions on how the key should be supplied.

Parameters:
  • key (string) – Key that uniquely identifies this missing context.
  • details (@aws-cdk/cx-api.MissingContext) – The set of parameters needed to obtain the context (specific to context provider).
requireAccountId([why]) → string

Inherited from @aws-cdk/cdk.Stack

Returns the AWS account ID of this Stack,

or throws an exception if the account ID is not set in the environment.

Parameters:why (string (optional)) – more information about why is the account ID required
Returns:the AWS account ID of this Stack
Return type:string
requireRegion([why]) → string

Inherited from @aws-cdk/cdk.Stack

Parameters:why (string (optional)) – more information about why region is required.
Returns:The region in which this stack is deployed. Throws if region is not defined.
Return type:string
setParameterValue(parameter, value)

Inherited from @aws-cdk/cdk.Stack

Sets the value of a CloudFormation parameter.

Parameters:
  • parameter (@aws-cdk/cdk.CfnParameter) – The parameter to set the value for
  • value (string) – The value, can use ${} notation to reference other assembly block attributes.
synthesize(session)

Inherited from @aws-cdk/cdk.Stack

Protected method

Parameters:session (@aws-cdk/cdk.ISynthesisSession) –
accountId

Inherited from @aws-cdk/cdk.Stack

The account in which this stack is defined

Either returns the literal account for this stack if it was specified

literally upon Stack construction, or a symbolic value that will evaluate

to the correct account at deployment time.

Type:string (readonly)
autoDeploy

Inherited from @aws-cdk/cdk.Stack

Should the Stack be deployed when running cdk deploy without arguments

(and listed when running cdk synth without arguments).

Setting this to false is useful when you have a Stack in your CDK app

that you don’t want to deploy using the CDK toolkit -

for example, because you’re planning on deploying it through CodePipeline.

By default, this is true.

Type:boolean (readonly)
env

Inherited from @aws-cdk/cdk.Stack

The environment in which this stack is deployed.

Type:@aws-cdk/cdk.Environment (readonly)
environment

Inherited from @aws-cdk/cdk.Stack

Returns the environment specification for this stack (aws://account/region).

Type:string (readonly)
logicalIds

Inherited from @aws-cdk/cdk.Stack

Logical ID generation strategy

Type:@aws-cdk/cdk.LogicalIDs (readonly)
missingContext

Inherited from @aws-cdk/cdk.Stack

Lists all missing contextual information.

This is returned when the stack is synthesized under the ‘missing’ attribute

and allows tooling to obtain the context and re-synthesize.

Type:string => @aws-cdk/cx-api.MissingContext (readonly)
name

Inherited from @aws-cdk/cdk.Stack

The CloudFormation stack name.

This is the stack name either configuration via the stackName property

or automatically derived from the construct path.

Type:string (readonly)
notificationArns

Inherited from @aws-cdk/cdk.Stack

Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

Type:string[] (readonly)
partition

Inherited from @aws-cdk/cdk.Stack

The partition in which this stack is defined

Type:string (readonly)
region

Inherited from @aws-cdk/cdk.Stack

The region in which this stack is defined

Either returns the literal region for this stack if it was specified

literally upon Stack construction, or a symbolic value that will evaluate

to the correct region at deployment time.

Type:string (readonly)
stackId

Inherited from @aws-cdk/cdk.Stack

The ID of the stack

Type:string (readonly)
stackName

Inherited from @aws-cdk/cdk.Stack

The name of the stack currently being deployed

Only available at deployment time; this will always return an unresolved value.

Type:string (readonly)
templateOptions

Inherited from @aws-cdk/cdk.Stack

Options for CloudFormation template (like version, transform, description).

Type:@aws-cdk/cdk.ITemplateOptions (readonly)
urlSuffix

Inherited from @aws-cdk/cdk.Stack

The Amazon domain suffix for the region in which this stack is defined

Type:string (readonly)

CrossRegionScaffoldStackProps (interface)

class @aws-cdk/aws-codepipeline.CrossRegionScaffoldStackProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.CrossRegionScaffoldStackProps;
// CrossRegionScaffoldStackProps is an interface
import { CrossRegionScaffoldStackProps } from '@aws-cdk/aws-codepipeline';

Construction properties for {@link CrossRegionScaffoldStack}.

account

The AWS account ID this Stack belongs to.

Type:string (readonly)
region

The AWS region this Stack resides in.

Type:string (readonly)

DeployAction

class @aws-cdk/aws-codepipeline.DeployAction(props)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.DeployAction;
const { DeployAction } = require('@aws-cdk/aws-codepipeline');
import { DeployAction } from '@aws-cdk/aws-codepipeline';
Extends:Action
Abstract:Yes
Parameters:props (DeployActionProps) –
addInputArtifact(artifact) → @aws-cdk/aws-codepipeline.Action

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Parameters:artifact (Artifact) –
Return type:Action
addOutputArtifact(name) → @aws-cdk/aws-codepipeline.Artifact

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Parameters:name (string) –
Return type:Artifact
bind(info)

Inherited from @aws-cdk/aws-codepipeline.Action

The method called when an Action is attached to a Pipeline.

This method is guaranteed to be called only once for each Action instance.

Protected method

Parameters:info (ActionBind) –
Abstract:Yes
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

Inherited from @aws-cdk/aws-codepipeline.Action

Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Return type:string[]
actionInputArtifacts

Inherited from @aws-cdk/aws-codepipeline.Action

Protected property

Type:Artifact[] (readonly)
actionName

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
actionOutputArtifacts

Inherited from @aws-cdk/aws-codepipeline.Action

Protected property

Type:Artifact[] (readonly)
category

Inherited from @aws-cdk/aws-codepipeline.Action

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:ActionCategory (readonly)
owner

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
provider

Inherited from @aws-cdk/aws-codepipeline.Action

The service provider that the action calls.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline.Action

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

Type:number (readonly)
scope

Inherited from @aws-cdk/aws-codepipeline.Action

Retrieves the Construct scope of this Action.

Only available after the Action has been added to a Stage,

and that Stage to a Pipeline.

Protected property

Type:@aws-cdk/cdk.Construct (readonly)
version

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
configuration

Inherited from @aws-cdk/aws-codepipeline.Action

The action’s configuration. These are key-value pairs that specify input values for an action.

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional) (readonly)
region

Inherited from @aws-cdk/aws-codepipeline.Action

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 {@link 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.

Type:string (optional) (readonly)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-codepipeline.Action

The service role that is assumed during execution of action.

This role is not mandatory, however more advanced configuration

may require specifying it.

Type:@aws-cdk/aws-iam.IRole (optional) (readonly)

DeployActionProps (interface)

class @aws-cdk/aws-codepipeline.DeployActionProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.DeployActionProps;
// DeployActionProps is an interface
import { DeployActionProps } from '@aws-cdk/aws-codepipeline';
Extends:CommonActionProps
artifactBounds
Type:ActionArtifactBounds (readonly)
inputArtifact
Type:Artifact (readonly)
provider
Type:string (readonly)
configuration
Type:any (optional) (readonly)
owner
Type:string (optional) (readonly)
actionName

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The physical, human-readable name of the Action.

Not that Action names must be unique within a single Stage.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Type:number (optional) (readonly)
Default:1

IPipeline (interface)

class @aws-cdk/aws-codepipeline.IPipeline

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.IPipeline;
// IPipeline is an interface
import { IPipeline } from '@aws-cdk/aws-codepipeline';

The abstract view of an AWS CodePipeline as required and used by Actions.

It extends {@link events.IEventRuleTarget},

so this interface can be used as a Target for CloudWatch Events.

Extends:@aws-cdk/cdk.IConstruct
Extends:@aws-cdk/aws-events.IEventRuleTarget
pipelineArn

The ARN of the Pipeline.

Type:string (readonly)
pipelineName

The name of the Pipeline.

Type:string (readonly)
grantBucketRead(identity) → @aws-cdk/aws-iam.Grant

Grants read permissions to the Pipeline’s S3 Bucket to the given Identity.

Parameters:identity (@aws-cdk/aws-iam.IGrantable) – the IAM Identity to grant the permissions to
Return type:@aws-cdk/aws-iam.Grant
Abstract:Yes
grantBucketReadWrite(identity) → @aws-cdk/aws-iam.Grant

Grants read & write permissions to the Pipeline’s S3 Bucket to the given Identity.

Parameters:identity (@aws-cdk/aws-iam.IGrantable) – the IAM Identity to grant the permissions to
Return type:@aws-cdk/aws-iam.Grant
Abstract:Yes
asEventRuleTarget(ruleArn, ruleUniqueId) → @aws-cdk/aws-events.EventRuleTargetProps

Inherited from @aws-cdk/aws-events.IEventRuleTarget

Returns the rule target specification.

NOTE: Do not use the various inputXxx options. They can be set in a call to addTarget.

Parameters:
  • ruleArn (string) – The ARN of the CloudWatch Event Rule that would trigger this target.
  • ruleUniqueId (string) – A unique ID for this rule. Can be used to implement idempotency.
Return type:

@aws-cdk/aws-events.EventRuleTargetProps

Abstract:

Yes

node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

IStage (interface)

class @aws-cdk/aws-codepipeline.IStage

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.IStage;
// IStage is an interface
import { IStage } from '@aws-cdk/aws-codepipeline';

The abstract interface of a Pipeline Stage that is used by Actions.

stageName

The physical, human-readable name of this Pipeline Stage.

Type:string (readonly)
addAction(action)
Parameters:action (Action) –
Abstract:Yes
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule
Parameters:
Return type:

@aws-cdk/aws-events.EventRule

Abstract:

Yes

Pipeline

class @aws-cdk/aws-codepipeline.Pipeline(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.Pipeline;
const { Pipeline } = require('@aws-cdk/aws-codepipeline');
import { Pipeline } from '@aws-cdk/aws-codepipeline';

An AWS CodePipeline pipeline with its associated IAM role and S3 bucket.

Extends:

@aws-cdk/cdk.Construct

Implements:

IPipeline

Parameters:
addStage(props) → @aws-cdk/aws-codepipeline.IStage

Creates a new Stage, and adds it to this Pipeline.

Parameters:props (StageAddToPipelineProps) – the creation properties of the new Stage
Returns:the newly created Stage
Return type:IStage
addToRolePolicy(statement)

Adds a statement to the pipeline role.

Parameters:statement (@aws-cdk/aws-iam.PolicyStatement) –
asEventRuleTarget(_ruleArn, _ruleId) → @aws-cdk/aws-events.EventRuleTargetProps

Implements @aws-cdk/aws-events.IEventRuleTarget.asEventRuleTarget()

Allows the pipeline to be used as a CloudWatch event rule target.

Usage:

const pipeline = new Pipeline(this, ‘MyPipeline’);

const rule = new EventRule(this, ‘MyRule’, { schedule: ‘rate(1 minute)’ });

rule.addTarget(pipeline);

Parameters:
  • _ruleArn (string) –
  • _ruleId (string) –
Return type:

@aws-cdk/aws-events.EventRuleTargetProps

grantBucketRead(identity) → @aws-cdk/aws-iam.Grant

Implements @aws-cdk/aws-codepipeline.IPipeline.grantBucketRead()

Grants read permissions to the Pipeline’s S3 Bucket to the given Identity.

Parameters:identity (@aws-cdk/aws-iam.IGrantable) –
Return type:@aws-cdk/aws-iam.Grant
grantBucketReadWrite(identity) → @aws-cdk/aws-iam.Grant

Implements @aws-cdk/aws-codepipeline.IPipeline.grantBucketReadWrite()

Grants read & write permissions to the Pipeline’s S3 Bucket to the given Identity.

Parameters:identity (@aws-cdk/aws-iam.IGrantable) –
Return type:@aws-cdk/aws-iam.Grant
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

Defines an event rule triggered by the “CodePipeline Pipeline Execution

State Change” event emitted from this pipeline.

Parameters:
  • name (string) – The name of the event rule construct. If you wish to define more than a single onStateChange event, you will need to explicitly specify a name.
  • target (@aws-cdk/aws-events.IEventRuleTarget (optional)) – Initial target to add to the event rule. You can also add targets and customize target inputs by calling rule.addTarget(target[, * options]) after the rule was created.
  • options (@aws-cdk/aws-events.EventRuleProps (optional)) – Additional options to pass to the event rule
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

Overrides @aws-cdk/cdk.Construct.validate()

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

Protected method

Return type:string[]
artifactBucket

Bucket used to store output artifacts

Type:@aws-cdk/aws-s3.IBucket (readonly)
crossRegionScaffoldStacks

Returns all of the {@link CrossRegionScaffoldStack}s that were generated automatically

when dealing with Actions that reside in a different region than the Pipeline itself.

Type:string => CrossRegionScaffoldStack (readonly)
pipelineArn

Implements @aws-cdk/aws-codepipeline.IPipeline.pipelineArn()

ARN of this pipeline

Type:string (readonly)
pipelineName

Implements @aws-cdk/aws-codepipeline.IPipeline.pipelineName()

The name of the pipeline

Type:string (readonly)
pipelineVersion

The version of the pipeline

Type:string (readonly)
role

The IAM role AWS CodePipeline will use to perform actions or assume roles for actions with

a more specific IAM role.

Type:@aws-cdk/aws-iam.Role (readonly)
stageCount

Get the number of Stages in this Pipeline.

Type:number (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

PipelineProps (interface)

class @aws-cdk/aws-codepipeline.PipelineProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.PipelineProps;
// PipelineProps is an interface
import { PipelineProps } from '@aws-cdk/aws-codepipeline';
artifactBucket

The S3 bucket used by this Pipeline to store artifacts.

If not specified, a new S3 bucket will be created.

Type:@aws-cdk/aws-s3.IBucket (optional) (readonly)
crossRegionReplicationBuckets

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 scaffold Stack containing an S3 Bucket in that region.

Note that you will have to cdk deploy that Stack before you can deploy your Pipeline-containing Stack.

You can query the generated Stacks using the {@link Pipeline#crossRegionScaffoldStacks} property.

Type:string => string (optional) (readonly)
pipelineName

Name of the pipeline. If you don’t specify a name, AWS CloudFormation generates an ID

and uses that for the pipeline name.

Type:string (optional) (readonly)
restartExecutionOnUpdate

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

Type:boolean (optional) (readonly)
stages

The list of Stages, in order,

to create this Pipeline with.

You can always add more Stages later by calling {@link Pipeline#addStage}.

Type:StageProps[] (optional) (readonly)

SourceAction

class @aws-cdk/aws-codepipeline.SourceAction(props)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.SourceAction;
const { SourceAction } = require('@aws-cdk/aws-codepipeline');
import { SourceAction } from '@aws-cdk/aws-codepipeline';

Low-level class for source actions.

It is recommended that concrete types are used instead,

such as {@link s3.PipelineSourceAction} or

{@link codecommit.PipelineSourceAction}.

Extends:Action
Abstract:Yes
Parameters:props (SourceActionProps) –
outputArtifact
Type:Artifact (readonly)
addInputArtifact(artifact) → @aws-cdk/aws-codepipeline.Action

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Parameters:artifact (Artifact) –
Return type:Action
addOutputArtifact(name) → @aws-cdk/aws-codepipeline.Artifact

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Parameters:name (string) –
Return type:Artifact
bind(info)

Inherited from @aws-cdk/aws-codepipeline.Action

The method called when an Action is attached to a Pipeline.

This method is guaranteed to be called only once for each Action instance.

Protected method

Parameters:info (ActionBind) –
Abstract:Yes
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

Inherited from @aws-cdk/aws-codepipeline.Action

Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Return type:string[]
actionInputArtifacts

Inherited from @aws-cdk/aws-codepipeline.Action

Protected property

Type:Artifact[] (readonly)
actionName

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
actionOutputArtifacts

Inherited from @aws-cdk/aws-codepipeline.Action

Protected property

Type:Artifact[] (readonly)
category

Inherited from @aws-cdk/aws-codepipeline.Action

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:ActionCategory (readonly)
owner

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
provider

Inherited from @aws-cdk/aws-codepipeline.Action

The service provider that the action calls.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline.Action

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

Type:number (readonly)
scope

Inherited from @aws-cdk/aws-codepipeline.Action

Retrieves the Construct scope of this Action.

Only available after the Action has been added to a Stage,

and that Stage to a Pipeline.

Protected property

Type:@aws-cdk/cdk.Construct (readonly)
version

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
configuration

Inherited from @aws-cdk/aws-codepipeline.Action

The action’s configuration. These are key-value pairs that specify input values for an action.

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional) (readonly)
region

Inherited from @aws-cdk/aws-codepipeline.Action

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 {@link 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.

Type:string (optional) (readonly)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-codepipeline.Action

The service role that is assumed during execution of action.

This role is not mandatory, however more advanced configuration

may require specifying it.

Type:@aws-cdk/aws-iam.IRole (optional) (readonly)

SourceActionProps (interface)

class @aws-cdk/aws-codepipeline.SourceActionProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.SourceActionProps;
// SourceActionProps is an interface
import { SourceActionProps } from '@aws-cdk/aws-codepipeline';

Construction properties of the low-level {@link SourceAction source Action}.

Extends:CommonActionProps
outputArtifactName

The name of the source’s output artifact.

CfnOutput artifacts are used by CodePipeline as inputs into other actions.

Type:string (readonly)
provider

The service provider that the action calls.

For example, a valid provider for Source actions is “S3”.

Type:string (readonly)
configuration

The action’s configuration. These are key-value pairs that specify input values for an action.

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional) (readonly)
owner

The source action owner (could be “AWS”, “ThirdParty” or “Custom”).

Type:string (optional) (readonly)
Default:“AWS”
version

The source Action version.

Type:string (optional) (readonly)
Default:“1”
actionName

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The physical, human-readable name of the Action.

Not that Action names must be unique within a single Stage.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Type:number (optional) (readonly)
Default:1

StageAddToPipelineProps (interface)

class @aws-cdk/aws-codepipeline.StageAddToPipelineProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.StageAddToPipelineProps;
// StageAddToPipelineProps is an interface
import { StageAddToPipelineProps } from '@aws-cdk/aws-codepipeline';
Extends:StageProps
placement
Type:StagePlacement (optional) (readonly)
name

Inherited from @aws-cdk/aws-codepipeline.StageProps

The physical, human-readable name to assign to this Pipeline Stage.

Type:string (readonly)
actions

Inherited from @aws-cdk/aws-codepipeline.StageProps

The list of Actions to create this Stage with.

You can always add more Actions later by calling {@link IStage#addAction}.

Type:Action[] (optional) (readonly)

StagePlacement (interface)

class @aws-cdk/aws-codepipeline.StagePlacement

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.StagePlacement;
// StagePlacement is an interface
import { StagePlacement } from '@aws-cdk/aws-codepipeline';

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.

atIndex

Inserts the new Stage at the given index in the Pipeline,

moving the Stage currently at that index,

and any subsequent ones, one index down.

Indexing starts at 0.

The maximum allowed value is {@link Pipeline#stageCount},

which will insert the new Stage at the end of the Pipeline.

Type:number (optional) (readonly)
justAfter

Inserts the new Stage as a child of the given Stage

(changing its current child Stage, if it had one).

Type:IStage (optional) (readonly)
rightBefore

Inserts the new Stage as a parent of the given Stage

(changing its current parent Stage, if it had one).

Type:IStage (optional) (readonly)

StageProps (interface)

class @aws-cdk/aws-codepipeline.StageProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.StageProps;
// StageProps is an interface
import { StageProps } from '@aws-cdk/aws-codepipeline';

Construction properties of a Pipeline Stage.

name

The physical, human-readable name to assign to this Pipeline Stage.

Type:string (readonly)
actions

The list of Actions to create this Stage with.

You can always add more Actions later by calling {@link IStage#addAction}.

Type:Action[] (optional) (readonly)

TestAction

class @aws-cdk/aws-codepipeline.TestAction(props)

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.TestAction;
const { TestAction } = require('@aws-cdk/aws-codepipeline');
import { TestAction } from '@aws-cdk/aws-codepipeline';

The low-level test Action.

Test Actions are very similar to build Actions -

the difference is that test Actions don’t have to have an output artifact.

You should never need to use this class directly,

instead preferring the concrete implementations,

like {@link codebuild.PipelineTestAction}.

Extends:Action
Abstract:Yes
Parameters:props (TestActionProps) –
outputArtifact
Type:Artifact (optional) (readonly)
addInputArtifact(artifact) → @aws-cdk/aws-codepipeline.Action

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Parameters:artifact (Artifact) –
Return type:Action
addOutputArtifact(name) → @aws-cdk/aws-codepipeline.Artifact

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Parameters:name (string) –
Return type:Artifact
bind(info)

Inherited from @aws-cdk/aws-codepipeline.Action

The method called when an Action is attached to a Pipeline.

This method is guaranteed to be called only once for each Action instance.

Protected method

Parameters:info (ActionBind) –
Abstract:Yes
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

Inherited from @aws-cdk/aws-codepipeline.Action

Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

Inherited from @aws-cdk/aws-codepipeline.Action

Protected method

Return type:string[]
actionInputArtifacts

Inherited from @aws-cdk/aws-codepipeline.Action

Protected property

Type:Artifact[] (readonly)
actionName

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
actionOutputArtifacts

Inherited from @aws-cdk/aws-codepipeline.Action

Protected property

Type:Artifact[] (readonly)
category

Inherited from @aws-cdk/aws-codepipeline.Action

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:ActionCategory (readonly)
owner

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
provider

Inherited from @aws-cdk/aws-codepipeline.Action

The service provider that the action calls.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline.Action

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

Type:number (readonly)
scope

Inherited from @aws-cdk/aws-codepipeline.Action

Retrieves the Construct scope of this Action.

Only available after the Action has been added to a Stage,

and that Stage to a Pipeline.

Protected property

Type:@aws-cdk/cdk.Construct (readonly)
version

Inherited from @aws-cdk/aws-codepipeline.Action

Type:string (readonly)
configuration

Inherited from @aws-cdk/aws-codepipeline.Action

The action’s configuration. These are key-value pairs that specify input values for an action.

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional) (readonly)
region

Inherited from @aws-cdk/aws-codepipeline.Action

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 {@link 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.

Type:string (optional) (readonly)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-codepipeline.Action

The service role that is assumed during execution of action.

This role is not mandatory, however more advanced configuration

may require specifying it.

Type:@aws-cdk/aws-iam.IRole (optional) (readonly)

TestActionProps (interface)

class @aws-cdk/aws-codepipeline.TestActionProps

Language-specific names:

using Amazon.CDK.AWS.CodePipeline;
import software.amazon.awscdk.services.codepipeline.TestActionProps;
// TestActionProps is an interface
import { TestActionProps } from '@aws-cdk/aws-codepipeline';

Construction properties of the low-level {@link TestAction test Action}.

Extends:CommonActionProps
artifactBounds

The upper and lower bounds on the number of input and output artifacts for this Action.

Type:ActionArtifactBounds (readonly)
inputArtifact

The source to use as input for this test.

Type:Artifact (readonly)
provider

The service provider that the action calls.

Type:string (readonly)
configuration

The action’s configuration. These are key-value pairs that specify input values for an action.

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional) (readonly)
outputArtifactName

The optional name of the output artifact.

If you provide a value here,

then the outputArtifact property of your Action will be non-null.

If you don’t, outputArtifact will be null.

Type:string (optional) (readonly)
Default:the Action will not have an output artifact
owner

The test Action owner (could be ‘AWS’, ‘ThirdParty’ or ‘Custom’).

Type:string (optional) (readonly)
Default:‘AWS’
version

The test Action version.

Type:string (optional) (readonly)
Default:‘1’
actionName

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The physical, human-readable name of the Action.

Not that Action names must be unique within a single Stage.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline.CommonActionProps

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Type:number (optional) (readonly)
Default:1