@guardian/cdk 57.0.0 → 58.0.0

package/lib/constructs/core/stack.d.ts

@@ -34,14 +34,6 @@ export interface GuStackProps extends Omit<StackProps, "stackName"> {
      * please do not override this.
      */
     withoutMetadata?: boolean;
-    /**
-     * Set to enable all resources in the stack for backup provided by https://github.com/guardian/aws-backup.
-     *
-     * @default false - backups are not enabled
-     *
-     * @see https://github.com/guardian/aws-backup
-     */
-    withBackup?: boolean;
 }
 /**
  * GuStack provides the `stack` and `stage` parameters to a template.

package/lib/constructs/core/stack.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stack.d.ts","sourceRoot":"","sources":["../../../src/constructs/core/stack.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAc,UAAU,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAwB,YAAY,EAA0B,KAAK,EAAQ,MAAM,aAAa,CAAC;AACtG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAQ7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,MAAM,WAAW,YAAa,SAAQ,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC;IACjE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,OAAQ,SAAQ,KAAM,YAAW,kBAAkB;IAC9D,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC;;;OAGG;IACH,SAAgB,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnD;;;;;;;;;OASG;IACH,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,wBAAwB,GAAE,OAAc,GAAG,IAAI;IAM5F;;;;OAIG;IACH,IAAI,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAK7C;gBAGW,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;IAkDvD;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACI,iBAAiB,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,iBAAiB,GAAG,IAAI;CAQhG"}
+{"version":3,"file":"stack.d.ts","sourceRoot":"","sources":["../../../src/constructs/core/stack.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAc,UAAU,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAwB,YAAY,EAA0B,KAAK,EAAQ,MAAM,aAAa,CAAC;AACtG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAO7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,MAAM,WAAW,YAAa,SAAQ,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC;IACjE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,OAAQ,SAAQ,KAAM,YAAW,kBAAkB;IAC9D,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC;;;OAGG;IACH,SAAgB,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnD;;;;;;;;;OASG;IACH,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,wBAAwB,GAAE,OAAc,GAAG,IAAI;IAM5F;;;;OAIG;IACH,IAAI,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAK7C;gBAGW,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;IAuCvD;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACI,iBAAiB,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,iBAAiB,GAAG,IAAI;CAQhG"}

package/lib/constructs/core/stack.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GuStack = void 0;
 const aws_cdk_lib_1 = require("aws-cdk-lib");
 const git_url_parse_1 = __importDefault(require("git-url-parse"));
-const aws_backup_1 = require("../../aspects/aws-backup");
 const cfn_include_reporter_1 = require("../../aspects/cfn-include-reporter");
 const cfn_parameter_reporter_1 = require("../../aspects/cfn-parameter-reporter");
 const metadata_1 = require("../../aspects/metadata");
@@ -68,7 +67,7 @@ class GuStack extends aws_cdk_lib_1.Stack {
     }
     // eslint-disable-next-line custom-rules/valid-constructors -- GuStack is the exception as it must take an App
     constructor(scope, id, props) {
-        const { cloudFormationStackName = process.env.GU_CFN_STACK_NAME, stack, stage, app, withoutTags, withBackup = false, } = props;
+        const { cloudFormationStackName = process.env.GU_CFN_STACK_NAME, stack, stage, app, withoutTags } = props;
         super(scope, id, {
             ...props,
             stackName: cloudFormationStackName,
@@ -96,9 +95,6 @@ class GuStack extends aws_cdk_lib_1.Stack {
         }
         aws_cdk_lib_1.Aspects.of(this).add(new cfn_include_reporter_1.CfnIncludeReporter());
         aws_cdk_lib_1.Aspects.of(this).add(new cfn_parameter_reporter_1.CfnParameterReporter());
-        if (withBackup) {
-            aws_cdk_lib_1.Aspects.of(this).add(new aws_backup_1.AwsBackupTag());
-        }
     }
     /**
      * Returns the repository name.

package/lib/constructs/core/stack.js.map

@@ -1 +1 @@
-{"version":3,"file":"stack.js","sourceRoot":"","sources":["../../../src/constructs/core/stack.ts"],"names":[],"mappings":";;;;;;AACA,6CAAsG;AAEtG,kEAAwC;AACxC,yDAAwD;AACxD,6EAAwE;AACxE,iFAA4E;AAC5E,qDAAkD;AAClD,+CAAyE;AACzE,yCAAqD;AAkDrD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,OAAQ,SAAQ,mBAAK;IAWhC;;;;;;;;;OASG;IACO,MAAM,CAAC,GAAW,EAAE,KAAa,EAAE,2BAAoC,IAAI;QACnF,4CAA4C;QAC5C,wGAAwG;QACxG,kBAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,wBAAwB,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,IAAI;aACb,OAAO,EAAE;aACT,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,YAAY,0BAAY,CAAC;aACxD,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,KAAqB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,8GAA8G;IAC9G,YAAY,KAAU,EAAE,EAAU,EAAE,KAAmB;QACrD,MAAM,EACJ,uBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,EACvD,KAAK,EACL,KAAK,EACL,GAAG,EACH,WAAW,EACX,UAAU,GAAG,KAAK,GACnB,GAAG,KAAK,CAAC;QAEV,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE;YACf,GAAG,KAAK;YACR,SAAS,EAAE,uBAAuB;YAElC,gEAAgE;YAChE,8FAA8F;YAC9F,WAAW,EAAE,IAAI,oCAAsB,EAAE;SAC1C,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEjD,IAAI,CAAC,WAAW,EAAE;YAChB,IAAI,CAAC,MAAM,CAAC,uBAAW,CAAC,GAAG,EAAE,uBAAW,CAAC,KAAK,CAAC,CAAC;YAEhD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,IAAI,IAAI,CAAC,GAAG,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;aAC9B;YAED,IAAI,IAAI,CAAC,cAAc,EAAE;gBACvB,IAAI,CAAC,MAAM,CAAC,wBAAY,CAAC,eAAe,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;aAChE;SACF;QAED,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE;YAC1B,qBAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1C;QAED,qBAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,yCAAkB,EAAE,CAAC,CAAC;QAC/C,qBAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,6CAAoB,EAAE,CAAC,CAAC;QAEjD,IAAI,UAAU,EAAE;YACd,qBAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,yBAAY,EAAE,CAAC,CAAC;SAC1C;IACH,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB;QACzB,IAAI;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,uBAAW,CAAC,cAAc,CAAuB,CAAC;YACjG,MAAM,aAAa,GAAW,cAAc,IAAI,IAAA,wBAAkB,GAAE,CAAC;YACrE,OAAO,IAAA,uBAAW,EAAC,aAAa,CAAC,CAAC,SAAS,CAAC;SAC7C;QAAC,MAAM;YACN,OAAO,CAAC,IAAI,CACV,+CAA+C,uBAAW,CAAC,cAAc,0CAA0C,CACpH,CAAC;YACF,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACI,iBAAiB,CAAC,SAAqB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAqB;QACtF,MAAM,EACJ,IAAI,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,GAC3B,GAAG,SAAS,CAAC;QAEb,YAA2B,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC1D,yBAAW,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,0BAA0B,EAAE,OAAO,SAAS,aAAa,MAAM,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AA7KD,0BA6KC","sourcesContent":["import type { App, CfnElement, StackProps } from \"aws-cdk-lib\";\nimport { Annotations, Aspects, CfnParameter, LegacyStackSynthesizer, Stack, Tags } from \"aws-cdk-lib\";\nimport type { IConstruct } from \"constructs\";\nimport gitUrlParse from \"git-url-parse\";\nimport { AwsBackupTag } from \"../../aspects/aws-backup\";\nimport { CfnIncludeReporter } from \"../../aspects/cfn-include-reporter\";\nimport { CfnParameterReporter } from \"../../aspects/cfn-parameter-reporter\";\nimport { Metadata } from \"../../aspects/metadata\";\nimport { ContextKeys, MetadataKeys, TrackingTag } from \"../../constants\";\nimport { gitRemoteOriginUrl } from \"../../utils/git\";\nimport type { StackStageIdentity } from \"./identity\";\nimport type { GuStaticLogicalId } from \"./migrating\";\n\nexport interface GuStackProps extends Omit<StackProps, \"stackName\"> {\n  /**\n   * The Guardian stack being used (as defined in your riff-raff.yaml).\n   * This will be applied as a tag to all of your resources.\n   */\n  stack: string;\n\n  /**\n   * The stage being used (as defined in your riff-raff.yaml).\n   * This will be applied as a tag to all of your resources.\n   */\n  stage: string;\n\n  /**\n   * Optional name of the app. If defined, all resources will have an App tag.\n   */\n  app?: string;\n\n  /**\n   * The AWS CloudFormation stack name (as shown in the AWS CloudFormation UI).\n   * @defaultValue the `GU_CFN_STACK_NAME` environment variable\n   */\n  cloudFormationStackName?: string;\n  /**\n   * Set this to true to stop the GuStack from tagging all of your AWS resources.\n   * This should only be turned on as part of an initial migration from CloudFormation.\n   */\n  withoutTags?: boolean;\n\n  /**\n   * Set to disable CDK metadata. Only for internal use (for disabling for some\n   * snapshot tests). We rely on tracking data to prioritise future work so\n   * please do not override this.\n   */\n  withoutMetadata?: boolean;\n\n  /**\n   * Set to enable all resources in the stack for backup provided by https://github.com/guardian/aws-backup.\n   *\n   * @default false - backups are not enabled\n   *\n   * @see https://github.com/guardian/aws-backup\n   */\n  withBackup?: boolean;\n}\n\n/**\n * GuStack provides the `stack` and `stage` parameters to a template.\n * It also takes the `app` in the constructor.\n *\n * GuStack will add the Stack, Stage and App tags to all resources.\n *\n * GuStack also adds the tag `X-Gu-CDK-Version`.\n * This tag allows us to measure adoption of this library.\n * It's value is the version of guardian/cdk being used, as defined in `package.json`.\n * As a result, the change sets between version numbers will be fairly noisy,\n * as all resources receive a tag update.\n * It is recommended to upgrade the version of @guardian/cdk being used in two steps:\n *   1. Bump the library, apply the tag updates\n *   2. Make any other stack changes\n *\n * Typical usage is to extend GuStack:\n *\n * ```typescript\n * class MyStack extends GuStack {\n *   constructor(scope: App, id: string, props: GuStackProps) {\n *     super(scope, id, props)\n *   }\n *\n *   // add resources here\n * }\n * ```\n */\nexport class GuStack extends Stack implements StackStageIdentity {\n  public readonly stack: string;\n  public readonly stage: string;\n  public readonly app: string | undefined;\n\n  /**\n   * The repository name, if it can be determined from the context or the git remote origin url.\n   * If it cannot be determined from either of these sources, it will be `undefined`.\n   */\n  public readonly repositoryName: string | undefined;\n\n  /**\n   * A helper function to add a tag to all resources in a stack.\n   *\n   * Note: tags will be listed in alphabetical order during synthesis.\n   *\n   * @param key the tag name\n   * @param value the value of the tag\n   * @param applyToLaunchedInstances whether or not to apply the tag to instances launched in an ASG.\n   * @protected\n   */\n  protected addTag(key: string, value: string, applyToLaunchedInstances: boolean = true): void {\n    // TODO add validation for `key` and `value`\n    //  see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html\n    Tags.of(this).add(key, value, { applyToLaunchedInstances });\n  }\n\n  /**\n   * Returns all the parameters on this stack.\n   *\n   * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html\n   */\n  get parameters(): Record<string, CfnParameter> {\n    return this.node\n      .findAll()\n      .filter((construct) => construct instanceof CfnParameter)\n      .reduce((acc, param) => ({ ...acc, [param.node.id]: param as CfnParameter }), {});\n  }\n\n  // eslint-disable-next-line custom-rules/valid-constructors -- GuStack is the exception as it must take an App\n  constructor(scope: App, id: string, props: GuStackProps) {\n    const {\n      cloudFormationStackName = process.env.GU_CFN_STACK_NAME,\n      stack,\n      stage,\n      app,\n      withoutTags,\n      withBackup = false,\n    } = props;\n\n    super(scope, id, {\n      ...props,\n      stackName: cloudFormationStackName,\n\n      // TODO Use `DefaultStackSynthesizer` or create own synthesizer?\n      //  see https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html#bootstrapping-custom-synth\n      synthesizer: new LegacyStackSynthesizer(),\n    });\n\n    this.stack = stack;\n    this.stage = stage.toUpperCase();\n    this.app = app;\n    this.repositoryName = this.tryGetRepositoryTag();\n\n    if (!withoutTags) {\n      this.addTag(TrackingTag.Key, TrackingTag.Value);\n\n      this.addTag(\"Stack\", this.stack);\n      this.addTag(\"Stage\", this.stage);\n      if (this.app) {\n        this.addTag(\"App\", this.app);\n      }\n\n      if (this.repositoryName) {\n        this.addTag(MetadataKeys.REPOSITORY_NAME, this.repositoryName);\n      }\n    }\n\n    if (!props.withoutMetadata) {\n      Aspects.of(this).add(new Metadata(this));\n    }\n\n    Aspects.of(this).add(new CfnIncludeReporter());\n    Aspects.of(this).add(new CfnParameterReporter());\n\n    if (withBackup) {\n      Aspects.of(this).add(new AwsBackupTag());\n    }\n  }\n\n  /**\n   * Returns the repository name.\n   * The value is retrieved in the following order:\n   *   1. From the context\n   *   2. From git config\n   *\n   * @private\n   */\n  private tryGetRepositoryTag(): string | undefined {\n    try {\n      const urlFromContext = this.node.tryGetContext(ContextKeys.REPOSITORY_URL) as string | undefined;\n      const repositoryUrl: string = urlFromContext ?? gitRemoteOriginUrl();\n      return gitUrlParse(repositoryUrl).full_name;\n    } catch {\n      console.info(\n        `Unable to find git repository name. Set the ${ContextKeys.REPOSITORY_URL} context value or configure a git remote`,\n      );\n      return undefined;\n    }\n  }\n\n  /**\n   * Override the auto-generated logical ID for a resource, in the generated CloudFormation template, with a static one.\n   *\n   * Of particular use when migrating a JSON/YAML CloudFormation template into GuCDK.\n   * It's generally advised to retain the logical ID for stateful resources, such as databases or buckets.\n   *\n   * Let's say we have a YAML template:\n   *\n   * ```yaml\n   * AWSTemplateFormatVersion: '2010-09-09'\n   * Resources:\n   *   UsesTable:\n   *     Type: AWS::DynamoDB::Table\n   *     Properties:\n   *       TableName: !Sub 'users-${stage}'\n   * ```\n   *\n   * When moving to GuCDK we'll have this:\n   *\n   * class MyStack extends GuStack {\n   *   constructor(app: App, id: string, props: GuStackProps) {\n   *     super(app, id, props);\n   *\n   *     const { stage } = this;\n   *\n   *     new Table(this, \"UsersTable\", {\n   *       name: `users-${stage}`\n   *     });\n   *   }\n   * }\n   *\n   * During synthesis, CDK auto-generates logical IDs, so we'll have a stack with a DynamoDB table named 'UsersTable<SOME GUID>', NOT `UsersTable`.\n   * That is, the `UsersTable` table will be deleted.\n   *\n   * In order to retain the original ID from the YAML template, we will do:\n   *\n   * class MyStack extends GuStack {\n   *   constructor(app: App, id: string, props: GuStackProps) {\n   *     super(app, id, props);\n   *\n   *     const { stage } = this;\n   *\n   *     const table = new Table(this, \"UsersTable\", {\n   *       name: `users-${stage}`\n   *     });\n   *\n   *     this.overrideLogicalId(table, { logicalId: \"UsersTable\", reason: \"Retaining a stateful resource from the YAML template\" });\n   *   }\n   * }\n   *\n   * @param construct The (stateful) resource to retain the logical ID of.\n   * @param logicalId The logical ID of the resource (as defined in the JSON/YAML template.\n   * @param reason A small explanation to keep the logical ID. Mainly used to help future developers.\n   */\n  public overrideLogicalId(construct: IConstruct, { logicalId, reason }: GuStaticLogicalId): void {\n    const {\n      node: { id, defaultChild },\n    } = construct;\n\n    (defaultChild as CfnElement).overrideLogicalId(logicalId);\n    Annotations.of(construct).addInfo(`Setting logical ID for ${id} to ${logicalId}. Reason: ${reason}`);\n  }\n}\n"]}
+{"version":3,"file":"stack.js","sourceRoot":"","sources":["../../../src/constructs/core/stack.ts"],"names":[],"mappings":";;;;;;AACA,6CAAsG;AAEtG,kEAAwC;AACxC,6EAAwE;AACxE,iFAA4E;AAC5E,qDAAkD;AAClD,+CAAyE;AACzE,yCAAqD;AAyCrD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,OAAQ,SAAQ,mBAAK;IAWhC;;;;;;;;;OASG;IACO,MAAM,CAAC,GAAW,EAAE,KAAa,EAAE,2BAAoC,IAAI;QACnF,4CAA4C;QAC5C,wGAAwG;QACxG,kBAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,wBAAwB,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,IAAI;aACb,OAAO,EAAE;aACT,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,YAAY,0BAAY,CAAC;aACxD,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,KAAqB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,8GAA8G;IAC9G,YAAY,KAAU,EAAE,EAAU,EAAE,KAAmB;QACrD,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;QAE1G,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE;YACf,GAAG,KAAK;YACR,SAAS,EAAE,uBAAuB;YAElC,gEAAgE;YAChE,8FAA8F;YAC9F,WAAW,EAAE,IAAI,oCAAsB,EAAE;SAC1C,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEjD,IAAI,CAAC,WAAW,EAAE;YAChB,IAAI,CAAC,MAAM,CAAC,uBAAW,CAAC,GAAG,EAAE,uBAAW,CAAC,KAAK,CAAC,CAAC;YAEhD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,IAAI,IAAI,CAAC,GAAG,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;aAC9B;YAED,IAAI,IAAI,CAAC,cAAc,EAAE;gBACvB,IAAI,CAAC,MAAM,CAAC,wBAAY,CAAC,eAAe,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;aAChE;SACF;QAED,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE;YAC1B,qBAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1C;QAED,qBAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,yCAAkB,EAAE,CAAC,CAAC;QAC/C,qBAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,6CAAoB,EAAE,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB;QACzB,IAAI;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,uBAAW,CAAC,cAAc,CAAuB,CAAC;YACjG,MAAM,aAAa,GAAW,cAAc,IAAI,IAAA,wBAAkB,GAAE,CAAC;YACrE,OAAO,IAAA,uBAAW,EAAC,aAAa,CAAC,CAAC,SAAS,CAAC;SAC7C;QAAC,MAAM;YACN,OAAO,CAAC,IAAI,CACV,+CAA+C,uBAAW,CAAC,cAAc,0CAA0C,CACpH,CAAC;YACF,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACI,iBAAiB,CAAC,SAAqB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAqB;QACtF,MAAM,EACJ,IAAI,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,GAC3B,GAAG,SAAS,CAAC;QAEb,YAA2B,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC1D,yBAAW,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,0BAA0B,EAAE,OAAO,SAAS,aAAa,MAAM,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAlKD,0BAkKC","sourcesContent":["import type { App, CfnElement, StackProps } from \"aws-cdk-lib\";\nimport { Annotations, Aspects, CfnParameter, LegacyStackSynthesizer, Stack, Tags } from \"aws-cdk-lib\";\nimport type { IConstruct } from \"constructs\";\nimport gitUrlParse from \"git-url-parse\";\nimport { CfnIncludeReporter } from \"../../aspects/cfn-include-reporter\";\nimport { CfnParameterReporter } from \"../../aspects/cfn-parameter-reporter\";\nimport { Metadata } from \"../../aspects/metadata\";\nimport { ContextKeys, MetadataKeys, TrackingTag } from \"../../constants\";\nimport { gitRemoteOriginUrl } from \"../../utils/git\";\nimport type { StackStageIdentity } from \"./identity\";\nimport type { GuStaticLogicalId } from \"./migrating\";\n\nexport interface GuStackProps extends Omit<StackProps, \"stackName\"> {\n  /**\n   * The Guardian stack being used (as defined in your riff-raff.yaml).\n   * This will be applied as a tag to all of your resources.\n   */\n  stack: string;\n\n  /**\n   * The stage being used (as defined in your riff-raff.yaml).\n   * This will be applied as a tag to all of your resources.\n   */\n  stage: string;\n\n  /**\n   * Optional name of the app. If defined, all resources will have an App tag.\n   */\n  app?: string;\n\n  /**\n   * The AWS CloudFormation stack name (as shown in the AWS CloudFormation UI).\n   * @defaultValue the `GU_CFN_STACK_NAME` environment variable\n   */\n  cloudFormationStackName?: string;\n  /**\n   * Set this to true to stop the GuStack from tagging all of your AWS resources.\n   * This should only be turned on as part of an initial migration from CloudFormation.\n   */\n  withoutTags?: boolean;\n\n  /**\n   * Set to disable CDK metadata. Only for internal use (for disabling for some\n   * snapshot tests). We rely on tracking data to prioritise future work so\n   * please do not override this.\n   */\n  withoutMetadata?: boolean;\n}\n\n/**\n * GuStack provides the `stack` and `stage` parameters to a template.\n * It also takes the `app` in the constructor.\n *\n * GuStack will add the Stack, Stage and App tags to all resources.\n *\n * GuStack also adds the tag `X-Gu-CDK-Version`.\n * This tag allows us to measure adoption of this library.\n * It's value is the version of guardian/cdk being used, as defined in `package.json`.\n * As a result, the change sets between version numbers will be fairly noisy,\n * as all resources receive a tag update.\n * It is recommended to upgrade the version of @guardian/cdk being used in two steps:\n *   1. Bump the library, apply the tag updates\n *   2. Make any other stack changes\n *\n * Typical usage is to extend GuStack:\n *\n * ```typescript\n * class MyStack extends GuStack {\n *   constructor(scope: App, id: string, props: GuStackProps) {\n *     super(scope, id, props)\n *   }\n *\n *   // add resources here\n * }\n * ```\n */\nexport class GuStack extends Stack implements StackStageIdentity {\n  public readonly stack: string;\n  public readonly stage: string;\n  public readonly app: string | undefined;\n\n  /**\n   * The repository name, if it can be determined from the context or the git remote origin url.\n   * If it cannot be determined from either of these sources, it will be `undefined`.\n   */\n  public readonly repositoryName: string | undefined;\n\n  /**\n   * A helper function to add a tag to all resources in a stack.\n   *\n   * Note: tags will be listed in alphabetical order during synthesis.\n   *\n   * @param key the tag name\n   * @param value the value of the tag\n   * @param applyToLaunchedInstances whether or not to apply the tag to instances launched in an ASG.\n   * @protected\n   */\n  protected addTag(key: string, value: string, applyToLaunchedInstances: boolean = true): void {\n    // TODO add validation for `key` and `value`\n    //  see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html\n    Tags.of(this).add(key, value, { applyToLaunchedInstances });\n  }\n\n  /**\n   * Returns all the parameters on this stack.\n   *\n   * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html\n   */\n  get parameters(): Record<string, CfnParameter> {\n    return this.node\n      .findAll()\n      .filter((construct) => construct instanceof CfnParameter)\n      .reduce((acc, param) => ({ ...acc, [param.node.id]: param as CfnParameter }), {});\n  }\n\n  // eslint-disable-next-line custom-rules/valid-constructors -- GuStack is the exception as it must take an App\n  constructor(scope: App, id: string, props: GuStackProps) {\n    const { cloudFormationStackName = process.env.GU_CFN_STACK_NAME, stack, stage, app, withoutTags } = props;\n\n    super(scope, id, {\n      ...props,\n      stackName: cloudFormationStackName,\n\n      // TODO Use `DefaultStackSynthesizer` or create own synthesizer?\n      //  see https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html#bootstrapping-custom-synth\n      synthesizer: new LegacyStackSynthesizer(),\n    });\n\n    this.stack = stack;\n    this.stage = stage.toUpperCase();\n    this.app = app;\n    this.repositoryName = this.tryGetRepositoryTag();\n\n    if (!withoutTags) {\n      this.addTag(TrackingTag.Key, TrackingTag.Value);\n\n      this.addTag(\"Stack\", this.stack);\n      this.addTag(\"Stage\", this.stage);\n      if (this.app) {\n        this.addTag(\"App\", this.app);\n      }\n\n      if (this.repositoryName) {\n        this.addTag(MetadataKeys.REPOSITORY_NAME, this.repositoryName);\n      }\n    }\n\n    if (!props.withoutMetadata) {\n      Aspects.of(this).add(new Metadata(this));\n    }\n\n    Aspects.of(this).add(new CfnIncludeReporter());\n    Aspects.of(this).add(new CfnParameterReporter());\n  }\n\n  /**\n   * Returns the repository name.\n   * The value is retrieved in the following order:\n   *   1. From the context\n   *   2. From git config\n   *\n   * @private\n   */\n  private tryGetRepositoryTag(): string | undefined {\n    try {\n      const urlFromContext = this.node.tryGetContext(ContextKeys.REPOSITORY_URL) as string | undefined;\n      const repositoryUrl: string = urlFromContext ?? gitRemoteOriginUrl();\n      return gitUrlParse(repositoryUrl).full_name;\n    } catch {\n      console.info(\n        `Unable to find git repository name. Set the ${ContextKeys.REPOSITORY_URL} context value or configure a git remote`,\n      );\n      return undefined;\n    }\n  }\n\n  /**\n   * Override the auto-generated logical ID for a resource, in the generated CloudFormation template, with a static one.\n   *\n   * Of particular use when migrating a JSON/YAML CloudFormation template into GuCDK.\n   * It's generally advised to retain the logical ID for stateful resources, such as databases or buckets.\n   *\n   * Let's say we have a YAML template:\n   *\n   * ```yaml\n   * AWSTemplateFormatVersion: '2010-09-09'\n   * Resources:\n   *   UsesTable:\n   *     Type: AWS::DynamoDB::Table\n   *     Properties:\n   *       TableName: !Sub 'users-${stage}'\n   * ```\n   *\n   * When moving to GuCDK we'll have this:\n   *\n   * class MyStack extends GuStack {\n   *   constructor(app: App, id: string, props: GuStackProps) {\n   *     super(app, id, props);\n   *\n   *     const { stage } = this;\n   *\n   *     new Table(this, \"UsersTable\", {\n   *       name: `users-${stage}`\n   *     });\n   *   }\n   * }\n   *\n   * During synthesis, CDK auto-generates logical IDs, so we'll have a stack with a DynamoDB table named 'UsersTable<SOME GUID>', NOT `UsersTable`.\n   * That is, the `UsersTable` table will be deleted.\n   *\n   * In order to retain the original ID from the YAML template, we will do:\n   *\n   * class MyStack extends GuStack {\n   *   constructor(app: App, id: string, props: GuStackProps) {\n   *     super(app, id, props);\n   *\n   *     const { stage } = this;\n   *\n   *     const table = new Table(this, \"UsersTable\", {\n   *       name: `users-${stage}`\n   *     });\n   *\n   *     this.overrideLogicalId(table, { logicalId: \"UsersTable\", reason: \"Retaining a stateful resource from the YAML template\" });\n   *   }\n   * }\n   *\n   * @param construct The (stateful) resource to retain the logical ID of.\n   * @param logicalId The logical ID of the resource (as defined in the JSON/YAML template.\n   * @param reason A small explanation to keep the logical ID. Mainly used to help future developers.\n   */\n  public overrideLogicalId(construct: IConstruct, { logicalId, reason }: GuStaticLogicalId): void {\n    const {\n      node: { id, defaultChild },\n    } = construct;\n\n    (defaultChild as CfnElement).overrideLogicalId(logicalId);\n    Annotations.of(construct).addInfo(`Setting logical ID for ${id} to ${logicalId}. Reason: ${reason}`);\n  }\n}\n"]}

package/lib/constructs/dynamodb/dynamodb.d.ts

@@ -0,0 +1,31 @@
+import { Table } from "aws-cdk-lib/aws-dynamodb";
+import type { TableProps } from "aws-cdk-lib/aws-dynamodb";
+import type { GuStack } from "../core";
+export interface OptIn {
+    enabled: true;
+}
+export interface OptOut {
+    enabled: false;
+    /**
+     * We recommend using DevX Backups where possible. If it is not suitable for your use-case please document
+     * this here so that we can understand why this is switched off when performing security audits.
+     */
+    optOutReason: string;
+}
+export interface GuDynamoTableProps extends TableProps {
+    /**
+     * We recommend using DevX Backups to protect your DynamoDB table's backups.
+     * For more details on this feature, see the
+     * [documentation](https://docs.google.com/document/d/11EZtuVHCnjavE9AYLroiuDUsMzbp2ulFBtj4VkyCKNc/edit?usp=sharing).
+     */
+    devXBackups: OptIn | OptOut;
+}
+/**
+ * DeletionProtection is enabled by default for this Table.
+ * We recommend enabling this enabled for all active DynamoDB tables.
+ * The default can be overridden in the GuDynamoTable instantiation if needed eg: for table deletion.
+ */
+export declare class GuDynamoTable extends Table {
+    constructor(scope: GuStack, id: string, props: GuDynamoTableProps);
+}
+//# sourceMappingURL=dynamodb.d.ts.map

package/lib/constructs/dynamodb/dynamodb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dynamodb.d.ts","sourceRoot":"","sources":["../../../src/constructs/dynamodb/dynamodb.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC,MAAM,WAAW,KAAK;IACpB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,MAAM;IACrB,OAAO,EAAE,KAAK,CAAC;IACf;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;;;OAIG;IACH,WAAW,EAAE,KAAK,GAAG,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB;CAIlE"}

package/lib/constructs/dynamodb/dynamodb.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GuDynamoTable = void 0;
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const aws_dynamodb_1 = require("aws-cdk-lib/aws-dynamodb");
+/**
+ * DeletionProtection is enabled by default for this Table.
+ * We recommend enabling this enabled for all active DynamoDB tables.
+ * The default can be overridden in the GuDynamoTable instantiation if needed eg: for table deletion.
+ */
+class GuDynamoTable extends aws_dynamodb_1.Table {
+    constructor(scope, id, props) {
+        super(scope, id, { deletionProtection: true, ...props });
+        aws_cdk_lib_1.Tags.of(this).add("devx-backup-enabled", String(props.devXBackups.enabled));
+    }
+}
+exports.GuDynamoTable = GuDynamoTable;
+//# sourceMappingURL=dynamodb.js.map

package/lib/constructs/dynamodb/dynamodb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dynamodb.js","sourceRoot":"","sources":["../../../src/constructs/dynamodb/dynamodb.ts"],"names":[],"mappings":";;;AAAA,6CAAmC;AACnC,2DAAiD;AA0BjD;;;;GAIG;AACH,MAAa,aAAc,SAAQ,oBAAK;IACtC,YAAY,KAAc,EAAE,EAAU,EAAE,KAAyB;QAC/D,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;QACzD,kBAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9E,CAAC;CACF;AALD,sCAKC","sourcesContent":["import { Tags } from \"aws-cdk-lib\";\nimport { Table } from \"aws-cdk-lib/aws-dynamodb\";\nimport type { TableProps } from \"aws-cdk-lib/aws-dynamodb\";\nimport type { GuStack } from \"../core\";\n\nexport interface OptIn {\n  enabled: true;\n}\n\nexport interface OptOut {\n  enabled: false;\n  /**\n   * We recommend using DevX Backups where possible. If it is not suitable for your use-case please document\n   * this here so that we can understand why this is switched off when performing security audits.\n   */\n  optOutReason: string;\n}\n\nexport interface GuDynamoTableProps extends TableProps {\n  /**\n   * We recommend using DevX Backups to protect your DynamoDB table's backups.\n   * For more details on this feature, see the\n   * [documentation](https://docs.google.com/document/d/11EZtuVHCnjavE9AYLroiuDUsMzbp2ulFBtj4VkyCKNc/edit?usp=sharing).\n   */\n  devXBackups: OptIn | OptOut;\n}\n\n/**\n * DeletionProtection is enabled by default for this Table.\n * We recommend enabling this enabled for all active DynamoDB tables.\n * The default can be overridden in the GuDynamoTable instantiation if needed eg: for table deletion.\n */\nexport class GuDynamoTable extends Table {\n  constructor(scope: GuStack, id: string, props: GuDynamoTableProps) {\n    super(scope, id, { deletionProtection: true, ...props });\n    Tags.of(this).add(\"devx-backup-enabled\", String(props.devXBackups.enabled));\n  }\n}\n"]}

package/lib/constructs/dynamodb/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./dynamodb";
+//# sourceMappingURL=index.d.ts.map

package/lib/constructs/dynamodb/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/constructs/dynamodb/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}

package/lib/constructs/dynamodb/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./dynamodb"), exports);
+//# sourceMappingURL=index.js.map

package/lib/constructs/dynamodb/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/constructs/dynamodb/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B","sourcesContent":["export * from \"./dynamodb\";\n"]}