@guardian/cdk 50.0.0-beta.1 → 50.0.0

package/lib/experimental/riff-raff-yaml-file/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/experimental/riff-raff-yaml-file/index.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAmC;AACnC,gDAAwB;AAExB,6CAAoC;AACpC,qCAA+B;AAC/B,8DAAkE;AAClE,gDAAgD;AAChD,oDAA2D;AAC3D,2DAA6F;AAC7F,iEAAoH;AACpH,iDAAoF;AACpF,yCAA8D;AAY9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAa,4BAA4B;IAS/B,iBAAiB,CAAC,aAAuB,EAAE,aAAuB;QACxE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAClD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC;YAClC,OAAO,KAAK,KAAK,aAAa,IAAI,KAAK,KAAK,aAAa,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,CAAC,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACK,mBAAmB;QAKzB,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAE5C,MAAM,MAAM,GAAkB,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE;YAC1E,OAAO;gBACL,GAAG,WAAW;gBACd,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE;oBACxD,OAAO;wBACL,GAAG,WAAW;wBACd,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;qBACnE,CAAC;gBACJ,CAAC,EAAE,EAAE,CAAC;aACP,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,kBAAkB,GAA4B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACtG,OAAO,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,OAAO,GAAG,4DAA4D,kBAAkB,CAAC,MAAM,cAAc,CAAC;YAEpH,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,kBAAkB,CAAC,CAAC;YAC1C,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;IACH,CAAC;IAEO,6BAA6B;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QAElF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAC;SACjH;IACH,CAAC;IAEO,UAAU,CAAC,QAAiB;QAClC,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,yBAAgB,CAAuB,CAAC;IACpG,CAAC;IAEO,oBAAoB,CAAC,QAAiB;QAC5C,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,gCAAkB,CAAyB,CAAC;IACxG,CAAC;IAED,8GAA8G;IAC9G,YAAY,GAAQ;QAClB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,cAAO,CAAc,CAAC;QACxF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAErF,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAErC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAEzB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAmD,CAAC;QAE/E,MAAM,aAAa,GAAqB,IAAA,2CAAgC,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE5F,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YACrD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;gBACnD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;oBAChD,MAAM,MAAM,GAAc,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;oBAE3D,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;wBACvB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;qBAC1F;oBAED,6FAA6F;oBAC7F,2GAA2G;oBAC3G,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;oBAEzB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBACvC,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;oBAE3D,MAAM,eAAe,GAAyB;wBAC5C,OAAO,CAAC,GAAG,CAAC,6BAAoB,CAAC;wBACjC,iBAAiB,CAAC,GAAG,CAAC,uCAAyB,CAAC;qBACjD,CAAC,IAAI,EAAE,CAAC;oBACT,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;oBAE3E,MAAM,aAAa,GAAG,IAAA,yCAAwB,EAAC,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;oBACrF,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;oBAEzD,MAAM,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAA;oBACpF,2GAA2G;oBAC3G,oDAAoD;oBACpD,qBAAqB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBACvC,MAAM,gBAAgB,GAAG,IAAA,+BAAsB,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;wBACvE,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;oBACjE,CAAC,CAAC,CAAC;oBAEH,iBAAiB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;wBAChC,MAAM,aAAa,GAAG,IAAA,mCAAqB,EAAC,GAAG,EAAE,aAAa,CAAC,CAAC;wBAChE,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;oBAC3D,CAAC,CAAC,CAAC;oBAEH,WAAW,CAAC,GAAG,CACb,aAAa,CAAC,IAAI,EAClB,IAAA,2DAA0C,EAAC,aAAa,EAAE,iBAAiB,CAAC,CAC7E,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG;YAClB,aAAa;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,qFAAqF;QACrF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,KAAc,EAAE,EAAE;YAChD,IAAI,KAAK,YAAY,GAAG,EAAE;gBACxB,iGAAiG;gBACjG,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC1B;YACD,IAAI,KAAK,YAAY,GAAG,EAAE;gBACxB,iGAAiG;gBACjG,OAAO,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;aAClC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,OAAO,IAAA,cAAI,EAAC,IAAI,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACzD,IAAA,kBAAa,EAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;CACF;AA3ND,oEA2NC","sourcesContent":["import { writeFileSync } from \"fs\";\nimport path from \"path\";\nimport type { App } from \"aws-cdk-lib\";\nimport { Token } from \"aws-cdk-lib\";\nimport { dump } from \"js-yaml\";\nimport { GuAutoScalingGroup } from \"../../constructs/autoscaling\";\nimport { GuStack } from \"../../constructs/core\";\nimport { GuLambdaFunction } from \"../../constructs/lambda\";\nimport { autoscalingDeployment, uploadAutoscalingArtifact } from \"./deployments/autoscaling\";\nimport { addAmiParametersToCloudFormationDeployment, cloudFormationDeployment } from \"./deployments/cloudformation\";\nimport { updateLambdaDeployment, uploadLambdaArtifact } from \"./deployments/lambda\";\nimport { groupByClassNameStackRegionStage } from \"./group-by\";\nimport type {\n  GroupedCdkStacks,\n  Region,\n  RiffRaffDeployment,\n  RiffRaffDeploymentName,\n  RiffRaffDeploymentProps,\n  RiffRaffYaml,\n  StackTag,\n  StageTag,\n} from \"./types\";\n\n/**\n * A class that creates a `riff-raff.yaml` file.\n *\n * Rather than using this directly, prefer to use [[`GuRoot`]] instead.\n *\n * Supports:\n *   - Multiple CloudFormation stacks\n *   - Multiple regions\n *   - Lambda applications\n *   - EC2 (autoscaling) applications\n *\n * For lambda applications, 3 deployments will be defined:\n *   1. Lambda upload (`aws-lambda`, `action: [uploadLambda]`)\n *   2. CloudFormation deploy (`cloud-formation`)\n *   3. Lambda update (`aws-lambda`, `action: [updateLambda]`)\n *\n * For EC2 applications, 3 deployments will be defined:\n *   1. Artifact upload (`autoscaling`, `action: [uploadArtifacts]`)\n *  2. CloudFormation deploy (`cloud-formation`)\n *   3. Autoscaling deploy (`autoscaling`, `action: [deploy]`)\n *\n * It assumes a Riff-Raff bundle structure as follows:\n *\n * ```\n * .\n * ├── cdk.out\n * │   └── MyApplication.template.json\n * ├── my-application\n * │   └── my-application.deb\n * └── my-lambda\n *     └── my-lambda.zip\n * ```\n *\n * That is, all CloudFormation templates are in a `cdk.out` directory, and there is a directory per app.\n * Application artifact(s) are in the app directory.\n *\n * NOTE: The file extension is decided by you, the above file tree is used for illustration purposes.\n *\n * NOTE: Resources will be looked up by tags (Stack, Stage, App). Ensure your CFN stack is tagged appropriately!\n *\n * @see https://riffraff.gutools.co.uk/docs/reference/riff-raff.yaml.md\n * @see https://riffraff.gutools.co.uk/docs/magenta-lib/types\n */\nexport class RiffRaffYamlFileExperimental {\n  private readonly allCdkStacks: GuStack[];\n  private readonly allStackTags: StackTag[];\n  private readonly allStageTags: StageTag[];\n  private readonly allRegions: Region[];\n\n  private readonly riffRaffYaml: RiffRaffYaml;\n  private readonly outdir: string;\n\n  private isCdkStackPresent(expectedStack: StackTag, expectedStage: StageTag): boolean {\n    const matches = this.allCdkStacks.find((cdkStack) => {\n      const { stack, stage } = cdkStack;\n      return stack === expectedStack && stage === expectedStage;\n    });\n\n    return !!matches;\n  }\n\n  /**\n   * Check there are the appropriate number of `GuStack`s.\n   * Expect to find an instance for each combination of `stack`, and `stage`.\n   *\n   * If not valid, a message is logged describing what is missing to aid debugging.\n   *\n   * Given the following:\n   *\n   * ```ts\n   * const app = new App();\n   *\n   * class MyApplicationStack extends GuStack { }\n   *\n   * new MyApplicationStack(app, \"App-CODE-deploy\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"deploy\",\n   *   stage: \"CODE\"\n   * });\n   *\n   * new MyApplicationStack(app, \"App-PROD-media-service\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"media-service\",\n   *   stage: \"PROD\",\n   * });\n   *\n   * new MyApplicationStack(app, \"App-PROD-deploy\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"deploy\",\n   *   stage: \"PROD\"\n   * });\n   * ```\n   *\n   * This will log a message like this, where ❌ denotes something missing,\n   * specifically there is no `CODE` template for `media-service`.\n   *\n   * ```log\n   * Unable to produce a working riff-raff.yaml file; missing 1 definitions (details below)\n   *\n   * ┌───────────────┬──────┬──────┐\n   * │    (index)    │ CODE │ PROD │\n   * ├───────────────┼──────┼──────┤\n   * │    deploy     │ '✅' │ '✅' │\n   * │ media-service │ '❌' │ '✅' │\n   * └───────────────┴──────┴──────┘\n   * ```\n   *\n   * @private\n   */\n  private validateStacksInApp(): void {\n    type Found = \"✅\";\n    type NotFound = \"❌\";\n    type AppValidation = Record<StackTag, Record<StageTag, Found | NotFound>>;\n\n    const { allStackTags, allStageTags } = this;\n\n    const checks: AppValidation = allStackTags.reduce((accStackTag, stackTag) => {\n      return {\n        ...accStackTag,\n        [stackTag]: allStageTags.reduce((accStageTag, stageTag) => {\n          return {\n            ...accStageTag,\n            [stageTag]: this.isCdkStackPresent(stackTag, stageTag) ? \"✅\" : \"❌\",\n          };\n        }, {}),\n      };\n    }, {});\n\n    const missingDefinitions: Array<Found | NotFound> = Object.values(checks).flatMap((groupedByStackTag) => {\n      return Object.values(groupedByStackTag).filter((_) => _ === \"❌\");\n    });\n\n    if (missingDefinitions.length > 0) {\n      const message = `Unable to produce a working riff-raff.yaml file; missing ${missingDefinitions.length} definitions`;\n\n      console.log(`${message} (details below)`);\n      console.table(checks);\n\n      throw new Error(message);\n    }\n  }\n\n  private validateAllRegionsAreResolved(): void {\n    const unresolved = this.allRegions.filter((region) => Token.isUnresolved(region));\n\n    if (unresolved.length !== 0) {\n      throw new Error(`Unable to produce a working riff-raff.yaml file; all stacks must have an explicit region set`);\n    }\n  }\n\n  private getLambdas(cdkStack: GuStack): GuLambdaFunction[] {\n    return cdkStack.node.findAll().filter((_) => _ instanceof GuLambdaFunction) as GuLambdaFunction[];\n  }\n\n  private getAutoScalingGroups(cdkStack: GuStack): GuAutoScalingGroup[] {\n    return cdkStack.node.findAll().filter((_) => _ instanceof GuAutoScalingGroup) as GuAutoScalingGroup[];\n  }\n\n  // eslint-disable-next-line custom-rules/valid-constructors -- this needs to sit above GuStack on the cdk tree\n  constructor(app: App) {\n    this.allCdkStacks = app.node.findAll().filter((_) => _ instanceof GuStack) as GuStack[];\n    const allowedStages = new Set(this.allCdkStacks.map(({ stage }) => stage));\n    this.allStageTags = Array.from(allowedStages);\n    this.allStackTags = Array.from(new Set(this.allCdkStacks.map(({ stack }) => stack)));\n    this.allRegions = Array.from(new Set(this.allCdkStacks.map(({ region }) => region)));\n\n    this.validateStacksInApp();\n    this.validateAllRegionsAreResolved();\n\n    this.outdir = app.outdir;\n\n    const deployments = new Map<RiffRaffDeploymentName, RiffRaffDeploymentProps>();\n\n    const groupedStacks: GroupedCdkStacks = groupByClassNameStackRegionStage(this.allCdkStacks);\n\n    Object.values(groupedStacks).forEach((stackTagGroup) => {\n      Object.values(stackTagGroup).forEach((regionGroup) => {\n        Object.values(regionGroup).forEach((stageGroup) => {\n          const stacks: GuStack[] = Object.values(stageGroup).flat();\n\n          if (stacks.length === 0) {\n            throw new Error(\"Unable to produce a working riff-raff.yaml file; there are no stacks!\");\n          }\n\n          // The items in `stacks` only differ by stage, so we can just use the first item in the list.\n          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- length of `stacks` is checked above\n          const stack = stacks[0]!;\n\n          const lambdas = this.getLambdas(stack);\n          const autoscalingGroups = this.getAutoScalingGroups(stack);\n\n          const artifactUploads: RiffRaffDeployment[] = [\n            lambdas.map(uploadLambdaArtifact),\n            autoscalingGroups.map(uploadAutoscalingArtifact),\n          ].flat();\n          artifactUploads.forEach(({ name, props }) => deployments.set(name, props));\n\n          const cfnDeployment = cloudFormationDeployment(stacks, artifactUploads, this.outdir);\n          deployments.set(cfnDeployment.name, cfnDeployment.props);\n\n          const lambdasWithoutAnAlias = lambdas.filter((lambda) => lambda.alias === undefined)\n          // If the Lambda has an alias it is using versioning. When using versioning, there is no need for Riff-Raff\n          // to modify the unpublished version of the function\n          lambdasWithoutAnAlias.forEach((lambda) => {\n            const lambdaDeployment = updateLambdaDeployment(lambda, cfnDeployment);\n            deployments.set(lambdaDeployment.name, lambdaDeployment.props);\n          });\n\n          autoscalingGroups.forEach((asg) => {\n            const asgDeployment = autoscalingDeployment(asg, cfnDeployment);\n            deployments.set(asgDeployment.name, asgDeployment.props);\n          });\n\n          deployments.set(\n            cfnDeployment.name,\n            addAmiParametersToCloudFormationDeployment(cfnDeployment, autoscalingGroups)\n          );\n        });\n      });\n    });\n\n    this.riffRaffYaml = {\n      allowedStages,\n      deployments,\n    };\n  }\n\n  /**\n   * The `riff-raff.yaml` file as a string.\n   * Useful for testing.\n   */\n  toYAML(): string {\n    // Add support for ES6 Set and Map. See https://github.com/nodeca/js-yaml/issues/436.\n    const replacer = (_key: string, value: unknown) => {\n      if (value instanceof Set) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- this is how `js-yaml` is typed\n        return Array.from(value);\n      }\n      if (value instanceof Map) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- this is how `js-yaml` is typed\n        return Object.fromEntries(value);\n      }\n      return value;\n    };\n\n    return dump(this.riffRaffYaml, { replacer });\n  }\n\n  /**\n   * Write the `riff-raff.yaml` file to disk.\n   * It'll be located with the CFN JSON templates generated by `cdk synth`.\n   */\n  synth(): void {\n    const outPath = path.join(this.outdir, \"riff-raff.yaml\");\n    writeFileSync(outPath, this.toYAML());\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/experimental/riff-raff-yaml-file/index.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAmC;AACnC,gDAAwB;AAExB,6CAAoC;AACpC,qCAA+B;AAC/B,8DAAkE;AAClE,gDAAgD;AAChD,oDAA2D;AAC3D,2DAA6F;AAC7F,iEAAoH;AACpH,iDAAoF;AACpF,yCAA8D;AAY9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAa,4BAA4B;IAS/B,iBAAiB,CAAC,aAAuB,EAAE,aAAuB;QACxE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAClD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC;YAClC,OAAO,KAAK,KAAK,aAAa,IAAI,KAAK,KAAK,aAAa,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,CAAC,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACK,mBAAmB;QAKzB,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAE5C,MAAM,MAAM,GAAkB,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE;YAC1E,OAAO;gBACL,GAAG,WAAW;gBACd,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE;oBACxD,OAAO;wBACL,GAAG,WAAW;wBACd,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;qBACnE,CAAC;gBACJ,CAAC,EAAE,EAAE,CAAC;aACP,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,kBAAkB,GAA4B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACtG,OAAO,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,OAAO,GAAG,4DAA4D,kBAAkB,CAAC,MAAM,cAAc,CAAC;YAEpH,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,kBAAkB,CAAC,CAAC;YAC1C,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;IACH,CAAC;IAEO,6BAA6B;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QAElF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAC;SACjH;IACH,CAAC;IAEO,UAAU,CAAC,QAAiB;QAClC,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,yBAAgB,CAAuB,CAAC;IACpG,CAAC;IAEO,oBAAoB,CAAC,QAAiB;QAC5C,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,gCAAkB,CAAyB,CAAC;IACxG,CAAC;IAED,8GAA8G;IAC9G,YAAY,GAAQ;QAClB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,cAAO,CAAc,CAAC;QACxF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAErF,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAErC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAEzB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAmD,CAAC;QAE/E,MAAM,aAAa,GAAqB,IAAA,2CAAgC,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE5F,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YACrD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;gBACnD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;oBAChD,MAAM,MAAM,GAAc,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;oBAE3D,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;wBACvB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;qBAC1F;oBAED,6FAA6F;oBAC7F,2GAA2G;oBAC3G,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;oBAEzB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBACvC,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;oBAE3D,MAAM,eAAe,GAAyB;wBAC5C,OAAO,CAAC,GAAG,CAAC,6BAAoB,CAAC;wBACjC,iBAAiB,CAAC,GAAG,CAAC,uCAAyB,CAAC;qBACjD,CAAC,IAAI,EAAE,CAAC;oBACT,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;oBAE3E,MAAM,aAAa,GAAG,IAAA,yCAAwB,EAAC,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;oBACrF,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;oBAEzD,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBACzB,MAAM,gBAAgB,GAAG,IAAA,+BAAsB,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;wBACvE,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;oBACjE,CAAC,CAAC,CAAC;oBAEH,iBAAiB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;wBAChC,MAAM,aAAa,GAAG,IAAA,mCAAqB,EAAC,GAAG,EAAE,aAAa,CAAC,CAAC;wBAChE,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;oBAC3D,CAAC,CAAC,CAAC;oBAEH,WAAW,CAAC,GAAG,CACb,aAAa,CAAC,IAAI,EAClB,IAAA,2DAA0C,EAAC,aAAa,EAAE,iBAAiB,CAAC,CAC7E,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG;YAClB,aAAa;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,qFAAqF;QACrF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,KAAc,EAAE,EAAE;YAChD,IAAI,KAAK,YAAY,GAAG,EAAE;gBACxB,iGAAiG;gBACjG,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC1B;YACD,IAAI,KAAK,YAAY,GAAG,EAAE;gBACxB,iGAAiG;gBACjG,OAAO,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;aAClC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,OAAO,IAAA,cAAI,EAAC,IAAI,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACzD,IAAA,kBAAa,EAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;CACF;AAxND,oEAwNC","sourcesContent":["import { writeFileSync } from \"fs\";\nimport path from \"path\";\nimport type { App } from \"aws-cdk-lib\";\nimport { Token } from \"aws-cdk-lib\";\nimport { dump } from \"js-yaml\";\nimport { GuAutoScalingGroup } from \"../../constructs/autoscaling\";\nimport { GuStack } from \"../../constructs/core\";\nimport { GuLambdaFunction } from \"../../constructs/lambda\";\nimport { autoscalingDeployment, uploadAutoscalingArtifact } from \"./deployments/autoscaling\";\nimport { addAmiParametersToCloudFormationDeployment, cloudFormationDeployment } from \"./deployments/cloudformation\";\nimport { updateLambdaDeployment, uploadLambdaArtifact } from \"./deployments/lambda\";\nimport { groupByClassNameStackRegionStage } from \"./group-by\";\nimport type {\n  GroupedCdkStacks,\n  Region,\n  RiffRaffDeployment,\n  RiffRaffDeploymentName,\n  RiffRaffDeploymentProps,\n  RiffRaffYaml,\n  StackTag,\n  StageTag,\n} from \"./types\";\n\n/**\n * A class that creates a `riff-raff.yaml` file.\n *\n * Rather than using this directly, prefer to use [[`GuRoot`]] instead.\n *\n * Supports:\n *   - Multiple CloudFormation stacks\n *   - Multiple regions\n *   - Lambda applications\n *   - EC2 (autoscaling) applications\n *\n * For lambda applications, 3 deployments will be defined:\n *   1. Lambda upload (`aws-lambda`, `action: [uploadLambda]`)\n *   2. CloudFormation deploy (`cloud-formation`)\n *   3. Lambda update (`aws-lambda`, `action: [updateLambda]`)\n *\n * For EC2 applications, 3 deployments will be defined:\n *   1. Artifact upload (`autoscaling`, `action: [uploadArtifacts]`)\n *  2. CloudFormation deploy (`cloud-formation`)\n *   3. Autoscaling deploy (`autoscaling`, `action: [deploy]`)\n *\n * It assumes a Riff-Raff bundle structure as follows:\n *\n * ```\n * .\n * ├── cdk.out\n * │   └── MyApplication.template.json\n * ├── my-application\n * │   └── my-application.deb\n * └── my-lambda\n *     └── my-lambda.zip\n * ```\n *\n * That is, all CloudFormation templates are in a `cdk.out` directory, and there is a directory per app.\n * Application artifact(s) are in the app directory.\n *\n * NOTE: The file extension is decided by you, the above file tree is used for illustration purposes.\n *\n * NOTE: Resources will be looked up by tags (Stack, Stage, App). Ensure your CFN stack is tagged appropriately!\n *\n * @see https://riffraff.gutools.co.uk/docs/reference/riff-raff.yaml.md\n * @see https://riffraff.gutools.co.uk/docs/magenta-lib/types\n */\nexport class RiffRaffYamlFileExperimental {\n  private readonly allCdkStacks: GuStack[];\n  private readonly allStackTags: StackTag[];\n  private readonly allStageTags: StageTag[];\n  private readonly allRegions: Region[];\n\n  private readonly riffRaffYaml: RiffRaffYaml;\n  private readonly outdir: string;\n\n  private isCdkStackPresent(expectedStack: StackTag, expectedStage: StageTag): boolean {\n    const matches = this.allCdkStacks.find((cdkStack) => {\n      const { stack, stage } = cdkStack;\n      return stack === expectedStack && stage === expectedStage;\n    });\n\n    return !!matches;\n  }\n\n  /**\n   * Check there are the appropriate number of `GuStack`s.\n   * Expect to find an instance for each combination of `stack`, and `stage`.\n   *\n   * If not valid, a message is logged describing what is missing to aid debugging.\n   *\n   * Given the following:\n   *\n   * ```ts\n   * const app = new App();\n   *\n   * class MyApplicationStack extends GuStack { }\n   *\n   * new MyApplicationStack(app, \"App-CODE-deploy\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"deploy\",\n   *   stage: \"CODE\"\n   * });\n   *\n   * new MyApplicationStack(app, \"App-PROD-media-service\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"media-service\",\n   *   stage: \"PROD\",\n   * });\n   *\n   * new MyApplicationStack(app, \"App-PROD-deploy\", {\n   *   env: {\n   *     region: \"eu-west-1\",\n   *   },\n   *   stack: \"deploy\",\n   *   stage: \"PROD\"\n   * });\n   * ```\n   *\n   * This will log a message like this, where ❌ denotes something missing,\n   * specifically there is no `CODE` template for `media-service`.\n   *\n   * ```log\n   * Unable to produce a working riff-raff.yaml file; missing 1 definitions (details below)\n   *\n   * ┌───────────────┬──────┬──────┐\n   * │    (index)    │ CODE │ PROD │\n   * ├───────────────┼──────┼──────┤\n   * │    deploy     │ '✅' │ '✅' │\n   * │ media-service │ '❌' │ '✅' │\n   * └───────────────┴──────┴──────┘\n   * ```\n   *\n   * @private\n   */\n  private validateStacksInApp(): void {\n    type Found = \"✅\";\n    type NotFound = \"❌\";\n    type AppValidation = Record<StackTag, Record<StageTag, Found | NotFound>>;\n\n    const { allStackTags, allStageTags } = this;\n\n    const checks: AppValidation = allStackTags.reduce((accStackTag, stackTag) => {\n      return {\n        ...accStackTag,\n        [stackTag]: allStageTags.reduce((accStageTag, stageTag) => {\n          return {\n            ...accStageTag,\n            [stageTag]: this.isCdkStackPresent(stackTag, stageTag) ? \"✅\" : \"❌\",\n          };\n        }, {}),\n      };\n    }, {});\n\n    const missingDefinitions: Array<Found | NotFound> = Object.values(checks).flatMap((groupedByStackTag) => {\n      return Object.values(groupedByStackTag).filter((_) => _ === \"❌\");\n    });\n\n    if (missingDefinitions.length > 0) {\n      const message = `Unable to produce a working riff-raff.yaml file; missing ${missingDefinitions.length} definitions`;\n\n      console.log(`${message} (details below)`);\n      console.table(checks);\n\n      throw new Error(message);\n    }\n  }\n\n  private validateAllRegionsAreResolved(): void {\n    const unresolved = this.allRegions.filter((region) => Token.isUnresolved(region));\n\n    if (unresolved.length !== 0) {\n      throw new Error(`Unable to produce a working riff-raff.yaml file; all stacks must have an explicit region set`);\n    }\n  }\n\n  private getLambdas(cdkStack: GuStack): GuLambdaFunction[] {\n    return cdkStack.node.findAll().filter((_) => _ instanceof GuLambdaFunction) as GuLambdaFunction[];\n  }\n\n  private getAutoScalingGroups(cdkStack: GuStack): GuAutoScalingGroup[] {\n    return cdkStack.node.findAll().filter((_) => _ instanceof GuAutoScalingGroup) as GuAutoScalingGroup[];\n  }\n\n  // eslint-disable-next-line custom-rules/valid-constructors -- this needs to sit above GuStack on the cdk tree\n  constructor(app: App) {\n    this.allCdkStacks = app.node.findAll().filter((_) => _ instanceof GuStack) as GuStack[];\n    const allowedStages = new Set(this.allCdkStacks.map(({ stage }) => stage));\n    this.allStageTags = Array.from(allowedStages);\n    this.allStackTags = Array.from(new Set(this.allCdkStacks.map(({ stack }) => stack)));\n    this.allRegions = Array.from(new Set(this.allCdkStacks.map(({ region }) => region)));\n\n    this.validateStacksInApp();\n    this.validateAllRegionsAreResolved();\n\n    this.outdir = app.outdir;\n\n    const deployments = new Map<RiffRaffDeploymentName, RiffRaffDeploymentProps>();\n\n    const groupedStacks: GroupedCdkStacks = groupByClassNameStackRegionStage(this.allCdkStacks);\n\n    Object.values(groupedStacks).forEach((stackTagGroup) => {\n      Object.values(stackTagGroup).forEach((regionGroup) => {\n        Object.values(regionGroup).forEach((stageGroup) => {\n          const stacks: GuStack[] = Object.values(stageGroup).flat();\n\n          if (stacks.length === 0) {\n            throw new Error(\"Unable to produce a working riff-raff.yaml file; there are no stacks!\");\n          }\n\n          // The items in `stacks` only differ by stage, so we can just use the first item in the list.\n          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- length of `stacks` is checked above\n          const stack = stacks[0]!;\n\n          const lambdas = this.getLambdas(stack);\n          const autoscalingGroups = this.getAutoScalingGroups(stack);\n\n          const artifactUploads: RiffRaffDeployment[] = [\n            lambdas.map(uploadLambdaArtifact),\n            autoscalingGroups.map(uploadAutoscalingArtifact),\n          ].flat();\n          artifactUploads.forEach(({ name, props }) => deployments.set(name, props));\n\n          const cfnDeployment = cloudFormationDeployment(stacks, artifactUploads, this.outdir);\n          deployments.set(cfnDeployment.name, cfnDeployment.props);\n\n          lambdas.forEach((lambda) => {\n            const lambdaDeployment = updateLambdaDeployment(lambda, cfnDeployment);\n            deployments.set(lambdaDeployment.name, lambdaDeployment.props);\n          });\n\n          autoscalingGroups.forEach((asg) => {\n            const asgDeployment = autoscalingDeployment(asg, cfnDeployment);\n            deployments.set(asgDeployment.name, asgDeployment.props);\n          });\n\n          deployments.set(\n            cfnDeployment.name,\n            addAmiParametersToCloudFormationDeployment(cfnDeployment, autoscalingGroups)\n          );\n        });\n      });\n    });\n\n    this.riffRaffYaml = {\n      allowedStages,\n      deployments,\n    };\n  }\n\n  /**\n   * The `riff-raff.yaml` file as a string.\n   * Useful for testing.\n   */\n  toYAML(): string {\n    // Add support for ES6 Set and Map. See https://github.com/nodeca/js-yaml/issues/436.\n    const replacer = (_key: string, value: unknown) => {\n      if (value instanceof Set) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- this is how `js-yaml` is typed\n        return Array.from(value);\n      }\n      if (value instanceof Map) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- this is how `js-yaml` is typed\n        return Object.fromEntries(value);\n      }\n      return value;\n    };\n\n    return dump(this.riffRaffYaml, { replacer });\n  }\n\n  /**\n   * Write the `riff-raff.yaml` file to disk.\n   * It'll be located with the CFN JSON templates generated by `cdk synth`.\n   */\n  synth(): void {\n    const outPath = path.join(this.outdir, \"riff-raff.yaml\");\n    writeFileSync(outPath, this.toYAML());\n  }\n}\n"]}

package/lib/patterns/ec2-app/base.d.ts

@@ -13,7 +13,19 @@ import { AppAccess } from "../../types";
 import type { GuAsgCapacity, GuDomainName } from "../../types";
 import type { AmigoProps } from "../../types/amigo";
 export interface AccessLoggingProps {
+    /**
+     * Enable (load balancer) access logs.
+     *
+     * Note, you will need to specify a region in your stack declaration to use
+     * this.
+     * See`https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-elasticloadbalancingv2.ApplicationLoadBalancer.html#logwbraccesswbrlogsbucket-prefix`
+     */
     enabled: boolean;
+    /**
+     * S3 prefix for the logs.
+     *
+     * @defaultValue no prefix
+     */
     prefix?: string;
 }
 /**
@@ -29,283 +41,140 @@ export interface AccessLoggingProps {
  * to Kinesis will be configured automatically via the [[`GuEc2App`]] pattern.
  */
 export interface ApplicationLoggingProps {
+    /**
+     * Enables forwarding of application logs to the Guardian ELK stack.
+     *
+     * Note, to work, you will need to also do the following non-CDK things:
+     *
+     * 1. Include the `cdk-base` Amigo role in your AMI.
+     * 2. Log to `journald`. We recommend doing this by logging to `stdout` and
+     *    using `systemd` to start your app
+     * 3. Confirm that your [[`systemdUnitName`]] is configured properly.
+     *
+     * Unless you have explicitly opted-out, appropriate IAM permissions for
+     * logging to Kinesis will be configured automatically via the [[`GuEc2App`]]
+     * pattern.
+     *
+     * @see https://github.com/guardian/amigo/tree/main/roles/cdk-base
+     */
     enabled: boolean;
     /**
-     * Defaults to app name. That is, if your app runs as `<app>.service`
-     * (e.g. `janus.service`), this will 'just work'.
+     * This needs to match the name of your SystemD unit.
+     *
+     * If your systemd unit is not `<app>.service` set this value.
      *
-     * If it runs with a non-standard name, you will need to override the default
-     * behavour. I.e. if your app is running as `some-different-name.service`, then
-     * this prop should be set to `some-different-name`.
+     * @defaultValue `<app>.service`
      */
     systemdUnitName?: string;
 }
+/**
+ * @privateRemarks we should rename this to AlarmsProps.
+ */
 export interface Alarms {
+    /**
+     * Name of the target (SNS Topic) for alarm notifications.
+     */
     snsTopicName: string;
+    /**
+     * Enable the 5xx alarm with settings.
+     */
     http5xxAlarm: false | Http5xxAlarmProps;
+    /**
+     * Enable the unhealthy instances alarm.
+     */
     unhealthyInstancesAlarm: boolean;
+    /**
+     * Internal flag - users of this library should ignore this setting.
+     */
     noMonitoring?: false;
 }
-/**
- * Configuration options for the [[`GuEc2App`]] pattern.
- *
- * To grant EC2 instances additional IAM permissions, use the `roleConfiguration` prop. For example,
- * to allow your app to write to DynamoDB:
- *
- * ```typescript
- * // other props
- * roleConfiguration: {
- *   additionalPolicies: [new GuDynamoDBWritePolicy(stack, "DynamoTable", { tableName: "my-dynamo-table" })],
- * }
- * ```
- *
- * To create alarms (recommended), use:
- * ```typescript
- * // other props
- * monitoringConfiguration: {
- *   snsTopicName: "alerts-topic-for-my-team",
- *   http5xxAlarm: {
- *     tolerated5xxPercentage: 1,
- *   },
- *   unhealthyInstancesAlarm: true,
- * }
- * ```
- *
- * To opt out of creating alarms, use:
- *```typescript
- * // other props
- * monitoringConfiguration: { noMonitoring: true }
- * ```
- *
- * To automatically ship application logs from `stdout` to ELK, use:
- *
- * ```typescript
- * {
- *   // other props
- *   applicationLogging: { enabled: true }
- * }
- * ```
- *
- * For more details on the requirements for application log shipping, see [[`ApplicationLoggingProps`]].
- *
- * To enable access logging for your load balancer, you can specify the prefix to write the logs to.
- * The S3 bucket used to hold these access logs must be specified in SSM at `/account/services/access-logging/bucket`
- * You must specify a region in your stack declaration if you are to use this prop, as specified here:
- * https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-elasticloadbalancingv2.ApplicationLoadBalancer.html#logwbraccesswbrlogsbucket-prefix
- * For example:
- * ```typescript
- * {
- *   // other props
- *   accessLogging: {
- *     enabled: true,
- *     prefix: "my-application-logs"
- *   }
- * }
- *
- * If you would like to enable access logging at the root of the S3 bucket (ie without a prefix), you can omit the prefix
- * For example:
- * ```typescript
- * {
- *   // other props
- *   accessLogging: {
- *     enabled: true,
- *   }
- * }
- * ```
- */
 export interface GuEc2AppProps extends AppIdentity {
+    /**
+     * User data for the autoscaling group.
+     */
     userData: GuUserDataProps | string;
+    /**
+     * Network access restrictions for your load balancer.
+     *
+     * Note, this merely provides defence in depth; you should, for example, limit
+     * access to the VPN and then treat that as sufficient. Instead, use Google
+     * Auth for human access, or a suitable machine auth mechanism.
+     */
     access: AppAccess;
+    /**
+     * The port your application runs on.
+     */
     applicationPort: number;
+    /**
+     * Configure IAM roles for autoscaling group EC2 instances.
+     */
     roleConfiguration?: GuInstanceRoleProps;
+    /**
+     * Enable and configure alarms.
+     */
     monitoringConfiguration: Alarms | NoMonitoring;
+    /**
+     * EC2 instance type. Note, ensure your code is built for the same
+     * architecture family (arm64 - 'Graviton' instances - or x64).
+     */
     instanceType: InstanceType;
+    /**
+     * Enable and configures application logs.
+     */
     applicationLogging?: ApplicationLoggingProps;
+    /**
+     * Enable and configures access logs.
+     */
     accessLogging?: AccessLoggingProps;
+    /**
+     * Add block devices (additional storage).
+     */
     blockDevices?: BlockDevice[];
+    /**
+     * Autoscaling group min and max sizes.
+     */
     scaling: GuAsgCapacity;
-    certificateProps: GuDomainName;
+    /**
+     * Specify certificate for the load balancer.
+     */
+    certificateProps?: GuDomainName;
+    /**
+     * Disable imdsv2. Most of the time you should not set this.
+     *
+     * @see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html
+     */
     withoutImdsv2?: boolean;
+    /**
+     * Configure Amigo image recipe.
+     */
     imageRecipe?: string | AmigoProps;
+    /**
+     * Specify the VPC to use.
+     *
+     * @see https://github.com/guardian/aws-account-setup
+     */
     vpc?: IVpc;
+    /**
+     * Specify private subnets if using a non-default VPC or (generally
+     * discouraged) to limit to a subset of the available subnets.
+     */
     privateSubnets?: ISubnet[];
+    /**
+     * Specify private subnets if using a non-default VPC or (generally
+     * discouraged) to limit to a subset of the available subnets.
+     */
     publicSubnets?: ISubnet[];
 }
 /**
- * Pattern which creates the resources needed to run an application on EC2 instances.
- * For convenience, you may wish to use [[`GuPlayApp`]] or [[`GuNodeApp`]], which extend this class.
- *
- * This pattern will grant your EC2 instances a number of commonly needed IAM permissions. For more information on
- * this, see [[`GuInstanceRole`]]. To add additional permissions to your EC2 instances, see [[`GuEc2AppProps`]].
- *
- * This pattern will automatically create security groups/rules which allow for:
- * 1. Incoming traffic over HTTPS (from the whole internet or from the specified CIDR ranges, depending on the
- * [[`AppAccess`]] specified).
- * 2. Communication between the load balancer and the EC2 instances over HTTP, via the specified application port.
- * 3. Outbound traffic from your EC2 instances over HTTPS (to enable communication with third-party APIs).
- *
- * Example usage for a public facing app (open to the internet):
- * ```typescript
- * new GuEc2App(stack, {
- *   applicationPort: 1234,
- *   app: "app-name",
- *   access: { scope: AccessScope.PUBLIC },
- *   instanceType: InstanceType.of(InstanceClass.T4G, InstanceSize.MEDIUM),
- *   certificateProps:{
- *     domainName: "prod-guardian.com",
- *   },
- *   monitoringConfiguration: {
- *     snsTopicName: "alerts-topic-for-my-team",
- *     http5xxAlarm: {
- *       tolerated5xxPercentage: 1,
- *     },
- *     unhealthyInstancesAlarm: true,
- *   },
- *   userData: {
- *     distributable: {
- *       fileName: "app-name.deb",
- *       executionStatement: `dpkg -i /app-name/app-name.deb`,
- *     }
- *   },
- * });
- * ```
- *
- * Example usage for an app which is restricted to specific CIDR ranges:
- * ```typescript
- * new GuEc2App(stack, {
- *   applicationPort: 1234,
- *   app: "app-name",
- *   access: {
- *     scope: AccessScope.RESTRICTED,
- *     cidrRanges: [Peer.ipv4("192.168.1.1/32"), Peer.ipv4("8.8.8.8/32")],
- *   },
- *   instanceType: InstanceType.of(InstanceClass.T4G, InstanceSize.MEDIUM),
- *   certificateProps:{
- *     domainName: "prod-guardian.com",
- *   },
- *   monitoringConfiguration: {
- *     snsTopicName: "alerts-topic-for-my-team",
- *     http5xxAlarm: {
- *       tolerated5xxPercentage: 1,
- *     },
- *     unhealthyInstancesAlarm: true,
- *   }
- *   userData: {
- *     distributable: {
- *       fileName: "app-name.deb",
- *       executionStatement: `dpkg -i /app-name/app-name.deb`,
- *     }
- *   },
- * });
- * ```
- *
- * ### Varying values by stage
- *
- * There are times when you want a resource's configuration to be stage aware,
- * for example the number of instances in an ASG.
- *
- * To do this, we can use a simple ternary:
- * ```typescript
- * new GuEc2App(this, {
- *   // other required properties
- *   scaling: this.stage === "PROD" ? { minimumInstances: 6 } : { minimumInstances: 1 }
- * });
- * ```
- *
- * If multiple properties need to be stage aware, consider encoding this into the `props` of the calling class:
- *
- * ```typescript
- * export interface MyAppProps extends GuStackProps {
- *   domainName: string;
- *   scaling: GuAsgCapacity;
- *   monitoringConfiguration: Alarms | NoMonitoring;
- * }
- *
- * export class MyApp extends GuStack {
- *   private static app = "cdk-playground";
- *
- *   constructor(scope: App, id: string, props: MyAppProps) {
- *     const { stage, domainName, scaling, monitoringConfiguration } = props;
- *
- *     super(scope, id, props);
- *
- *     new GuPlayApp(this, {
- *       app: "my-app",
- *       instanceType: InstanceType.of(InstanceClass.T4G, InstanceSize.MICRO),
- *       access: { scope: AccessScope.PUBLIC },
- *       userData: {
- *         distributable: {
- *           fileName: `my-app.deb`,
- *           executionStatement: `dpkg -i /my-app/my-app.deb`,
- *         },
- *       },
- *       certificateProps: {
- *         domainName,
- *       },
- *       monitoringConfiguration,
- *       scaling,
- *     });
- *   }
- * }
- *
- * new MyApp(app, "MyApp-CODE", {
- *   stage: "CODE",
- *   domainName: "my-app.code.dev-gutools.co.uk",
- *   scaling: { minimumInstances: 1 },
- *   monitoringConfiguration: { noMonitoring: true },
- * });
- *
- * new MyApp(app, "MyApp-PROD", {
- *   stage: "PROD",
- *   domainName: "my-app.prod.gutools.co.uk",
- *   scaling: { minimumInstances: 6 },
- *   monitoringConfiguration: {
- *     // config to enable alarms in PROD
- *   },
- * });
- * ```
- *
- * If you _must_ support a non-standard VPC setup, it's possible to override the VPC and subnet selection into which
- * instances will be started. You need to set the three props below in order for this to work:
- *  vpc: this must be an IVpc instance indicating the VPC to deploy into (usually obtained from `Vpc.fromVpcAttributes`)
- *  privateSubnets: a list of ISubnet indicating the subnets for the autoscaling group to deploy instances into (usually
- *    obtained from `GuVpc.subnets`)
- *  publicSubnets: a list of ISubnet indicating the subnets for the loadbalancer to use, if the loadbalancer
- *    is intended for public access (usually obtained from `GuVpc.subnets`)
- *    On the other hand, if the access is private, then an "internal" loadbalancer is used in the `privateSubnets` list.
- * Please note that no checking is applied to the subnet lists to ensure that they correspond to the vpc given; as
- * an advanced feature it is assumed that the caller ensures this.  If the subnets are mismatched then the resulting
- * Cloudformation will fail to deploy.
- *
- * ### Customising the infrastructure generated by this pattern
- *
- * Although we allow users to customise many aspects of their infrastructure via [[`GuEc2AppProps`]], it's possible
- * that there are less common use-cases which are currently unsupported via the API. In these circumstances escape
- * hatches can be used to override specific resources in the stack.
- *
- * In order to do this:
+ * Pattern which creates the resources needed to run an application on EC2
+ * behind a load balancer. For convenience, you may wish to use [[`GuPlayApp`]]
+ * or [[`GuNodeApp`]], which extend this class.
  *
- * 1. Create desired resource using Guardian or AWS constructs, for example:
- * ```typescript
- * const sg = new GuSecurityGroup(
- *   // custom parameters
- * );
- * ```
- * 2. Access the CloudFormation version of the resource that you wish to customise, for example:
- * ```typescript
- * const pattern = new GuEc2App(
- *   // all parameters
- * )
- * const cfnLb = pattern.loadBalancer.node.defaultChild as CfnLoadBalancer;
- * ```
- * 3. Replace the resource generated by the pattern with your bespoke resource, for example:
- * ```typescript
- * cfnLb.securityGroups = [sg.securityGroupId];
- * ```
+ * See props for further details.
  */
 export declare class GuEc2App extends Construct {
     readonly vpc: IVpc;
-    readonly certificate: GuCertificate;
+    readonly certificate?: GuCertificate;
     readonly loadBalancer: GuApplicationLoadBalancer;
     readonly autoScalingGroup: GuAutoScalingGroup;
     readonly listener: GuHttpsApplicationListener;

package/lib/patterns/ec2-app/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/patterns/ec2-app/base.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAS,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAI9E,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAc,MAAM,8BAA8B,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEnF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAmD,MAAM,uBAAuB,CAAC;AAErG,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEhE,OAAO,EACL,yBAAyB,EACzB,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,MAAM;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,KAAK,GAAG,iBAAiB,CAAC;IACxC,uBAAuB,EAAE,OAAO,CAAC;IACjC,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,QAAQ,EAAE,eAAe,GAAG,MAAM,CAAC;IACnC,MAAM,EAAE,SAAS,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;IACxC,uBAAuB,EAAE,MAAM,GAAG,YAAY,CAAC;IAC/C,YAAY,EAAE,YAAY,CAAC;IAC3B,kBAAkB,CAAC,EAAE,uBAAuB,CAAC;IAC7C,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,OAAO,EAAE,aAAa,CAAC;IACvB,gBAAgB,EAAE,YAAY,CAAC;IAC/B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAClC,GAAG,CAAC,EAAE,IAAI,CAAC;IACX,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC;IAC3B,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;CAC3B;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2KG;AACH,qBAAa,QAAS,SAAQ,SAAS;IASrC,SAAgB,GAAG,EAAE,IAAI,CAAC;IAC1B,SAAgB,WAAW,EAAE,aAAa,CAAC;IAC3C,SAAgB,YAAY,EAAE,yBAAyB,CAAC;IACxD,SAAgB,gBAAgB,EAAE,kBAAkB,CAAC;IACrD,SAAgB,QAAQ,EAAE,0BAA0B,CAAC;IACrD,SAAgB,WAAW,EAAE,wBAAwB,CAAC;gBAE1C,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa;CAsKjD"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/patterns/ec2-app/base.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAS,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAI9E,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAc,MAAM,8BAA8B,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEnF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAmD,MAAM,uBAAuB,CAAC;AAErG,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEhE,OAAO,EACL,yBAAyB,EACzB,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;;;;;;;OAeG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,KAAK,GAAG,iBAAiB,CAAC;IACxC;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB;AAED,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD;;OAEG;IACH,QAAQ,EAAE,eAAe,GAAG,MAAM,CAAC;IACnC;;;;;;OAMG;IACH,MAAM,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;IACxC;;OAEG;IACH,uBAAuB,EAAE,MAAM,GAAG,YAAY,CAAC;IAC/C;;;OAGG;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,uBAAuB,CAAC;IAC7C;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;IACvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAClC;;;;OAIG;IACH,GAAG,CAAC,EAAE,IAAI,CAAC;IACX;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC;IAE3B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;CAC3B;AAUD;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,SAAS;IASrC,SAAgB,GAAG,EAAE,IAAI,CAAC;IAC1B,SAAgB,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5C,SAAgB,YAAY,EAAE,yBAAyB,CAAC;IACxD,SAAgB,gBAAgB,EAAE,kBAAkB,CAAC;IACrD,SAAgB,QAAQ,EAAE,0BAA0B,CAAC;IACrD,SAAgB,WAAW,EAAE,wBAAwB,CAAC;gBAE1C,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa;CAyKjD"}