add additional methods

Author: austencollins

README.md

@@ -12,14 +12,14 @@ const s3 = new aws.S3({
   region: 'us-east-1'
 })
 
-// initialize the Extra service for extra methods
-const extra = new aws.Extra({
+// initialize the Extras service for extra methods
+const extras = new aws.Extras({
   credentials: { accessKeyId: 'xxx', secretAccessKey: 'xxx' },
   region: 'us-east-1'
 })
 
 // call some powerful extra methods. More info below.
-const certificate = await extra.deployCertificate(params)
+const certificate = await extras.deployCertificate(params)
 ```
 
 # Reference
@@ -54,7 +54,7 @@ const {
   certificateArn,
   certificateStatus,
   domainHostedZoneId
-} = await extra.deployDistributionDomain(params)
+} = await extras.deployDistributionDomain(params)
 ```
 
 # deployCertificate
@@ -66,7 +66,7 @@ const params = {
   domain: 'serverless.com'
 }
 
-const { certificateArn, certificateStatus, domainHostedZoneId } = await extra.deployCertificate(
+const { certificateArn, certificateStatus, domainHostedZoneId } = await extras.deployCertificate(
   params
 )
 ```
@@ -81,7 +81,7 @@ const params = {
   distributionUrl: 'xxx.cloudfront.net'
 }
 
-const { domainHostedZoneId } = await extra.deployDistributionDns(params)
+const { domainHostedZoneId } = await extras.deployDistributionDns(params)
 ```
 
 # addDomainToDistribution
@@ -95,7 +95,7 @@ const params = {
   certificateStatus: 'ISSUED'
 }
 
-const { domainHostedZoneId } = await extra.addDomainToDistribution(params)
+const { domainHostedZoneId } = await extras.addDomainToDistribution(params)
 ```
 
 # getDomainHostedZoneId
@@ -107,7 +107,7 @@ const params = {
   domain: 'serverless.com'
 }
 
-const { domainHostedZoneId } = await extra.getDomainHostedZoneId(params)
+const { domainHostedZoneId } = await extras.getDomainHostedZoneId(params)
 ```
 
 # deployRole
@@ -131,7 +131,7 @@ const params = {
     }
   ]
 }
-const { roleArn } = await extra.deployRole(params)
+const { roleArn } = await extras.deployRole(params)
 ```
 
 Or you can specify the policy as a maanged policy arn string:
@@ -142,7 +142,7 @@ const params = {
   service: 'lambda.amazonaws.com',
   policy: 'arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole'
 }
-const { roleArn } = await extra.deployRole(params)
+const { roleArn } = await extras.deployRole(params)
 ```
 
 If you don't specify a policy property, an admin policy will be created by default.
@@ -156,7 +156,7 @@ const params = {
   name: 'my-role'
 }
 
-await extra.removeRole(params)
+await extras.removeRole(params)
 ```
 
 # removeRolePolicies
@@ -168,7 +168,7 @@ const params = {
   name: 'my-role'
 }
 
-await extra.removeRolePolicies(params)
+await extras.removeRolePolicies(params)
 ```
 
 # deployLambda
@@ -189,7 +189,7 @@ const params = {
       - subnet-xxx
 }
 
-const { lambdaArn, lambdaSize, lambdaSha } = await extra.deployLambda(params)
+const { lambdaArn, lambdaSize, lambdaSha } = await extras.deployLambda(params)
 ```
 
 # deployApigDomainDns
@@ -203,7 +203,7 @@ const params = {
   apigatewayDomainName: 'd-qwertyuiop.xxx.com' // required. The regional endpoint of the APIG custom domain
 }
 
-const { domainHostedZoneId } = await extra.deployApigDomainDns(params)
+const { domainHostedZoneId } = await extras.deployApigDomainDns(params)
 ```
 
 # deployAppSyncApi
@@ -216,7 +216,7 @@ const params = {
   apiId: 'xxx' // if provided, updates the API. If not provided, creates a new API
 }
 
-const { apiId, apiUrls } = await extra.deployAppSyncApi(params)
+const { apiId, apiUrls } = await extras.deployAppSyncApi(params)
 ```
 
 # deployAppSyncSchema
@@ -229,7 +229,7 @@ const params = {
   schema: '...' // valid graphql schema
 }
 
-await extra.deployAppSyncApi(params)
+await extras.deployAppSyncApi(params)
 ```
 
 # deployAppSyncResolvers
@@ -254,7 +254,7 @@ const params = {
   }
 }
 
-await extra.deployAppSyncResolvers(params)
+await extras.deployAppSyncResolvers(params)
 ```
 
 # deployStack
@@ -297,7 +297,7 @@ const inputs = {
   role: 'arn:iam:xxx'
 }
 
-const outputs = await extra.deployStack(params)
+const outputs = await extras.deployStack(params)
 ```
 
 # removeStack
@@ -309,5 +309,5 @@ const prams = {
   stackName: 'my-stack' // name of the stack you want to remove
 }
 
-await extra.removeStack(params)
+await extras.removeStack(params)
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serverless/aws-sdk-extra",
-  "version": "1.0.0",
+  "version": "1.1.0-beta.1",
   "description": "The AWS SDK that includes with a handful of extra convenience methods.",
   "main": "src/index.js",
   "author": "Serverless, Inc.",
@@ -27,4 +27,4 @@
     "eslint-plugin-prettier": "^3.1.0",
     "prettier": "^1.18.2"
   }
-}
+}

src/index.js

@@ -32,6 +32,10 @@ const removeDistribution = require('./removeDistribution')
 const getMetrics = require('./getMetrics')
 const deployStack = require('./deployStack')
 const removeStack = require('./removeStack')
+const listAllAwsRegions = require('./listAllAwsRegions')
+const listAllCloudFormationStacksInARegion = require('./listAllCloudFormationStacksInARegion')
+const listAllCloudFormationStacksInAllRegions = require('./listAllCloudFormationStacksInAllRegions')
+const listAllCloudFormationStackResources = require('./listAllCloudFormationStackResources')
 
 /**
  * Define AWS Extras class
@@ -309,6 +313,34 @@ class Extras {
   removeStack(params) {
     return removeStack(this.config, params)
   }
+
+  /**
+   * List all AWS Regions currently available, formatted for SDK input, in an array
+   */
+  listAllAwsRegions() {
+    return listAllAwsRegions()
+  }
+
+  /**
+   * Performs one or multiple API requests until all AWS CloudFormation Stacks are collected within a specified region and returned in an array.
+   */
+  listAllCloudFormationStacksInARegion(params) {
+    return listAllCloudFormationStacksInARegion(this.config, params)
+  }
+
+  /**
+   * Performs one or multiple API requests until all AWS CloudFormation Stacks in all regions are collected and returned in an array.
+   */
+  listAllCloudFormationStacksInAllRegions(params) {
+    return listAllCloudFormationStacksInAllRegions(this.config, params)
+  }
+
+  /**
+   * Performs one or multiple API requests until summaries for all resources in an AWS CloudFormation Stack are collected and returned as an array.
+   */
+  listAllCloudFormationStackResources(params) {
+    return listAllCloudFormationStackResources(this.config, params)
+  }
 }
 
 /**

src/listAllAwsRegions.js

@@ -0,0 +1,28 @@
+module.exports = () => {
+  return [
+    'us-east-1',
+    'us-east-2',
+    'us-west-1',
+    'us-west-2',
+    'af-south-1',
+    'ap-east-1',
+    'ap-south-1',
+    'ap-northeast-1',
+    'ap-northeast-2',
+    'ap-southeast-1',
+    'ap-southeast-2',
+    'ca-central-1',
+    'cn-north-1',
+    'cn-northwest-1',
+    'eu-central-1',
+    'eu-west-1',
+    'eu-west-2',
+    'eu-west-3',
+    'eu-south-1',
+    'eu-north-1',
+    'me-south-1',
+    'sa-east-1',
+    'us-gov-east-1',
+    'us-gov-west-1',
+  ]
+}

src/listAllCloudFormationStackResources.js

@@ -0,0 +1,51 @@
+const AWS = require('aws-sdk')
+
+const listAllCloudFormationStackResources = async (
+  config,
+  {
+    region = null,
+    stackName = null,
+    nextToken = null,
+  },
+  resources = []) => {
+
+  if (!stackName) {
+    throw new Error(`Missing "stackName" param.`)
+  }
+  if (!config.region && !region) {
+    throw new Error(`Either config.region must be set or the 'region' parameter must be submitted`)
+  }
+
+  config.region = config.region || region
+
+  // Fetch stacks
+  const cloudformation = new AWS.CloudFormation(config)
+
+  const params = {
+    StackName: stackName,
+    NextToken: nextToken,
+  }
+
+  const res = await cloudformation.listStackResources(params).promise();
+
+  // Concatenate stacks
+  if (res.StackResourceSummaries && res.StackResourceSummaries.length) {
+    resources = resources.concat(resources, res.StackResourceSummaries);
+  }
+
+  // If NextToken, call again...
+  if (res.NextToken) {
+    return await listAllCloudFormationStackResources(
+      config,
+      {
+        stackName,
+        nextToken: res.NextToken,
+      },
+      resources
+    );
+  }
+
+  return resources
+}
+
+module.exports = listAllCloudFormationStackResources

src/listAllCloudFormationStacksInARegion.js

@@ -0,0 +1,65 @@
+const AWS = require('aws-sdk')
+
+const listAllCloudFormationStacksInARegion = async (
+  config,
+  {
+    region = null,
+    nextToken = null,
+    stackStatusFilter = null
+  },
+  stacks = []) => {
+
+  if (!region) {
+    throw new Error(`Missing "region" param.`)
+  }
+
+  // Override region configuration
+  config.region = region
+
+  // Default to Stacks with an Active state, defined by these status values
+  stackStatusFilter = stackStatusFilter || [
+    'CREATE_COMPLETE',
+    'UPDATE_COMPLETE',
+    'ROLLBACK_COMPLETE',
+    'IMPORT_COMPLETE',
+    'IMPORT_ROLLBACK_COMPLETE',
+  ]
+
+  // Fetch stacks
+  const cloudformation = new AWS.CloudFormation(config)
+
+  const params = {
+    NextToken: nextToken,
+    StackStatusFilter: stackStatusFilter,
+  }
+
+  const res = await cloudformation.listStacks(params).promise();
+
+  // Concatenate stacks
+  if (res.StackSummaries && res.StackSummaries.length) {
+
+    // Add region to each
+    res.StackSummaries.forEach((summary) => {
+      summary.Region = region
+    })
+
+    stacks = stacks.concat(stacks, res.StackSummaries);
+  }
+
+  // If NextToken, call again...
+  if (res.NextToken) {
+    return await listAllCloudFormationStacksInARegion(
+      config,
+      {
+        region,
+        nextToken: res.NextToken,
+        stackStatusFilter,
+      },
+      stacks
+    );
+  }
+
+  return stacks
+}
+
+module.exports = listAllCloudFormationStacksInARegion