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

CDK Constructs for AWS CloudFormation

This module is part of the AWS Cloud Development Kit project.

CodePipeline Actions for CloudFormation

This module contains Actions that allows you to deploy to CloudFormation from AWS CodePipeline.

For example, the following code fragment defines a pipeline that automatically deploys a CloudFormation template directly from a CodeCommit repository, with a manual approval step in between to confirm the changes:

// Source stage: read from repository
const repo = new codecommit.Repository(stack, 'TemplateRepo', {
  repositoryName: 'template-repo'
});
const source = new codecommit.PipelineSourceAction({
  actionName: 'Source',
  repository: repo,
  outputArtifactName: 'SourceArtifact',
  pollForSourceChanges: true,
});
const sourceStage = {
  name: 'Source',
  actions: [source],
};

// Deployment stage: create and deploy changeset with manual approval
const stackName = 'OurStack';
const changeSetName = 'StagedChangeSet';

const prodStage = {
  name: 'Deploy',
  actions: [
    new cfn.PipelineCreateReplaceChangeSetAction({
      actionName: 'PrepareChanges',
      stackName,
      changeSetName,
      adminPermissions: true,
      templatePath: source.outputArtifact.atPath('template.yaml'),
      runOrder: 1,
    }),
    new codepipeline.ManualApprovalAction({
      actionName: 'ApproveChanges',
      runOrder: 2,
    }),
    new cfn.PipelineExecuteChangeSetAction({
      actionName: 'ExecuteChanges',
      stackName,
      changeSetName,
      runOrder: 3,
    }),
  ],
};

new codepipeline.Pipeline(stack, 'Pipeline', {
  stages: [
      sourceStage,
      prodStage,
  ],
});

See the AWS documentation for more details about using CloudFormation in CodePipeline.

Actions defined by this package

This package defines the following actions:

  • PipelineCreateUpdateStackAction - Deploy a CloudFormation template directly from the pipeline. The indicated stack is created, or updated if it already exists. If the stack is in a failure state, deployment will fail (unless replaceOnFailure is set to true, in which case it will be destroyed and recreated).
  • PipelineDeleteStackAction - Delete the stack with the given name.
  • PipelineCreateReplaceChangeSetAction - Prepare a change set to be applied later. You will typically use change sets if you want to manually verify the changes that are being staged, or if you want to separate the people (or system) preparing the changes from the people (or system) applying the changes.
  • PipelineExecuteChangeSetAction - Execute a change set prepared previously.

Custom Resources

Custom Resources are CloudFormation resources that are implemented by arbitrary user code. They can do arbitrary lookups or modifications during a CloudFormation synthesis run.

You will typically use Lambda to implement a Construct implemented as a Custom Resource (though SNS topics can be used as well). Your Lambda function will be sent a CREATE, UPDATE or DELETE message, depending on the CloudFormation life cycle, and can return any number of output values which will be available as attributes of your Construct. In turn, those can be used as input to other Constructs in your model.

In general, consumers of your Construct will not need to care whether it is implemented in term of other CloudFormation resources or as a custom resource.

Note: when implementing your Custom Resource using a Lambda, use a SingletonLambda so that even if your custom resource is instantiated multiple times, the Lambda will only get uploaded once.

Example

Sample of a Custom Resource that copies files into an S3 bucket during deployment (implementation of actual copy.py operation elided).

interface CopyOperationProps {
    sourceBucket: IBucket;
    targetBucket: IBucket;
}

class CopyOperation extends Construct {
    constructor(parent: Construct, name: string, props: DemoResourceProps) {
        super(parent, name);

        const lambdaProvider = new SingletonLambda(this, 'Provider', {
            uuid: 'f7d4f730-4ee1-11e8-9c2d-fa7ae01bbebc',
            code: new LambdaInlineCode(resources['copy.py']),
            handler: 'index.handler',
            timeout: 60,
            runtime: LambdaRuntime.Python3,
        });

        new CustomResource(this, 'Resource', {
            lambdaProvider,
            properties: {
                sourceBucketArn: props.sourceBucket.bucketArn,
                targetBucketArn: props.targetBucket.bucketArn,
            }
        });
    }
}

More examples are in the example directory, including an example of how to use the cfnresponse module that is provided for you by CloudFormation.

References

See the following section of the docs on details to write Custom Resources:

Reference

View in Nuget

csproj:

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

dotnet:

dotnet add package Amazon.CDK.AWS.CloudFormation --version 0.25.3

packages.config:

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

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:cloudformation:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="cloudformation" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>cloudformation</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:cloudformation:0.25.3'

Groovy Grape:

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

View in NPM

npm:

$ npm i @aws-cdk/aws-cloudformation@0.25.3

package.json:

{
  "@aws-cdk/aws-cloudformation": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-cloudformation@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-cloudformation@0.25.3

package.json:

{
  "@aws-cdk/aws-cloudformation": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-cloudformation@0.25.3

CfnCustomResource

class @aws-cdk/aws-cloudformation.CfnCustomResource(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.CfnCustomResource;
const { CfnCustomResource } = require('@aws-cdk/aws-cloudformation');
import { CfnCustomResource } from '@aws-cdk/aws-cloudformation';
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:CfnCustomResourceProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

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

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

Protected method

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

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

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

Inherited from @aws-cdk/cdk.Construct

Construct node.

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

CfnCustomResourceProps (interface)

class @aws-cdk/aws-cloudformation.CfnCustomResourceProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.CfnCustomResourceProps;
// CfnCustomResourceProps is an interface
import { CfnCustomResourceProps } from '@aws-cdk/aws-cloudformation';
serviceToken

AWS::CloudFormation::CustomResource.ServiceToken

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetoken

Type:string

CfnMacro

class @aws-cdk/aws-cloudformation.CfnMacro(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.CfnMacro;
const { CfnMacro } = require('@aws-cdk/aws-cloudformation');
import { CfnMacro } from '@aws-cdk/aws-cloudformation';
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)
macroName
Type:string (readonly)
propertyOverrides
Type:CfnMacroProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

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

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

Protected method

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

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

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

Inherited from @aws-cdk/cdk.Construct

Construct node.

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

CfnMacroProps (interface)

class @aws-cdk/aws-cloudformation.CfnMacroProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.CfnMacroProps;
// CfnMacroProps is an interface
import { CfnMacroProps } from '@aws-cdk/aws-cloudformation';
functionName

AWS::CloudFormation::Macro.FunctionName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname

Type:string
name

AWS::CloudFormation::Macro.Name

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

Type:string
description

AWS::CloudFormation::Macro.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description

Type:string (optional)
logGroupName

AWS::CloudFormation::Macro.LogGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname

Type:string (optional)
logRoleArn

AWS::CloudFormation::Macro.LogRoleARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn

Type:string (optional)

CfnStack

class @aws-cdk/aws-cloudformation.CfnStack(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.CfnStack;
const { CfnStack } = require('@aws-cdk/aws-cloudformation');
import { CfnStack } from '@aws-cdk/aws-cloudformation';
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:CfnStackProps (readonly)
stackId
Type:string (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

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

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

Protected method

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

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

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

Inherited from @aws-cdk/cdk.Construct

Construct node.

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

CfnStackProps (interface)

class @aws-cdk/aws-cloudformation.CfnStackProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.CfnStackProps;
// CfnStackProps is an interface
import { CfnStackProps } from '@aws-cdk/aws-cloudformation';
templateUrl

AWS::CloudFormation::Stack.TemplateURL

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl

Type:string
notificationArns

AWS::CloudFormation::Stack.NotificationARNs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
parameters

AWS::CloudFormation::Stack.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
tags

AWS::CloudFormation::Stack.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)
timeoutInMinutes

AWS::CloudFormation::Stack.TimeoutInMinutes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes

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

CfnWaitCondition

class @aws-cdk/aws-cloudformation.CfnWaitCondition(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.CfnWaitCondition;
const { CfnWaitCondition } = require('@aws-cdk/aws-cloudformation');
import { CfnWaitCondition } from '@aws-cdk/aws-cloudformation';
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:CfnWaitConditionProps (readonly)
waitConditionData
Type:@aws-cdk/cdk.Token (readonly)
waitConditionName
Type:string (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

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

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

Protected method

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

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

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

Inherited from @aws-cdk/cdk.Construct

Construct node.

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

CfnWaitConditionHandle

class @aws-cdk/aws-cloudformation.CfnWaitConditionHandle(scope, id)

Language-specific names:

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

@aws-cdk/cdk.Resource

Parameters:
  • scope (@aws-cdk/cdk.Construct) – scope in which this resource is defined
  • id (string) – scoped id of the resource
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
waitConditionHandleUrl
Type:string (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

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

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

Protected method

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

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

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

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
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
renderProperties(properties) → string => any

Inherited from @aws-cdk/cdk.Resource

Protected method

Parameters:properties (any) –
Return type:string => any
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)

CfnWaitConditionProps (interface)

class @aws-cdk/aws-cloudformation.CfnWaitConditionProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.CfnWaitConditionProps;
// CfnWaitConditionProps is an interface
import { CfnWaitConditionProps } from '@aws-cdk/aws-cloudformation';
count

AWS::CloudFormation::WaitCondition.Count

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count

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

AWS::CloudFormation::WaitCondition.Handle

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle

Type:string (optional)
timeout

AWS::CloudFormation::WaitCondition.Timeout

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout

Type:string (optional)

CloudFormationCapabilities (enum)

class @aws-cdk/aws-cloudformation.CloudFormationCapabilities

Language-specific names:

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

Capabilities that affect whether CloudFormation is allowed to change IAM resources

None

No IAM Capabilities

Pass this capability if you wish to block the creation IAM resources.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities

AnonymousIAM

Capability to create anonymous IAM resources

Pass this capability if you’re only creating anonymous resources.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities

NamedIAM

Capability to create named IAM resources.

Pass this capability if you’re creating IAM resources that have physical

names.

CloudFormationCapabilities.NamedIAM implies CloudFormationCapabilities.IAM; you don’t have to pass both.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities

CustomResource

class @aws-cdk/aws-cloudformation.CustomResource(scope, id, props)

Language-specific names:

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

Custom resource that is implemented using a Lambda

As a custom resource author, you should be publishing a subclass of this class

that hides the choice of provider, and accepts a strongly-typed properties

object with the properties your provider accepts.

Extends:

CfnCustomResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/aws-cloudformation.CfnCustomResource.renderProperties()

Override renderProperties to mix in the user-defined properties

Protected method

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

Inherited from @aws-cdk/aws-cloudformation.CfnCustomResource

Type:CfnCustomResourceProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

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

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

Protected method

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

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

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

Inherited from @aws-cdk/cdk.Construct

Construct node.

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

CustomResourceProps (interface)

class @aws-cdk/aws-cloudformation.CustomResourceProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.CustomResourceProps;
// CustomResourceProps is an interface
import { CustomResourceProps } from '@aws-cdk/aws-cloudformation';

Properties to provide a Lambda-backed custom resource

lambdaProvider

The Lambda provider that implements this custom resource.

We recommend using a lambda.SingletonFunction for this.

Optional, exactly one of lamdaProvider or topicProvider must be set.

Type:@aws-cdk/aws-lambda.IFunction (optional)
properties

Properties to pass to the Lambda

Type:string => any (optional)
resourceType

For custom resources, you can specify AWS::CloudFormation::CustomResource

(the default) as the resource type, or you can specify your own resource

type name. For example, you can use “Custom::MyCustomResourceTypeName”.

Custom resource type names must begin with “Custom::” and can include

alphanumeric characters and the following characters: _@-. You can specify

a custom resource type name up to a maximum length of 60 characters. You

cannot change the type during an update.

Using your own resource type names helps you quickly differentiate the

types of custom resources in your stack. For example, if you had two custom

resources that conduct two different ping tests, you could name their type

as Custom::PingTester to make them easily identifiable as ping testers

(instead of using AWS::CloudFormation::CustomResource).

Type:string (optional)
topicProvider

The SNS Topic for the provider that implements this custom resource.

Optional, exactly one of lamdaProvider or topicProvider must be set.

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

PipelineCloudFormationAction

class @aws-cdk/aws-cloudformation.PipelineCloudFormationAction(props[, configuration])

Language-specific names:

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

Base class for Actions that execute CloudFormation

Extends:

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

Abstract:

Yes

Parameters:
outputArtifact

Output artifact containing the CloudFormation call response

Only present if configured by passing outputFileName.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
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) –
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) –
Return type:@aws-cdk/aws-codepipeline-api.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 (@aws-cdk/aws-codepipeline-api.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:@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)
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)

PipelineCloudFormationActionProps (interface)

class @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.PipelineCloudFormationActionProps;
// PipelineCloudFormationActionProps is an interface
import { PipelineCloudFormationActionProps } from '@aws-cdk/aws-cloudformation';

Properties common to all CloudFormation actions

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

The name of the stack to apply this action to

Type:string
outputArtifactName

The name of the output artifact to generate

Only applied if outputFileName is set as well.

Type:string (optional)
Default:Automatically generated artifact name.
outputFileName

A name for the filename in the output artifact to store the AWS CloudFormation call’s result.

The file will contain the result of the call to AWS CloudFormation (for example

the call to UpdateStack or CreateChangeSet).

AWS CodePipeline adds the file to the output artifact after performing

the specified action.

Type:string (optional)
Default:No output artifact generated
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)
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)
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

PipelineCloudFormationDeployAction

class @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction(props, configuration)

Language-specific names:

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

Base class for all CloudFormation actions that execute or stage deployments.

Extends:

PipelineCloudFormationAction

Abstract:

Yes

Parameters:
addToDeploymentRolePolicy(statement)

Add statement to the service role assumed by CloudFormation while executing this action.

Parameters:statement (@aws-cdk/aws-iam.PolicyStatement) –
bind(stage, scope)

Implements @aws-cdk/aws-codepipeline-api.Action.bind()

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:
deploymentRole
Type:@aws-cdk/aws-iam.IRole (readonly)
outputArtifact

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationAction

Output artifact containing the CloudFormation call response

Only present if configured by passing outputFileName.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
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) –
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) –
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

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:@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)
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)

PipelineCloudFormationDeployActionProps (interface)

class @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.PipelineCloudFormationDeployActionProps;
// PipelineCloudFormationDeployActionProps is an interface
import { PipelineCloudFormationDeployActionProps } from '@aws-cdk/aws-cloudformation';

Properties common to CloudFormation actions that stage deployments

Extends:PipelineCloudFormationActionProps
adminPermissions

Whether to grant full permissions to CloudFormation while deploying this template.

Setting this to true affects the defaults for role and capabilities, if you

don’t specify any alternatives.

The default role that will be created for you will have full (i.e., *)

permissions on all resources, and the deployment will have named IAM

capabilities (i.e., able to create all IAM resources).

This is a shorthand that you can use if you fully trust the templates that

are deployed in this pipeline. If you want more fine-grained permissions,

use addToRolePolicy and capabilities to control what the CloudFormation

deployment is allowed to do.

Type:boolean
capabilities

Acknowledge certain changes made as part of deployment

For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation

might create or update those resources. For example, you must specify AnonymousIAM or NamedIAM

if your stack template contains AWS Identity and Access Management (IAM) resources. For more

information see the link below.

Type:CloudFormationCapabilities (optional)
Default:None, unless adminPermissions is true
deploymentRole

IAM role to assume when deploying changes.

If not specified, a fresh role is created. The role is created with zero

permissions unless adminPermissions is true, in which case the role will have

full permissions.

Type:@aws-cdk/aws-iam.IRole (optional)
Default:A fresh role with full or no permissions (depending on the value of adminPermissions).
parameterOverrides

Additional template parameters.

Template parameters specified here take precedence over template parameters

found in the artifact specified by the templateConfiguration property.

We recommend that you use the template configuration file to specify

most of your parameter values. Use parameter overrides to specify only

dynamic parameter values (values that are unknown until you run the

pipeline).

All parameter names must be present in the stack template.

Note: the entire object cannot be more than 1kB.

Type:string => any (optional)
Default:No overrides
templateConfiguration

Input artifact to use for template parameters values and stack policy.

The template configuration file should contain a JSON object that should look like this:

{ “Parameters”: {…}, “Tags”: {…}, “StackPolicy”: {… }}. For more information,

see [AWS CloudFormation Artifacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-cfn-artifacts.html).

Note that if you include sensitive information, such as passwords, restrict access to this

file.

Type:@aws-cdk/aws-codepipeline-api.ArtifactPath (optional)
Default:No template configuration based on input artifacts
stackName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the stack to apply this action to

Type:string
outputArtifactName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the output artifact to generate

Only applied if outputFileName is set as well.

Type:string (optional)
Default:Automatically generated artifact name.
outputFileName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

A name for the filename in the output artifact to store the AWS CloudFormation call’s result.

The file will contain the result of the call to AWS CloudFormation (for example

the call to UpdateStack or CreateChangeSet).

AWS CodePipeline adds the file to the output artifact after performing

the specified action.

Type:string (optional)
Default:No output artifact generated
region

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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

PipelineCreateReplaceChangeSetAction

class @aws-cdk/aws-cloudformation.PipelineCreateReplaceChangeSetAction(props)

Language-specific names:

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

CodePipeline action to prepare a change set.

Creates the change set if it doesn’t exist based on the stack name and template that you submit.

If the change set exists, AWS CloudFormation deletes it, and then creates a new one.

Extends:PipelineCloudFormationDeployAction
Parameters:props (PipelineCreateReplaceChangeSetActionProps) –
bind(stage, scope)

Overrides @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction.bind()

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

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationAction

Output artifact containing the CloudFormation call response

Only present if configured by passing outputFileName.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
addToDeploymentRolePolicy(statement)

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction

Add statement to the service role assumed by CloudFormation while executing this action.

Parameters:statement (@aws-cdk/aws-iam.PolicyStatement) –
deploymentRole

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction

Type:@aws-cdk/aws-iam.IRole (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) –
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) –
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

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:@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)
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)

PipelineCreateReplaceChangeSetActionProps (interface)

class @aws-cdk/aws-cloudformation.PipelineCreateReplaceChangeSetActionProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.PipelineCreateReplaceChangeSetActionProps;
// PipelineCreateReplaceChangeSetActionProps is an interface
import { PipelineCreateReplaceChangeSetActionProps } from '@aws-cdk/aws-cloudformation';

Properties for the PipelineCreateReplaceChangeSetAction.

Extends:PipelineCloudFormationDeployActionProps
changeSetName

Name of the change set to create or update.

Type:string
templatePath

Input artifact with the ChangeSet’s CloudFormation template

Type:@aws-cdk/aws-codepipeline-api.ArtifactPath
stackName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the stack to apply this action to

Type:string
outputArtifactName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the output artifact to generate

Only applied if outputFileName is set as well.

Type:string (optional)
Default:Automatically generated artifact name.
outputFileName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

A name for the filename in the output artifact to store the AWS CloudFormation call’s result.

The file will contain the result of the call to AWS CloudFormation (for example

the call to UpdateStack or CreateChangeSet).

AWS CodePipeline adds the file to the output artifact after performing

the specified action.

Type:string (optional)
Default:No output artifact generated
region

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Whether to grant full permissions to CloudFormation while deploying this template.

Setting this to true affects the defaults for role and capabilities, if you

don’t specify any alternatives.

The default role that will be created for you will have full (i.e., *)

permissions on all resources, and the deployment will have named IAM

capabilities (i.e., able to create all IAM resources).

This is a shorthand that you can use if you fully trust the templates that

are deployed in this pipeline. If you want more fine-grained permissions,

use addToRolePolicy and capabilities to control what the CloudFormation

deployment is allowed to do.

Type:boolean
capabilities

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Acknowledge certain changes made as part of deployment

For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation

might create or update those resources. For example, you must specify AnonymousIAM or NamedIAM

if your stack template contains AWS Identity and Access Management (IAM) resources. For more

information see the link below.

Type:CloudFormationCapabilities (optional)
Default:None, unless adminPermissions is true
deploymentRole

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

IAM role to assume when deploying changes.

If not specified, a fresh role is created. The role is created with zero

permissions unless adminPermissions is true, in which case the role will have

full permissions.

Type:@aws-cdk/aws-iam.IRole (optional)
Default:A fresh role with full or no permissions (depending on the value of adminPermissions).
parameterOverrides

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Additional template parameters.

Template parameters specified here take precedence over template parameters

found in the artifact specified by the templateConfiguration property.

We recommend that you use the template configuration file to specify

most of your parameter values. Use parameter overrides to specify only

dynamic parameter values (values that are unknown until you run the

pipeline).

All parameter names must be present in the stack template.

Note: the entire object cannot be more than 1kB.

Type:string => any (optional)
Default:No overrides
templateConfiguration

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Input artifact to use for template parameters values and stack policy.

The template configuration file should contain a JSON object that should look like this:

{ “Parameters”: {…}, “Tags”: {…}, “StackPolicy”: {… }}. For more information,

see [AWS CloudFormation Artifacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-cfn-artifacts.html).

Note that if you include sensitive information, such as passwords, restrict access to this

file.

Type:@aws-cdk/aws-codepipeline-api.ArtifactPath (optional)
Default:No template configuration based on input artifacts
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

PipelineCreateUpdateStackAction

class @aws-cdk/aws-cloudformation.PipelineCreateUpdateStackAction(props)

Language-specific names:

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

CodePipeline action to deploy a stack.

Creates the stack if the specified stack doesn’t exist. If the stack exists,

AWS CloudFormation updates the stack. Use this action to update existing

stacks.

AWS CodePipeline won’t replace the stack, and will fail deployment if the

stack is in a failed state. Use ReplaceOnFailure for an action that

will delete and recreate the stack to try and recover from failed states.

Use this action to automatically replace failed stacks without recovering or

troubleshooting them. You would typically choose this mode for testing.

Extends:PipelineCloudFormationDeployAction
Parameters:props (PipelineCreateUpdateStackActionProps) –
bind(stage, scope)

Overrides @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction.bind()

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

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationAction

Output artifact containing the CloudFormation call response

Only present if configured by passing outputFileName.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
addToDeploymentRolePolicy(statement)

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction

Add statement to the service role assumed by CloudFormation while executing this action.

Parameters:statement (@aws-cdk/aws-iam.PolicyStatement) –
deploymentRole

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction

Type:@aws-cdk/aws-iam.IRole (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) –
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) –
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

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:@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)
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)

PipelineCreateUpdateStackActionProps (interface)

class @aws-cdk/aws-cloudformation.PipelineCreateUpdateStackActionProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.PipelineCreateUpdateStackActionProps;
// PipelineCreateUpdateStackActionProps is an interface
import { PipelineCreateUpdateStackActionProps } from '@aws-cdk/aws-cloudformation';

Properties for the PipelineCreateUpdateStackAction.

Extends:PipelineCloudFormationDeployActionProps
templatePath

Input artifact with the CloudFormation template to deploy

Type:@aws-cdk/aws-codepipeline-api.ArtifactPath
replaceOnFailure

Replace the stack if it’s in a failed state.

If this is set to true and the stack is in a failed state (one of

ROLLBACK_COMPLETE, ROLLBACK_FAILED, CREATE_FAILED, DELETE_FAILED, or

UPDATE_ROLLBACK_FAILED), AWS CloudFormation deletes the stack and then

creates a new stack.

If this is not set to true and the stack is in a failed state,

the deployment fails.

Type:boolean (optional)
Default:false
stackName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the stack to apply this action to

Type:string
outputArtifactName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the output artifact to generate

Only applied if outputFileName is set as well.

Type:string (optional)
Default:Automatically generated artifact name.
outputFileName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

A name for the filename in the output artifact to store the AWS CloudFormation call’s result.

The file will contain the result of the call to AWS CloudFormation (for example

the call to UpdateStack or CreateChangeSet).

AWS CodePipeline adds the file to the output artifact after performing

the specified action.

Type:string (optional)
Default:No output artifact generated
region

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Whether to grant full permissions to CloudFormation while deploying this template.

Setting this to true affects the defaults for role and capabilities, if you

don’t specify any alternatives.

The default role that will be created for you will have full (i.e., *)

permissions on all resources, and the deployment will have named IAM

capabilities (i.e., able to create all IAM resources).

This is a shorthand that you can use if you fully trust the templates that

are deployed in this pipeline. If you want more fine-grained permissions,

use addToRolePolicy and capabilities to control what the CloudFormation

deployment is allowed to do.

Type:boolean
capabilities

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Acknowledge certain changes made as part of deployment

For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation

might create or update those resources. For example, you must specify AnonymousIAM or NamedIAM

if your stack template contains AWS Identity and Access Management (IAM) resources. For more

information see the link below.

Type:CloudFormationCapabilities (optional)
Default:None, unless adminPermissions is true
deploymentRole

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

IAM role to assume when deploying changes.

If not specified, a fresh role is created. The role is created with zero

permissions unless adminPermissions is true, in which case the role will have

full permissions.

Type:@aws-cdk/aws-iam.IRole (optional)
Default:A fresh role with full or no permissions (depending on the value of adminPermissions).
parameterOverrides

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Additional template parameters.

Template parameters specified here take precedence over template parameters

found in the artifact specified by the templateConfiguration property.

We recommend that you use the template configuration file to specify

most of your parameter values. Use parameter overrides to specify only

dynamic parameter values (values that are unknown until you run the

pipeline).

All parameter names must be present in the stack template.

Note: the entire object cannot be more than 1kB.

Type:string => any (optional)
Default:No overrides
templateConfiguration

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Input artifact to use for template parameters values and stack policy.

The template configuration file should contain a JSON object that should look like this:

{ “Parameters”: {…}, “Tags”: {…}, “StackPolicy”: {… }}. For more information,

see [AWS CloudFormation Artifacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-cfn-artifacts.html).

Note that if you include sensitive information, such as passwords, restrict access to this

file.

Type:@aws-cdk/aws-codepipeline-api.ArtifactPath (optional)
Default:No template configuration based on input artifacts
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

PipelineDeleteStackAction

class @aws-cdk/aws-cloudformation.PipelineDeleteStackAction(props)

Language-specific names:

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

CodePipeline action to delete a stack.

Deletes a stack. If you specify a stack that doesn’t exist, the action completes successfully

without deleting a stack.

Extends:PipelineCloudFormationDeployAction
Parameters:props (PipelineDeleteStackActionProps) –
bind(stage, scope)

Overrides @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction.bind()

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

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationAction

Output artifact containing the CloudFormation call response

Only present if configured by passing outputFileName.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
addToDeploymentRolePolicy(statement)

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction

Add statement to the service role assumed by CloudFormation while executing this action.

Parameters:statement (@aws-cdk/aws-iam.PolicyStatement) –
deploymentRole

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployAction

Type:@aws-cdk/aws-iam.IRole (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) –
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) –
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

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:@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)
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)

PipelineDeleteStackActionProps (interface)

class @aws-cdk/aws-cloudformation.PipelineDeleteStackActionProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.PipelineDeleteStackActionProps;
// PipelineDeleteStackActionProps is an interface
import { PipelineDeleteStackActionProps } from '@aws-cdk/aws-cloudformation';

Properties for the PipelineDeleteStackAction.

Extends:PipelineCloudFormationDeployActionProps
stackName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the stack to apply this action to

Type:string
outputArtifactName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the output artifact to generate

Only applied if outputFileName is set as well.

Type:string (optional)
Default:Automatically generated artifact name.
outputFileName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

A name for the filename in the output artifact to store the AWS CloudFormation call’s result.

The file will contain the result of the call to AWS CloudFormation (for example

the call to UpdateStack or CreateChangeSet).

AWS CodePipeline adds the file to the output artifact after performing

the specified action.

Type:string (optional)
Default:No output artifact generated
region

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Whether to grant full permissions to CloudFormation while deploying this template.

Setting this to true affects the defaults for role and capabilities, if you

don’t specify any alternatives.

The default role that will be created for you will have full (i.e., *)

permissions on all resources, and the deployment will have named IAM

capabilities (i.e., able to create all IAM resources).

This is a shorthand that you can use if you fully trust the templates that

are deployed in this pipeline. If you want more fine-grained permissions,

use addToRolePolicy and capabilities to control what the CloudFormation

deployment is allowed to do.

Type:boolean
capabilities

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Acknowledge certain changes made as part of deployment

For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation

might create or update those resources. For example, you must specify AnonymousIAM or NamedIAM

if your stack template contains AWS Identity and Access Management (IAM) resources. For more

information see the link below.

Type:CloudFormationCapabilities (optional)
Default:None, unless adminPermissions is true
deploymentRole

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

IAM role to assume when deploying changes.

If not specified, a fresh role is created. The role is created with zero

permissions unless adminPermissions is true, in which case the role will have

full permissions.

Type:@aws-cdk/aws-iam.IRole (optional)
Default:A fresh role with full or no permissions (depending on the value of adminPermissions).
parameterOverrides

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Additional template parameters.

Template parameters specified here take precedence over template parameters

found in the artifact specified by the templateConfiguration property.

We recommend that you use the template configuration file to specify

most of your parameter values. Use parameter overrides to specify only

dynamic parameter values (values that are unknown until you run the

pipeline).

All parameter names must be present in the stack template.

Note: the entire object cannot be more than 1kB.

Type:string => any (optional)
Default:No overrides
templateConfiguration

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationDeployActionProps

Input artifact to use for template parameters values and stack policy.

The template configuration file should contain a JSON object that should look like this:

{ “Parameters”: {…}, “Tags”: {…}, “StackPolicy”: {… }}. For more information,

see [AWS CloudFormation Artifacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-cfn-artifacts.html).

Note that if you include sensitive information, such as passwords, restrict access to this

file.

Type:@aws-cdk/aws-codepipeline-api.ArtifactPath (optional)
Default:No template configuration based on input artifacts
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

PipelineExecuteChangeSetAction

class @aws-cdk/aws-cloudformation.PipelineExecuteChangeSetAction(props)

Language-specific names:

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

CodePipeline action to execute a prepared change set.

Extends:PipelineCloudFormationAction
Parameters:props (PipelineExecuteChangeSetActionProps) –
bind(stage, _scope)

Implements @aws-cdk/aws-codepipeline-api.Action.bind()

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

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationAction

Output artifact containing the CloudFormation call response

Only present if configured by passing outputFileName.

Type:@aws-cdk/aws-codepipeline-api.Artifact (optional)
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) –
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) –
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

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:@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)
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)

PipelineExecuteChangeSetActionProps (interface)

class @aws-cdk/aws-cloudformation.PipelineExecuteChangeSetActionProps

Language-specific names:

using Amazon.CDK.AWS.CloudFormation;
import software.amazon.awscdk.services.cloudformation.PipelineExecuteChangeSetActionProps;
// PipelineExecuteChangeSetActionProps is an interface
import { PipelineExecuteChangeSetActionProps } from '@aws-cdk/aws-cloudformation';

Properties for the PipelineExecuteChangeSetAction.

Extends:PipelineCloudFormationActionProps
changeSetName

Name of the change set to execute.

Type:string
stackName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the stack to apply this action to

Type:string
outputArtifactName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

The name of the output artifact to generate

Only applied if outputFileName is set as well.

Type:string (optional)
Default:Automatically generated artifact name.
outputFileName

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

A name for the filename in the output artifact to store the AWS CloudFormation call’s result.

The file will contain the result of the call to AWS CloudFormation (for example

the call to UpdateStack or CreateChangeSet).

AWS CodePipeline adds the file to the output artifact after performing

the specified action.

Type:string (optional)
Default:No output artifact generated
region

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-cloudformation.PipelineCloudFormationActionProps

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