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

To append a Stage to a Pipeline:

const sourceStage = pipeline.addStage('Source');

You can also instantiate the Stage Construct directly, which will add it to the Pipeline provided in its construction properties.

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

const sourceStage = pipeline.addStage('Source', {
  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

To add an Action to a Stage:

new codepipeline.GitHubSourceAction(this, 'GitHub_Source', {
  stage: sourceStage,
  owner: 'awslabs',
  repo: 'aws-cdk',
  branch: 'develop', // default: 'master'
  oauthToken: ...,
})

The Pipeline construct will automatically generate and wire together the artifact names CodePipeline uses. If you need, you can also name the artifacts explicitly:

const sourceAction = new codepipeline.GitHubSourceAction(this, 'GitHub_Source', {
  // other properties as above...
  outputArtifactName: 'SourceOutput', // this will be the name of the output artifact in the Pipeline
});

// in a build Action later...

new codepipeline.JenkinsBuildAction(this, 'Jenkins_Build', {
  // other properties...
  inputArtifact: sourceAction.outputArtifact,
});

Manual approval Action

This package contains an Action that stops the Pipeline until someone manually clicks the approve button:

const manualApprovalAction = new codepipeline.ManualApprovalAction(this, 'Approve', {
  stage: approveStage,
  notificationTopic: new sns.Topic(this, 'Topic'), // optional
  notifyEmails: [
    'some_email@example.com',
  ], // optional
  additionalInformation: 'additional info', // optional
});
// `manualApprovalAction.notificationTopic` can be used to access the Topic

If the notificationTopic has not been provided, but notifyEmails were, a new SNS Topic will be created (and accessible through the notificationTopic property of the Action).

Jenkins Actions

In order to use Jenkins Actions in the Pipeline, you first need to create a JenkinsProvider:

const jenkinsProvider = new codepipeline.JenkinsProvider(this, 'JenkinsProvider', {
  providerName: 'MyJenkinsProvider',
  serverUrl: 'http://my-jenkins.com:8080',
  version: '2', // optional, default: '1'
});

If you’ve registered a Jenkins provider in a different CDK app, or outside the CDK (in the CodePipeline AWS Console, for example), you can import it:

const jenkinsProvider = codepipeline.JenkinsProvider.import(this, 'JenkinsProvider', {
  providerName: 'MyJenkinsProvider',
  serverUrl: 'http://my-jenkins.com:8080',
  version: '2', // optional, default: '1'
});

Note that a Jenkins provider (identified by the provider name-category(build/test)-version tuple) must always be registered in the given account, in the given AWS region, before it can be used in CodePipeline.

With a JenkinsProvider, we can create a Jenkins Action:

const buildAction = new codepipeline.JenkinsBuildAction(this, 'JenkinsBuild', {
  stage: buildStage,
  jenkinsProvider: jenkinsProvider,
  projectName: 'MyProject',
});
// there's also a JenkinsTestAction that works identically

You can also add the Action to the Pipeline directly:

// equivalent to the code above:
const buildAction = jenkinsProvider.addToPipeline(buildStage, 'JenkinsBuild', {
  projectName: 'MyProject',
});

const testAction = jenkinsProvider.addToPipelineAsTest(buildStage, 'JenkinsTest', {
  projectName: 'MyProject',
});

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 cloudformation.PipelineCreateUpdateStackAction(this, '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.24.1" />

dotnet:

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

packages.config:

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

View in Maven Central

Apache Buildr:

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

Apache Ivy:

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

Apache Maven:

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

Gradle / Grails:

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

Groovy Grape:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

BaseJenkinsProvider

class @aws-cdk/aws-codepipeline.BaseJenkinsProvider(scope, id[, version])

Language-specific names:

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

@aws-cdk/cdk.Construct

Implements:

IJenkinsProvider

Abstract:

Yes

Parameters:
addToPipeline(stage, name, props) → @aws-cdk/aws-codepipeline.JenkinsBuildAction

Implements @aws-cdk/aws-codepipeline.IJenkinsProvider.addToPipeline()

Convenience method for creating a new {@link JenkinsBuildAction},

and adding it to the given Stage.

Parameters:
Return type:

JenkinsBuildAction

addToPipelineAsTest(stage, name, props) → @aws-cdk/aws-codepipeline.JenkinsTestAction

Implements @aws-cdk/aws-codepipeline.IJenkinsProvider.addToPipelineAsTest()

Convenience method for creating a new {@link JenkinsTestAction},

and adding it to the given Stage.

Parameters:
Return type:

JenkinsTestAction

export() → @aws-cdk/aws-codepipeline.JenkinsProviderImportProps
Return type:JenkinsProviderImportProps
providerName

Implements @aws-cdk/aws-codepipeline.IJenkinsProvider.providerName()

Type:string (readonly) (abstract)
serverUrl

Implements @aws-cdk/aws-codepipeline.IJenkinsProvider.serverUrl()

Type:string (readonly) (abstract)
version

Implements @aws-cdk/aws-codepipeline.IJenkinsProvider.version()

Type:string (readonly)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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
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)

BasicJenkinsActionProps (interface)

class @aws-cdk/aws-codepipeline.BasicJenkinsActionProps

Language-specific names:

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

Common construction properties of all Jenkins Pipeline Actions.

Extends:@aws-cdk/aws-codepipeline-api.CommonActionProps
projectName

The name of the project (sometimes also called job, or task)

on your Jenkins installation that will be invoked by this Action.

Type:string
inputArtifact

The source to use as input for this build.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
Default:CodePipeline will use the output of the last Action from a previous Stage as input
runOrder

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

The runOrder property for this Action.

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

Type:number (optional)
Default:1

BasicJenkinsBuildActionProps (interface)

class @aws-cdk/aws-codepipeline.BasicJenkinsBuildActionProps

Language-specific names:

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

Common properties for creating {@link JenkinsBuildAction} -

either directly, through its constructor,

or through {@link JenkinsProvider#addToPipeline}.

Extends:BasicJenkinsActionProps
outputArtifactName

The name of the build’s output artifact.

Type:string (optional)
Default:an auto-generated name will be used
runOrder

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

The runOrder property for this Action.

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

Type:number (optional)
Default:1
projectName

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

The name of the project (sometimes also called job, or task)

on your Jenkins installation that will be invoked by this Action.

Type:string
inputArtifact

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

The source to use as input for this build.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
Default:CodePipeline will use the output of the last Action from a previous Stage as input

BasicJenkinsTestActionProps (interface)

class @aws-cdk/aws-codepipeline.BasicJenkinsTestActionProps

Language-specific names:

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

Common properties for creating {@link JenkinsTestAction} -

either directly, through its constructor,

or through {@link JenkinsProvider#addToPipelineAsTest}.

Extends:BasicJenkinsActionProps
outputArtifactName

The optional name of the primary 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)
Default:the Action will not have an output artifact
runOrder

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

The runOrder property for this Action.

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

Type:number (optional)
Default:1
projectName

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

The name of the project (sometimes also called job, or task)

on your Jenkins installation that will be invoked by this Action.

Type:string
inputArtifact

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

The source to use as input for this build.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
Default:CodePipeline will use the output of the last Action from a previous Stage as input

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';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.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

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

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

CfnCustomActionType.ArtifactDetailsProperty.MinimumCount

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

Type:number or @aws-cdk/cdk.Token
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

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

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

CfnCustomActionType.ConfigurationPropertiesProperty.Name

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

Type:string
required

CfnCustomActionType.ConfigurationPropertiesProperty.Required

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

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

CfnCustomActionType.ConfigurationPropertiesProperty.Secret

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

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

CfnCustomActionType.ConfigurationPropertiesProperty.Description

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

Type:string (optional)
queryable

CfnCustomActionType.ConfigurationPropertiesProperty.Queryable

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

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

CfnCustomActionType.ConfigurationPropertiesProperty.Type

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

Type:string (optional)
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

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

Type:string (optional)
executionUrlTemplate

CfnCustomActionType.SettingsProperty.ExecutionUrlTemplate

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

Type:string (optional)
revisionUrlTemplate

CfnCustomActionType.SettingsProperty.RevisionUrlTemplate

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

Type:string (optional)
thirdPartyConfigurationUrl

CfnCustomActionType.SettingsProperty.ThirdPartyConfigurationUrl

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

Type:string (optional)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

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

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

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

Inherited from @aws-cdk/cdk.Resource

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.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

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

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

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
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

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

Inherited from @aws-cdk/cdk.Resource

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

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

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)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

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

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

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';
category

AWS::CodePipeline::CustomActionType.Category

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

Type:string
inputArtifactDetails

AWS::CodePipeline::CustomActionType.InputArtifactDetails

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

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

AWS::CodePipeline::CustomActionType.OutputArtifactDetails

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

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

AWS::CodePipeline::CustomActionType.Provider

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

Type:string
configurationProperties

AWS::CodePipeline::CustomActionType.ConfigurationProperties

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

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

AWS::CodePipeline::CustomActionType.Settings

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

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

AWS::CodePipeline::CustomActionType.Version

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

Type:string (optional)

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';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.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

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

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

CfnPipeline.ActionDeclarationProperty.Name

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

Type:string
configuration

CfnPipeline.ActionDeclarationProperty.Configuration

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

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

CfnPipeline.ActionDeclarationProperty.InputArtifacts

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

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

CfnPipeline.ActionDeclarationProperty.OutputArtifacts

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

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

CfnPipeline.ActionDeclarationProperty.Region

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

Type:string (optional)
roleArn

CfnPipeline.ActionDeclarationProperty.RoleArn

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

Type:string (optional)
runOrder

CfnPipeline.ActionDeclarationProperty.RunOrder

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

Type:number or @aws-cdk/cdk.Token (optional)
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

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

Type:string
owner

CfnPipeline.ActionTypeIdProperty.Owner

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

Type:string
provider

CfnPipeline.ActionTypeIdProperty.Provider

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

Type:string
version

CfnPipeline.ActionTypeIdProperty.Version

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

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

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

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

CfnPipeline.ArtifactStoreMapProperty.Region

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

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

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

Type:string
type

CfnPipeline.ArtifactStoreProperty.Type

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

Type:string
encryptionKey

CfnPipeline.ArtifactStoreProperty.EncryptionKey

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

Type:@aws-cdk/cdk.Token or EncryptionKeyProperty (optional)
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

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

Type:string
type

CfnPipeline.BlockerDeclarationProperty.Type

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

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

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

Type:string
type

CfnPipeline.EncryptionKeyProperty.Type

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

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

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

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

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

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

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

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

CfnPipeline.StageDeclarationProperty.Name

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

Type:string
blockers

CfnPipeline.StageDeclarationProperty.Blockers

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

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or BlockerDeclarationProperty)[] (optional)
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

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

Type:string
stageName

CfnPipeline.StageTransitionProperty.StageName

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

Type:string
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

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

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

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

Inherited from @aws-cdk/cdk.Resource

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.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

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

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

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
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

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

Inherited from @aws-cdk/cdk.Resource

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

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

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)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

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

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

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';
roleArn

AWS::CodePipeline::Pipeline.RoleArn

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

Type:string
stages

AWS::CodePipeline::Pipeline.Stages

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

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

AWS::CodePipeline::Pipeline.ArtifactStore

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

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

AWS::CodePipeline::Pipeline.ArtifactStores

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

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

AWS::CodePipeline::Pipeline.DisableInboundStageTransitions

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

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

AWS::CodePipeline::Pipeline.Name

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

Type:string (optional)
restartExecutionOnUpdate

AWS::CodePipeline::Pipeline.RestartExecutionOnUpdate

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

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

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';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.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

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

Type:string (optional)
secretToken

CfnWebhook.WebhookAuthConfigurationProperty.SecretToken

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

Type:string (optional)
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

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

Type:string
matchEquals

CfnWebhook.WebhookFilterRuleProperty.MatchEquals

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

Type:string (optional)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

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

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

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

Inherited from @aws-cdk/cdk.Resource

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.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

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

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

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
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

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

Inherited from @aws-cdk/cdk.Resource

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

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

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)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

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

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Return the path with respect to the stack

Type:string (readonly)
stack

Inherited from @aws-cdk/cdk.StackElement

The stack this Construct has been made a part of

Protected property

Type:@aws-cdk/cdk.Stack

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';
authentication

AWS::CodePipeline::Webhook.Authentication

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

Type:string
authenticationConfiguration

AWS::CodePipeline::Webhook.AuthenticationConfiguration

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

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

AWS::CodePipeline::Webhook.Filters

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

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

AWS::CodePipeline::Webhook.TargetAction

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

Type:string
targetPipeline

AWS::CodePipeline::Webhook.TargetPipeline

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

Type:string
targetPipelineVersion

AWS::CodePipeline::Webhook.TargetPipelineVersion

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

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

AWS::CodePipeline::Webhook.Name

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

Type:string (optional)
registerWithThirdParty

AWS::CodePipeline::Webhook.RegisterWithThirdParty

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

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

CommonStageProps (interface)

class @aws-cdk/aws-codepipeline.CommonStageProps

Language-specific names:

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

The properties for the {@link Pipeline#addStage} method.

placement

Allows specifying where should the newly created {@link Stage}

be placed in the Pipeline.

Type:StagePlacement (optional)
Default:the stage is added at the end of the Pipeline

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)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)

Inherited from @aws-cdk/cdk.Stack

Add a dependency between this stack and another stack

Parameters:stack (@aws-cdk/cdk.Stack) –
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.Resource

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.Resource (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
toCloudFormation() → any

Inherited from @aws-cdk/cdk.Stack

Returns the CloudFormation template for this stack by traversing

the tree and invoking toCloudFormation() on all Entity objects.

Return type:any
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)
env

Inherited from @aws-cdk/cdk.Stack

The environment in which this stack is deployed.

Type:@aws-cdk/cdk.Environment (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.

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.

Type:string (readonly)
templateOptions

Inherited from @aws-cdk/cdk.Stack

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

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

Inherited from @aws-cdk/cdk.Stack

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

Type:string (readonly)
props

Inherited from @aws-cdk/cdk.Stack

Stack properties.

Type:@aws-cdk/cdk.StackProps (optional) (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
region

The AWS region this Stack resides in.

Type:string

GitHubSourceAction

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

Language-specific names:

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

Source that is provided by a GitHub repository.

Extends:

@aws-cdk/aws-codepipeline-api.SourceAction

Parameters:
addInputArtifact([artifact]) → @aws-cdk/aws-codepipeline-api.Action

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

Protected method

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

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

Protected method

Parameters:name (string (optional)) –
Return type:@aws-cdk/aws-codepipeline-api.Artifact
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

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

Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

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

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

Return type:string[]
category

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

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:@aws-cdk/aws-codepipeline-api.ActionCategory (readonly)
owner

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

Type:string (readonly)
provider

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

The service provider that the action calls.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline-api.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)
version

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

Type:string (readonly)
configuration

Inherited from @aws-cdk/aws-codepipeline-api.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-api.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-api.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)
outputArtifact

Inherited from @aws-cdk/aws-codepipeline-api.SourceAction

Type:@aws-cdk/aws-codepipeline-api.Artifact (readonly)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)

GitHubSourceActionProps (interface)

class @aws-cdk/aws-codepipeline.GitHubSourceActionProps

Language-specific names:

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

Construction properties of the {@link GitHubSourceAction GitHub source action}.

Extends:@aws-cdk/aws-codepipeline-api.CommonActionProps
Extends:@aws-cdk/aws-codepipeline-api.CommonActionConstructProps
oauthToken

A GitHub OAuth token to use for authentication.

It is recommended to use a SecretParameter to obtain the token from the SSM

Parameter Store:

const oauth = new cdk.SecretParameter(this, ‘GitHubOAuthToken’, { ssmParameter: ‘my-github-token’ });

new GitHubSource(this, ‘GitHubAction’, { oauthToken: oauth.value, … });

Type:@aws-cdk/cdk.Secret
owner

The GitHub account/user that owns the repo.

Type:string
repo

The name of the repo, without the username.

Type:string
branch

The branch to use.

Type:string (optional)
Default:“master”
outputArtifactName

The name of the source’s output artifact. Output artifacts are used by CodePipeline as

inputs into other actions.

Type:string (optional)
Default:a name will be auto-generated
pollForSourceChanges

Whether AWS CodePipeline should poll for source changes.

If this is false, the Pipeline will use a webhook to detect source changes instead.

Type:boolean (optional)
Default:false
stage

Inherited from @aws-cdk/aws-codepipeline-api.CommonActionConstructProps

The Pipeline Stage to add this Action to.

Type:@aws-cdk/aws-codepipeline-api.IStage
runOrder

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

The runOrder property for this Action.

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

Type:number (optional)
Default:1

IJenkinsProvider (interface)

class @aws-cdk/aws-codepipeline.IJenkinsProvider

Language-specific names:

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

A Jenkins provider.

If you want to create a new Jenkins provider managed alongside your CDK code,

instantiate the {@link JenkinsProvider} class directly.

If you want to reference an already registered provider,

use the {@link JenkinsProvider#import} method.

providerName
Type:string (readonly)
serverUrl
Type:string (readonly)
version
Type:string (readonly)
addToPipeline(stage, name, props) → @aws-cdk/aws-codepipeline.JenkinsBuildAction

Convenience method for creating a new {@link JenkinsBuildAction},

and adding it to the given Stage.

Parameters:
Returns:

the newly created {@link JenkinsBuildAction}

Return type:

JenkinsBuildAction

Abstract:

Yes

addToPipelineAsTest(stage, name, props) → @aws-cdk/aws-codepipeline.JenkinsTestAction

Convenience method for creating a new {@link JenkinsTestAction},

and adding it to the given Stage.

Parameters:
Returns:

the newly created {@link JenkinsTestAction}

Return type:

JenkinsTestAction

Abstract:

Yes

JenkinsBuildAction

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

Language-specific names:

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

Jenkins build CodePipeline Action.

Extends:

@aws-cdk/aws-codepipeline-api.BuildAction

Parameters:
addInputArtifact([artifact]) → @aws-cdk/aws-codepipeline-api.Action

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

Protected method

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

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

Protected method

Parameters:name (string (optional)) –
Return type:@aws-cdk/aws-codepipeline-api.Artifact
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

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

Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

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

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

Return type:string[]
category

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

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:@aws-cdk/aws-codepipeline-api.ActionCategory (readonly)
owner

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

Type:string (readonly)
provider

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

The service provider that the action calls.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline-api.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)
version

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

Type:string (readonly)
configuration

Inherited from @aws-cdk/aws-codepipeline-api.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-api.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-api.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)
outputArtifact

Inherited from @aws-cdk/aws-codepipeline-api.BuildAction

Type:@aws-cdk/aws-codepipeline-api.Artifact (readonly)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)

JenkinsBuildActionProps (interface)

class @aws-cdk/aws-codepipeline.JenkinsBuildActionProps

Language-specific names:

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

Construction properties of {@link JenkinsBuildAction}.

Extends:BasicJenkinsBuildActionProps
Extends:@aws-cdk/aws-codepipeline-api.CommonActionConstructProps
jenkinsProvider

The Jenkins Provider for this Action.

Type:IJenkinsProvider
stage

Inherited from @aws-cdk/aws-codepipeline-api.CommonActionConstructProps

The Pipeline Stage to add this Action to.

Type:@aws-cdk/aws-codepipeline-api.IStage
runOrder

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

The runOrder property for this Action.

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

Type:number (optional)
Default:1
projectName

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

The name of the project (sometimes also called job, or task)

on your Jenkins installation that will be invoked by this Action.

Type:string
inputArtifact

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

The source to use as input for this build.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
Default:CodePipeline will use the output of the last Action from a previous Stage as input
outputArtifactName

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

The name of the build’s output artifact.

Type:string (optional)
Default:an auto-generated name will be used

JenkinsProvider

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

Language-specific names:

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

A class representing Jenkins providers.

Extends:

BaseJenkinsProvider

Parameters:
static import(scope, id, props) → @aws-cdk/aws-codepipeline.IJenkinsProvider

Import a Jenkins provider registered either outside the CDK,

or in a different CDK Stack.

Parameters:
Returns:

a new Construct representing a reference to an existing Jenkins provider

Return type:

IJenkinsProvider

providerName

Implements @aws-cdk/aws-codepipeline.BaseJenkinsProvider.providerName()

Type:string (readonly)
serverUrl

Implements @aws-cdk/aws-codepipeline.BaseJenkinsProvider.serverUrl()

Type:string (readonly)
addToPipeline(stage, name, props) → @aws-cdk/aws-codepipeline.JenkinsBuildAction

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

Convenience method for creating a new {@link JenkinsBuildAction},

and adding it to the given Stage.

Parameters:
Return type:

JenkinsBuildAction

addToPipelineAsTest(stage, name, props) → @aws-cdk/aws-codepipeline.JenkinsTestAction

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

Convenience method for creating a new {@link JenkinsTestAction},

and adding it to the given Stage.

Parameters:
Return type:

JenkinsTestAction

export() → @aws-cdk/aws-codepipeline.JenkinsProviderImportProps

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

Return type:JenkinsProviderImportProps
version

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

Type:string (readonly)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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
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)

JenkinsProviderImportProps (interface)

class @aws-cdk/aws-codepipeline.JenkinsProviderImportProps

Language-specific names:

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

Properties for importing an existing Jenkins provider.

providerName

The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.

Type:string
serverUrl

The base URL of your Jenkins server.

Type:string
version

The version of your provider.

Type:string (optional)
Default:‘1’

JenkinsProviderProps (interface)

class @aws-cdk/aws-codepipeline.JenkinsProviderProps

Language-specific names:

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

The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.

Type:string
serverUrl

The base URL of your Jenkins server.

Type:string
forBuild

Whether to immediately register a Jenkins Provider for the build category.

The Provider will always be registered if you create a {@link JenkinsBuildAction}.

Type:boolean (optional)
forTest

Whether to immediately register a Jenkins Provider for the test category.

The Provider will always be registered if you create a {@link JenkinsTestAction}.

Type:boolean (optional)
version

The version of your provider.

Type:string (optional)
Default:‘1’

JenkinsTestAction

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

Language-specific names:

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

Jenkins test CodePipeline Action.

Extends:

@aws-cdk/aws-codepipeline-api.TestAction

Parameters:
addInputArtifact([artifact]) → @aws-cdk/aws-codepipeline-api.Action

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

Protected method

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

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

Protected method

Parameters:name (string (optional)) –
Return type:@aws-cdk/aws-codepipeline-api.Artifact
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

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

Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

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

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

Return type:string[]
category

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

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:@aws-cdk/aws-codepipeline-api.ActionCategory (readonly)
owner

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

Type:string (readonly)
provider

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

The service provider that the action calls.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline-api.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)
version

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

Type:string (readonly)
configuration

Inherited from @aws-cdk/aws-codepipeline-api.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-api.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-api.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)
outputArtifact

Inherited from @aws-cdk/aws-codepipeline-api.TestAction

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional) (readonly)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)

JenkinsTestActionProps (interface)

class @aws-cdk/aws-codepipeline.JenkinsTestActionProps

Language-specific names:

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

Construction properties of {@link JenkinsTestAction}.

Extends:BasicJenkinsTestActionProps
Extends:@aws-cdk/aws-codepipeline-api.CommonActionConstructProps
jenkinsProvider

The Jenkins Provider for this Action.

Type:IJenkinsProvider
stage

Inherited from @aws-cdk/aws-codepipeline-api.CommonActionConstructProps

The Pipeline Stage to add this Action to.

Type:@aws-cdk/aws-codepipeline-api.IStage
runOrder

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

The runOrder property for this Action.

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

Type:number (optional)
Default:1
projectName

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

The name of the project (sometimes also called job, or task)

on your Jenkins installation that will be invoked by this Action.

Type:string
inputArtifact

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

The source to use as input for this build.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
Default:CodePipeline will use the output of the last Action from a previous Stage as input
outputArtifactName

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

The optional name of the primary 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)
Default:the Action will not have an output artifact

ManualApprovalAction

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

Language-specific names:

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

Manual approval action.

Extends:

@aws-cdk/aws-codepipeline-api.Action

Parameters:
notificationTopic

The SNS Topic passed when constructing the Action.

If no Topic was passed, but notifyEmails were provided,

a new Topic will be created.

Type:@aws-cdk/aws-sns.ITopic (optional) (readonly)
addInputArtifact([artifact]) → @aws-cdk/aws-codepipeline-api.Action

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

Protected method

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

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

Protected method

Parameters:name (string (optional)) –
Return type:@aws-cdk/aws-codepipeline-api.Artifact
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

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

Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

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

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

Return type:string[]
category

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

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:@aws-cdk/aws-codepipeline-api.ActionCategory (readonly)
owner

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

Type:string (readonly)
provider

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

The service provider that the action calls.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline-api.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)
version

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

Type:string (readonly)
configuration

Inherited from @aws-cdk/aws-codepipeline-api.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-api.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-api.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)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)

ManualApprovalActionProps (interface)

class @aws-cdk/aws-codepipeline.ManualApprovalActionProps

Language-specific names:

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

Construction properties of the {@link ManualApprovalAction}.

Extends:@aws-cdk/aws-codepipeline-api.CommonActionProps
Extends:@aws-cdk/aws-codepipeline-api.CommonActionConstructProps
additionalInformation

Any additional information that you want to include in the notification email message.

Type:string (optional)
notificationTopic

Optional SNS topic to send notifications to when an approval is pending.

Type:@aws-cdk/aws-sns.ITopic (optional)
notifyEmails

A list of email addresses to subscribe to notifications when this Action is pending approval.

If this has been provided, but not notificationTopic,

a new Topic will be created.

Type:string[] (optional)
stage

Inherited from @aws-cdk/aws-codepipeline-api.CommonActionConstructProps

The Pipeline Stage to add this Action to.

Type:@aws-cdk/aws-codepipeline-api.IStage
runOrder

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

The runOrder property for this Action.

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

Type:number (optional)
Default:1

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:

@aws-cdk/aws-codepipeline-api.IPipeline

Parameters:
addStage(name[, props]) → @aws-cdk/aws-codepipeline.Stage

Convenience method for creating a new {@link Stage},

and adding it to this Pipeline.

Parameters:
  • name (string) – the name of the newly created Stage
  • props (CommonStageProps (optional)) – the optional construction properties of the new Stage
Returns:

the newly created Stage

Return type:

Stage

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])

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

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

Parameters:identity (@aws-cdk/aws-iam.IPrincipal (optional)) –
grantBucketReadWrite([identity])

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

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

Parameters:identity (@aws-cdk/aws-iam.IPrincipal (optional)) –
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-api.IPipeline.pipelineArn()

ARN of this pipeline

Type:string (readonly)
pipelineName

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

The name of the pipeline

Type:string (readonly)
pipelineVersion

The version of the pipeline

Type:string (readonly)
role

Implements @aws-cdk/aws-codepipeline-api.IPipeline.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)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)
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)
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)
restartExecutionOnUpdate

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

Type:boolean (optional)

Stage

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

Language-specific names:

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

A Stage in a Pipeline.

Stages are added to a Pipeline by constructing a new Stage,

and passing the Pipeline it belongs to through the {@link StageProps#pipeline} attribute.

Extends:

@aws-cdk/cdk.Construct

Implements:

@aws-cdk/aws-codepipeline-api.IStage

Implements:

@aws-cdk/aws-codepipeline-api.IInternalStage

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

@aws-cdk/aws-events.EventRule

render() → @aws-cdk/aws-codepipeline.CfnPipeline.StageDeclarationProperty
Return type:StageDeclarationProperty
validate() → string[]

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

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

Return type:string[]
actions

Get a duplicate of this stage’s list of actions.

Type:@aws-cdk/aws-codepipeline-api.Action[] (readonly)
name

Implements @aws-cdk/aws-codepipeline-api.IStage.name()

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

Type:string (readonly)
pipeline

Implements @aws-cdk/aws-codepipeline-api.IStage.pipeline()

The Pipeline this Stage is a part of.

Type:@aws-cdk/aws-codepipeline-api.IPipeline (readonly)
apply(aspect)

Inherited from @aws-cdk/cdk.Construct

Applies the aspect to this Constructs node

Parameters:aspect (@aws-cdk/cdk.IAspect) –
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)

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:Stage (optional) (readonly)
rightBefore

Inserts the new Stage as a parent of the given Stage

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

Type:Stage (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';

The construction properties for {@link Stage}.

Extends:CommonStageProps
pipeline

The Pipeline to add the newly created Stage to.

Type:Pipeline
placement

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

Allows specifying where should the newly created {@link Stage}

be placed in the Pipeline.

Type:StagePlacement (optional)
Default:the stage is added at the end of the Pipeline