awssum-amazon-cloudformation - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

awssum-amazon-cloudformation.js

@@ -63,3 +63,3 @@ // --------------------------------------------------------------------------------------------------------------------
 // inherit from Amazon
-util.inherits(CloudFormation, amazon.AmazonSignatureV2);
+util.inherits(CloudFormation, amazon.AmazonSignatureV4);
 
@@ -69,2 +69,6 @@ // --------------------------------------------------------------------------------------------------------------------
 
+CloudFormation.prototype.method = function() {
+    return 'POST';
+};
+
 CloudFormation.prototype.host = function() {
@@ -78,2 +82,23 @@ return endPoint[this.region()];
 
+// ----------------------------------------------------------------------------
+// AWS Signature v4
+
+CloudFormation.prototype.scope = function() {
+    return 'cloudformation';
+};
+
+CloudFormation.prototype.serviceName = function() {
+    return 'cloudformation';
+};
+
+CloudFormation.prototype.needsTarget = function() {
+    return false;
+};
+
+// This service uses the AWS Signature v4.
+// Hopefully, it fulfills : http://docs.amazonwebservices.com/cloudsearch/latest/developerguide/requestauth.html
+CloudFormation.prototype.contentType = function() {
+    return 'application/x-amz-json-1.0';
+};
+
 // --------------------------------------------------------------------------------------------------------------------
@@ -89,4 +114,14 @@ // operations on the service
 
+exports.US_EAST_1      = amazon.US_EAST_1;
+exports.US_WEST_1      = amazon.US_WEST_1;
+exports.US_WEST_2      = amazon.US_WEST_2;
+exports.EU_WEST_1      = amazon.EU_WEST_1;
+exports.AP_SOUTHEAST_1 = amazon.AP_SOUTHEAST_1;
+exports.AP_SOUTHEAST_2 = amazon.AP_SOUTHEAST_2;
+exports.AP_NORTHEAST_1 = amazon.AP_NORTHEAST_1;
+exports.SA_EAST_1      = amazon.SA_EAST_1;
+exports.US_GOV_WEST    = amazon.US_GOV_WEST;
+
 exports.CloudFormation = CloudFormation;
 
 // --------------------------------------------------------------------------------------------------------------------

package.json

 {
     "name" : "awssum-amazon-cloudformation",
-    "description" : "NodeJS module to talk to Amazon CloudFormation.",
-    "version" : "1.0.0",
+    "description" : "AwsSum plugin for Amazon CloudFormation.",
+    "version" : "1.1.0",
 
@@ -25,3 +25,3 @@ "main" : "awssum-amazon-cloudformation.js",
 
-    "homepage" : "https://awssum.io/",
+    "homepage" : "https://github.com/awssum/awssum-amazon-cloudformation/",
     "repository" : {
@@ -28,0 +28,0 @@ "type" : "git",

README.md

@@ -5,2 +5,86 @@ # awssum-amazon-cloudformation #
 
+You'll need to add [awssum-amazon-cloudformation](https://github.com/awssum/awssum-amazon-cloudformation/) to your package.json
+dependencies. Both [awssum](https://github.com/awssum/awssum/) and
+[awssum-amazon](https://github.com/awssum/awssum-amazon/) are pulled in as peer dependencies.
+
+## Example ##
+
+Describe all your alarms:
+
+```
+var fmt = require('fmt');
+var amazonCloudFormation = require('awssum-amazon-cloudformation');
+
+var cf = new amazonCloudFormation.CloudFormation({
+    'accessKeyId'     : process.env.ACCESS_KEY_ID,
+    'secretAccessKey' : process.env.SECRET_ACCESS_KEY,
+    'region'          : amazonCloudFormation.US_EAST_1
+});
+
+cf.DescribeStacks(function(err, data) {
+    fmt.dump(err, 'err');
+    fmt.dump(data, 'data');
+});
+```
+
+## Operations ##
+
+### CreateStack ###
+
+Docs: [CreateStack on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html)
+
+### DeleteStack ###
+
+Docs: [DeleteStack on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DeleteStack.html)
+
+### DescribeStackEvents ###
+
+Docs: [DescribeStackEvents on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeStackEvents.html)
+
+### DescribeStackResource ###
+
+Docs: [DescribeStackResource on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeStackResource.html)
+
+### DescribeStackResources ###
+
+Docs: [DescribeStackResources on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeStackResources.html)
+
+### DescribeStacks ###
+
+Docs: [DescribeStacks on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeStacks.html)
+
+### EstimateTemplateCost ###
+
+Docs: [EstimateTemplateCost on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_EstimateTemplateCost.html)
+
+### GetTemplate ###
+
+Docs: [GetTemplate on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_GetTemplate.html)
+
+### ListStackResources ###
+
+Docs: [ListStackResources on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_ListStackResources.html)
+
+### ListStacks ###
+
+Docs: [ListStacks on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_ListStacks.html)
+
+### UpdateStack ###
+
+Docs: [UpdateStack on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_UpdateStack.html)
+
+### ValidateTemplate ###
+
+Docs: [ValidateTemplate on AWS](http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_ValidateTemplate.html)
+
+# Author #
+
+Written by [Andrew Chilton](http://chilts.org/) - [Blog](http://chilts.org/blog/) -
+[Twitter](https://twitter.com/andychilton).
+
+# License #
+
+* [Copyright 2011-2013 Apps Attic Ltd.  All rights reserved.](http://appsattic.mit-license.org/2011/)
+* [Copyright 2013 Andrew Chilton.  All rights reserved.](http://chilts.mit-license.org/2013/)
+
 (Ends)

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

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

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

Improved metrics

Total package byte prevSize

20887

increased by73.26%

Number of package files

9

increased by50%

Lines of code

391

increased by72.25%

Number of lines in readme file

90

increased by1400%

Worsened metrics

Number of low supply chain risk alerts

4

increased byInfinity%

No dependency changes