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-api

AWS CodePipeline Actions API

This package contains the abstract API of Pipeline Actions. It’s used by the aws-codepipeline module, and the AWS service modules that integrate with AWS CodePipeline.

You should never need to depend on it directly - instead, depend on aws-codepipeline, and the module you need the concrete Actions from (like aws-codecommit, aws-codebuild, etc.).

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.Codepipeline.Api" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.Codepipeline.Api --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.Codepipeline.Api" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:codepipeline-api:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="codepipeline-api" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>codepipeline-api</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:codepipeline-api:0.25.3'

Groovy Grape:

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

View in NPM

npm:

$ npm i @aws-cdk/aws-codepipeline-api@0.25.3

package.json:

{
  "@aws-cdk/aws-codepipeline-api": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-codepipeline-api@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-codepipeline-api@0.25.3

package.json:

{
  "@aws-cdk/aws-codepipeline-api": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-codepipeline-api@0.25.3

Action

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

Language-specific names:

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

Low-level class for generic CodePipeline Actions.

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

{@link codebuild.PipelineBuildAction}.

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

Protected method

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

Protected method

Parameters:name (string) –
Return type:Artifact
bind(stage, scope)

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

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

Protected method

Parameters:
  • stage (IStage) – the stage this action has been added to (includes a reference to the pipeline as well)
  • scope (@aws-cdk/cdk.Construct) – the scope construct for this action, can be used by the action implementation to create any resources it needs to work correctly
Abstract:

Yes

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

@aws-cdk/aws-events.EventRule

validate() → string[]

Protected method

Return type:string[]
actionName
Type:string (readonly)
category

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

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

The service provider that the action calls.

Type:string (readonly)
runOrder

The order in which AWS CodePipeline runs this action.

For more information, see the AWS CodePipeline User Guide.

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

Type:number (readonly)
scope

Retrieves the Construct scope of this Action.

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

and that Stage to a Pipeline.

Protected property

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

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

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional) (readonly)
region

The AWS region the given Action resides in.

Note that a cross-region Pipeline requires replication buckets to function correctly.

You can provide their names with the {@link PipelineProps#crossRegionReplicationBuckets} property.

If you don’t, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets,

that you will need to cdk deploy before deploying the main, Pipeline-containing Stack.

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

The service role that is assumed during execution of action.

This role is not mandatory, however more advanced configuration

may require specifying it.

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

ActionArtifactBounds (interface)

class @aws-cdk/aws-codepipeline-api.ActionArtifactBounds

Language-specific names:

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

Specifies the constraints on the number of input and output

artifacts an action can have.

The constraints for each action type are documented on the

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

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

ActionCategory (enum)

class @aws-cdk/aws-codepipeline-api.ActionCategory

Language-specific names:

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

ActionProps (interface)

class @aws-cdk/aws-codepipeline-api.ActionProps

Language-specific names:

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

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

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

The region this Action resides in.

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

The service role that is assumed during execution of action.

This role is not mandatory, however more advanced configuration

may require specifying it.

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

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

The physical, human-readable name of the Action.

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

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

Artifact

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

Language-specific names:

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

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

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

Returns an ArtifactPath for a file within this artifact.

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

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

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

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

string

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

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

Type:string (readonly)
objectKey

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

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

Type:string (readonly)
url

The artifact attribute of the Amazon Simple Storage Service (Amazon S3) URL of the artifact,

such as https://s3-us-west-2.amazonaws.com/artifactstorebucket-yivczw8jma0c/test/TemplateSo/1ABCyZZ.zip.

Type:string (readonly)

ArtifactPath

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

Language-specific names:

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

A specific file within an output artifact.

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

for a CloudFormation action.

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

BuildAction

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

Language-specific names:

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

Low level class for build actions.

It is recommended that concrete types are used instead,

such as {@link codebuild.PipelineBuildAction}.

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

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

Protected method

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

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

Protected method

Parameters:name (string) –
Return type:Artifact
bind(stage, scope)

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

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

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

Protected method

Parameters:
  • stage (IStage) – the stage this action has been added to (includes a reference to the pipeline as well)
  • scope (@aws-cdk/cdk.Construct) – the scope construct for this action, can be used by the action implementation to create any resources it needs to work correctly
Abstract:

Yes

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

Protected method

Return type:string[]
actionName

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

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

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

Retrieves the Construct scope of this Action.

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

and that Stage to a Pipeline.

Protected property

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

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

BuildActionProps (interface)

class @aws-cdk/aws-codepipeline-api.BuildActionProps

Language-specific names:

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

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

Extends:CommonActionProps
artifactBounds

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

Type:ActionArtifactBounds
inputArtifact

The source to use as input for this build.

Type:Artifact
outputArtifactName

The name of the build’s output artifact.

Type:string
provider

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

Type:string
configuration

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

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional)
owner

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

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

The build Action version.

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

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

The physical, human-readable name of the Action.

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

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

CommonActionProps (interface)

class @aws-cdk/aws-codepipeline-api.CommonActionProps

Language-specific names:

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

Common properties shared by all Actions.

actionName

The physical, human-readable name of the Action.

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

Type:string
runOrder

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

DeployAction

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

Language-specific names:

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

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

Protected method

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

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

Protected method

Parameters:name (string) –
Return type:Artifact
bind(stage, scope)

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

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

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

Protected method

Parameters:
  • stage (IStage) – the stage this action has been added to (includes a reference to the pipeline as well)
  • scope (@aws-cdk/cdk.Construct) – the scope construct for this action, can be used by the action implementation to create any resources it needs to work correctly
Abstract:

Yes

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

Protected method

Return type:string[]
actionName

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

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

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

Retrieves the Construct scope of this Action.

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

and that Stage to a Pipeline.

Protected property

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

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

DeployActionProps (interface)

class @aws-cdk/aws-codepipeline-api.DeployActionProps

Language-specific names:

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

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

The physical, human-readable name of the Action.

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

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

IPipeline (interface)

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

Language-specific names:

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

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

It extends {@link events.IEventRuleTarget},

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

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

The ARN of the Pipeline.

Type:string (readonly)
pipelineName

The name of the Pipeline.

Type:string (readonly)
role

The service Role of the Pipeline.

Type:@aws-cdk/aws-iam.Role (readonly)
grantBucketRead([identity])

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

Parameters:identity (@aws-cdk/aws-iam.IPrincipal (optional)) – the IAM Identity to grant the permissions to
Abstract:Yes
grantBucketReadWrite([identity])

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

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

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

Returns the rule target specification.

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

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

@aws-cdk/aws-events.EventRuleTargetProps

Abstract:

Yes

node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

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

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

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

IStage (interface)

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

Language-specific names:

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

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

pipeline

The Pipeline this Stage belongs to.

Type:IPipeline (readonly)
stageName

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

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

@aws-cdk/aws-events.EventRule

Abstract:

Yes

SourceAction

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

Language-specific names:

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

Low-level class for source actions.

It is recommended that concrete types are used instead,

such as {@link s3.PipelineSourceAction} or

{@link codecommit.PipelineSourceAction}.

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

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

Protected method

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

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

Protected method

Parameters:name (string) –
Return type:Artifact
bind(stage, scope)

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

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

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

Protected method

Parameters:
  • stage (IStage) – the stage this action has been added to (includes a reference to the pipeline as well)
  • scope (@aws-cdk/cdk.Construct) – the scope construct for this action, can be used by the action implementation to create any resources it needs to work correctly
Abstract:

Yes

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

Protected method

Return type:string[]
actionName

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

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

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

Retrieves the Construct scope of this Action.

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

and that Stage to a Pipeline.

Protected property

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

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

SourceActionProps (interface)

class @aws-cdk/aws-codepipeline-api.SourceActionProps

Language-specific names:

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

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

Extends:CommonActionProps
outputArtifactName

The name of the source’s output artifact.

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

Type:string
provider

The service provider that the action calls.

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

Type:string
configuration

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

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional)
owner

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

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

The source Action version.

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

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

The physical, human-readable name of the Action.

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

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

TestAction

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

Language-specific names:

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

The low-level test Action.

Test Actions are very similar to build Actions -

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

You should never need to use this class directly,

instead preferring the concrete implementations,

like {@link codebuild.PipelineTestAction}.

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

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

Protected method

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

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

Protected method

Parameters:name (string) –
Return type:Artifact
bind(stage, scope)

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

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

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

Protected method

Parameters:
  • stage (IStage) – the stage this action has been added to (includes a reference to the pipeline as well)
  • scope (@aws-cdk/cdk.Construct) – the scope construct for this action, can be used by the action implementation to create any resources it needs to work correctly
Abstract:

Yes

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

Protected method

Return type:string[]
actionName

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

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

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

Retrieves the Construct scope of this Action.

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

and that Stage to a Pipeline.

Protected property

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

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

TestActionProps (interface)

class @aws-cdk/aws-codepipeline-api.TestActionProps

Language-specific names:

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

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

Extends:CommonActionProps
artifactBounds

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

Type:ActionArtifactBounds
inputArtifact

The source to use as input for this test.

Type:Artifact
provider

The service provider that the action calls.

Type:string
configuration

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

For more information, see the AWS CodePipeline User Guide.

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

Type:any (optional)
outputArtifactName

The optional name of the output artifact.

If you provide a value here,

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

If you don’t, outputArtifact will be null.

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

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

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

The test Action version.

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

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

The physical, human-readable name of the Action.

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

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