Proposal for final CodePipeline Actions API shape

packages/@aws-cdk/aws-cloudformation/README.md

@@ -1,6 +1,32 @@
 ## CDK Constructs for AWS CloudFormation
+
 This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) 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:
+
+[example Pipeline to deploy CloudFormation](../aws-codepipeline/test/integ.cfn-template-from-repo.lit.ts)
+
+See [the AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline.html)
+for more details about using CloudFormation in CodePipeline.
+
+#### Actions defined by this package
+
+This package defines the following actions:
+
+* **CreateUpdateStack** - 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).
+* **DeleteStackOnly** - Delete the stack with the given name.
+* **CreateReplaceChangeSet** - 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.
+* **ExecuteChangeSet** - Execute a change set prepared previously.
+
 ### Custom Resources
 
 Custom Resources are CloudFormation resources that are implemented by

packages/@aws-cdk/aws-cloudformation/lib/index.ts

@@ -1,3 +1,5 @@
+export * from './custom-resource';
+export * from './pipeline-actions';
+
 // AWS::CloudFormation CloudFormation Resources:
 export * from './cloudformation.generated';
-export * from './custom-resource';

packages/@aws-cdk/aws-cloudformation-codepipeline/lib/pipeline-actions.ts → packages/@aws-cdk/aws-cloudformation/lib/pipeline-actions.ts

@@ -1,11 +1,11 @@
-import codepipeline  = require('@aws-cdk/aws-codepipeline');
+import codepipeline  = require('@aws-cdk/aws-codepipeline-api');
 import iam = require('@aws-cdk/aws-iam');
 import cdk = require('@aws-cdk/cdk');
 
 /**
  * Properties common to all CloudFormation actions
  */
-export interface CloudFormationCommonProps {
+export interface CloudFormationCommonProps extends codepipeline.CommonActionProps {
     /**
      * The name of the stack to apply this action to
      */
@@ -45,15 +45,26 @@ export abstract class CloudFormationAction extends codepipeline.DeployAction {
      */
     public artifact?: codepipeline.Artifact;
 
-    constructor(parent: codepipeline.Stage, id: string, props: CloudFormationCommonProps, configuration?: any) {
-        super(parent, id, 'CloudFormation',  { minInputs: 0, maxInputs: 10, minOutputs: 0, maxOutputs: 1 }, {
-            ...configuration,
-            StackName: props.stackName,
-            OutputFileName: props.outputFileName,
+    constructor(parent: cdk.Construct, id: string, props: CloudFormationCommonProps, configuration?: any) {
+        super(parent, id, {
+            stage: props.stage,
+            artifactBounds: {
+                minInputs: 0,
+                maxInputs: 10,
+                minOutputs: 0,
+                maxOutputs: 1,
+            },
+            provider: 'CloudFormation',
+            configuration: {
+                StackName: props.stackName,
+                OutputFileName: props.outputFileName,
+                ...configuration,
+            }
         });
 
         if (props.outputFileName) {
-            this.artifact = this.addOutputArtifact(props.outputArtifactName || (parent.id + this.id + 'Artifact'));
+            this.artifact = this.addOutputArtifact(props.outputArtifactName ||
+                (props.stage.name + this.id + 'Artifact'));
         }
     }
 }
@@ -72,7 +83,7 @@ export interface ExecuteChangeSetProps extends CloudFormationCommonProps {
  * CodePipeline action to execute a prepared change set.
  */
 export class ExecuteChangeSet extends CloudFormationAction {
-    constructor(parent: codepipeline.Stage, id: string, props: ExecuteChangeSetProps) {
+    constructor(parent: cdk.Construct, id: string, props: ExecuteChangeSetProps) {
         super(parent, id, props, {
             ActionMode: 'CHANGE_SET_EXECUTE',
             ChangeSetName: props.changeSetName,
@@ -168,7 +179,7 @@ export interface CloudFormationDeploymentActionCommonProps extends CloudFormatio
 export abstract class CloudFormationDeploymentAction extends CloudFormationAction {
     public readonly role: iam.Role;
 
-    constructor(parent: codepipeline.Stage, id: string, props: CloudFormationDeploymentActionCommonProps, configuration: any) {
+    constructor(parent: cdk.Construct, id: string, props: CloudFormationDeploymentActionCommonProps, configuration: any) {
         const capabilities = props.fullPermissions && props.capabilities === undefined ? [CloudFormationCapabilities.NamedIAM] : props.capabilities;
 
         super(parent, id, props, {
@@ -224,7 +235,7 @@ export interface CreateReplaceChangeSetProps extends CloudFormationDeploymentAct
  * If the change set exists, AWS CloudFormation deletes it, and then creates a new one.
  */
 export class CreateReplaceChangeSet extends CloudFormationDeploymentAction {
-    constructor(parent: codepipeline.Stage, id: string, props: CreateReplaceChangeSetProps) {
+    constructor(parent: cdk.Construct, id: string, props: CreateReplaceChangeSetProps) {
         super(parent, id, props, {
             ActionMode: 'CHANGE_SET_REPLACE',
             ChangeSetName: props.changeSetName,
@@ -275,7 +286,7 @@ export interface CreateUpdateProps extends CloudFormationDeploymentActionCommonP
  * troubleshooting them. You would typically choose this mode for testing.
  */
 export class CreateUpdateStack extends CloudFormationDeploymentAction {
-    constructor(parent: codepipeline.Stage, id: string, props: CreateUpdateProps) {
+    constructor(parent: cdk.Construct, id: string, props: CreateUpdateProps) {
         super(parent, id, props, {
             ActionMode: props.replaceOnFailure ? 'REPLACE_ON_FAILURE' : 'CREATE_UPDATE',
             TemplatePath: props.templatePath.location
@@ -298,7 +309,7 @@ export interface DeleteStackOnlyProps extends CloudFormationDeploymentActionComm
  * without deleting a stack.
  */
 export class DeleteStackOnly extends CloudFormationDeploymentAction {
-    constructor(parent: codepipeline.Stage, id: string, props: DeleteStackOnlyProps) {
+    constructor(parent: cdk.Construct, id: string, props: DeleteStackOnlyProps) {
         super(parent, id, props, {
             ActionMode: 'DELETE_ONLY',
         });

packages/@aws-cdk/aws-cloudformation/package.json

@@ -33,6 +33,10 @@
   "cdk-build": {
     "cloudformation": "AWS::CloudFormation"
   },
+  "nyc": {
+    "lines": 50,
+    "branches": 20
+  },
   "keywords": [
     "aws",
     "cdk",
@@ -54,6 +58,8 @@
   },
   "dependencies": {
     "@aws-cdk/cdk": "^0.8.1",
+    "@aws-cdk/aws-codepipeline-api": "^0.8.1",
+    "@aws-cdk/aws-iam": "^0.8.1",
     "@aws-cdk/aws-lambda": "^0.8.1",
     "@aws-cdk/aws-sns": "^0.8.1"
   },