Source: aws-component.js

  1. const assert = require('assert')
  2. const _ = require('lodash');
  4. const AWSObject = require('./aws-object').AWSObject
  5. const Policy = require('./policy').Policy;
  7. /**
  8.  * A super class to represent an AWS component. 
  9.  * Some functions are to be implemented by sub classes.
  10.  * @abstract
  11.  */
  12. class AWSComponent extends AWSObject {
  14.   /**
  15.    * Don't call this manually. Use creator function in {@link CloudFormation}
  16.    * @param {string} stackName 
  17.    * @param {string} baseName 
  18.    */
  19.   constructor(stackName, baseName) {
  20.     super(stackName, baseName)
  21.     this.policyStatements = []
  22.     this.assumeRolePolicyDocument = null
  24.     this._crossStackValues = {}
  25.   }
  27.   get crossStackValues() {
  28.     return _.clone(this._crossStackValues)
  29.   }
  31.   setCrossStackValue(name, value) {
  32.     this._crossStackValues[name] = value
  33.   }
  35.   get sameStackValues() {
  36.     return {
  37.       'ID': { "Ref": this.fullName },
  38.       'ARN': {
  39.         "Fn::GetAtt": [
  40.           this.fullName,
  41.           "Arn"
  42.         ]
  43.       }
  44.     }
  45.   }
  47.   /**
  48.    * Get stack value of this component, variables can be: 
  49.    * ARN, ID, PROVIDERNAME, etc
  50.    * If this component is deployed and checked, the actual value will be provided.
  51.    * Otherwise, AWS CloudFormation intrinsic specs will be returned, such as {"Ref": <logicName>}
  52.    * 
  53.    * @param {String} key ARN | ID | PROVIDERNAME
  54.    */
  55.   getValue(key) {
  56.     return this.crossStackValues[key] || this.sameStackValues[key]
  57.   }
  59.   get outputVariableKeys() {
  60.     return _.keys(this.outputSpecs)
  61.   }
  63.   get outputSpecs() {
  64.     //Default: get ARN and ID
  65.     let specs = {}
  66.     const id_spec = `${this.stackName}${this.fullName}ID`;
  67.     specs[id_spec] = {
  68.       "Description": `The ID for resource ${this.fullName} of stack ${this.stackName}`,
  69.       "Value": { "Ref": this.fullName },
  70.       "Export": {
  71.         "Name": id_spec
  72.       }
  73.     }
  75.     const arn_spec = `${this.stackName}${this.fullName}ARN`;
  76.     specs[arn_spec] = {
  77.       "Description": `The ARN for resource ${this.fullName} of stack ${this.stackName}`,
  78.       "Value": {
  79.         "Fn::GetAtt": [
  80.           this.fullName,
  81.           "Arn"
  82.         ]
  83.       },
  84.       "Export": {
  85.         "Name": arn_spec
  86.       }
  87.     }
  89.     return specs
  90.   }
  92.   roleName() {
  93.     const theRole = this.defaultRole;
  94.     return theRole ? theRole.fullName : null;
  95.   }
  97.   getDefaultRole() {
  98.     console.warn('Deprecated. Use .defaultRole() instead');
  99.     return this.defaultRole;
  100.   }
  102.   get defaultRole() {
  103.     if (!_.isEmpty(this.policyStatements) && this.assumeRolePolicyDocument) {
  104.       const Role = require('./role').Role;
  105.       let role = new Role(this.stackName, this.fullName)
  106.       role.policyStatements = this.policyStatements
  107.       if (this.assumeRolePolicyDocument) {
  108.         role.assumeRolePolicyDocument = this.assumeRolePolicyDocument
  109.       }
  110.       return role
  111.     }
  112.     else {
  113.       return null;
  114.     }
  115.   }
  117.   /**
  118.    * Get the policy statement object for the given access levels
  119.    * @returns {object} policy statement JSON
  120.    * @param {array} accessLevels array with string element which possible values are: ACCESS_LEVEL_READ | ACCESS_LEVEL_WRITE | ACCESS_LEVEL_ADMIN
  121.    * @param {string} item optional
  122.    */
  123.   policyStatementForAccess(accessLevels, item) {
  124.     accessLevels.forEach((accessLevel) => {
  125.       assert.ok([AWSComponent.ACCESS_LEVEL_READ,
  126.         AWSComponent.ACCESS_LEVEL_WRITE,
  127.         AWSComponent.ACCESS_LEVEL_ADMIN
  128.       ].indexOf(accessLevel) >= 0, `Invalid access level: ${accessLevel}`)
  129.     })
  131.     return this.policyStatementForAccessImpl(accessLevels, item)
  132.   }
  134.   /**
  135.    * Get the policy statement object for the given access levels. Should be implemented by sub classes.
  136.    * @abstract
  137.    * @param {array} accessLevels array with string element which possible values are: ACCESS_LEVEL_READ | ACCESS_LEVEL_WRITE | ACCESS_LEVEL_ADMIN
  138.    * @param {string} item optional
  139.    */
  140.   policyStatementForAccessImpl(accessLevels, item) {
  141.     throw new Error('This function must be overriden in sub classes')
  142.   }
  143. }
  145. //Static fields
  146. AWSComponent.ACCESS_LEVEL_READ = 'ACCESS_LEVEL_READ'
  147. AWSComponent.ACCESS_LEVEL_WRITE = 'ACCESS_LEVEL_WRITE'
  148. AWSComponent.ACCESS_LEVEL_ADMIN = 'ACCESS_LEVEL_ADMIN'
  150. exports.AWSComponent = AWSComponent