@aws-cdk/aws-cloudformation - npm Package Compare versions

Comparing version 0.8.1 to 0.8.2

lib/cloudformation.generated.js

@@ -5,3 +5,3 @@ "use strict";
 // See: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-resource-specification.html
-// @cfn2ts:meta@ {"generated":"2018-08-09T08:23:45.726Z","fingerprint":"HZVLFlXVwWEjQUEudvjGpi7TPs4HJBwOxbYu7F0teTo="}
+// @cfn2ts:meta@ {"generated":"2018-08-15T13:38:11.548Z","fingerprint":"HZVLFlXVwWEjQUEudvjGpi7TPs4HJBwOxbYu7F0teTo="}
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -8,0 +8,0 @@ // tslint:disable:max-line-length | This is generated code - line lengths are difficult to control

lib/index.d.ts

@@ -0,1 +1,3 @@
+export * from './custom-resource';
+export * from './pipeline-actions';
 export * from './cloudformation.generated';

lib/index.js

@@ -6,4 +6,6 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./custom-resource"));
+__export(require("./pipeline-actions"));
 // AWS::CloudFormation CloudFormation Resources:
 __export(require("./cloudformation.generated"));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLGdEQUFnRDtBQUNoRCxnREFBMkMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLHVDQUFrQztBQUNsQyx3Q0FBbUM7QUFFbkMsZ0RBQWdEO0FBQ2hELGdEQUEyQyJ9

package.json

 {
   "name": "@aws-cdk/aws-cloudformation",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "CDK Constructs for AWS CloudFormation",
@@ -36,2 +36,6 @@ "main": "lib/index.js",
   },
+  "nyc": {
+    "lines": 50,
+    "branches": 20
+  },
   "keywords": [
@@ -50,11 +54,16 @@ "aws",
   "devDependencies": {
-    "@aws-cdk/assert": "^0.8.1",
-    "cdk-build-tools": "^0.8.1",
-    "cfn2ts": "^0.8.1",
-    "pkglint": "^0.8.1"
+    "@aws-cdk/assert": "^0.8.2",
+    "cdk-build-tools": "^0.8.2",
+    "cdk-integ-tools": "^0.8.2",
+    "cfn2ts": "^0.8.2",
+    "pkglint": "^0.8.2"
   },
   "dependencies": {
-    "@aws-cdk/cdk": "^0.8.1"
+    "@aws-cdk/aws-codepipeline-api": "^0.8.2",
+    "@aws-cdk/aws-iam": "^0.8.2",
+    "@aws-cdk/aws-lambda": "^0.8.2",
+    "@aws-cdk/aws-sns": "^0.8.2",
+    "@aws-cdk/cdk": "^0.8.2"
   },
   "homepage": "https://github.com/awslabs/aws-cdk"
 }

README.md

 ## CDK Constructs for AWS CloudFormation
-This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project.
+
+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
+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).
+
+```ts
+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:
+
+* [Introduction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html)
+* [Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref.html)
+* [Code Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

247561

increased by310.49%

Number of package files

25

increased by92.31%

Lines of code

1192

increased by159.13%

Number of lines in readme file

95

increased by4650%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

5

increased by400%

Dev dependency count

5

increased by25%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@aws-cdk/aws-codepipeline-api@^0.8.2

• + Added@aws-cdk/aws-iam@^0.8.2

• + Added@aws-cdk/aws-lambda@^0.8.2

• + Added@aws-cdk/aws-sns@^0.8.2

• + Added@aws-cdk/assets@0.8.2(transitive)

• + Added@aws-cdk/aws-cloudwatch@0.8.2(transitive)

• + Added@aws-cdk/aws-codepipeline-api@0.8.2(transitive)

• + Added@aws-cdk/aws-events@0.8.2(transitive)

• + Added@aws-cdk/aws-iam@0.8.2(transitive)

• + Added@aws-cdk/aws-kms@0.8.2(transitive)

• + Added@aws-cdk/aws-lambda@0.8.2(transitive)

• + Added@aws-cdk/aws-logs@0.8.2(transitive)

• + Added@aws-cdk/aws-s3@0.8.2(transitive)

• + Added@aws-cdk/aws-s3-notifications@0.8.2(transitive)

• + Added@aws-cdk/aws-sns@0.8.2(transitive)

• + Added@aws-cdk/aws-sqs@0.8.2(transitive)

• + Added@aws-cdk/util@0.8.2(transitive)

• Updated@aws-cdk/cdk@^0.8.2