@guardian/cdk 59.5.0 → 59.5.1

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

@@ -1,6 +1,18 @@
+import { Duration } from "aws-cdk-lib";
 import type { GuStack } from "../../constructs/core";
 import type { GuEc2AppProps } from "../../patterns";
 import { GuEc2App } from "../../patterns";
+interface AutoScalingRollingUpdateDurations {
+    /**
+     * The time between each check of an instance's health within the target group.
+     */
+    sleep: Duration;
+    /**
+     * Additional time to cover the time spent polling an instance's health within the target group before sending the CloudFormation signal.
+     */
+    buffer: Duration;
+}
+export declare const RollingUpdateDurations: AutoScalingRollingUpdateDurations;
 export interface GuEc2AppExperimentalProps extends Omit<GuEc2AppProps, "updatePolicy"> {
 }
 /**
@@ -40,4 +52,5 @@ export interface GuEc2AppExperimentalProps extends Omit<GuEc2AppProps, "updatePo
 export declare class GuEc2AppExperimental extends GuEc2App {
     constructor(scope: GuStack, props: GuEc2AppExperimentalProps);
 }
+export {};
 //# sourceMappingURL=ec2-app.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ec2-app.d.ts","sourceRoot":"","sources":["../../../src/experimental/patterns/ec2-app.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAmN1C,MAAM,WAAW,yBAA0B,SAAQ,IAAI,CAAC,aAAa,EAAE,cAAc,CAAC;CAAG;AAEzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,oBAAqB,SAAQ,QAAQ;gBACpC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,yBAAyB;CAoF7D"}
+{"version":3,"file":"ec2-app.d.ts","sourceRoot":"","sources":["../../../src/experimental/patterns/ec2-app.ts"],"names":[],"mappings":"AACA,OAAO,EAAyB,QAAQ,EAAE,MAAM,aAAa,CAAC;AAK9D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C,UAAU,iCAAiC;IACzC;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED,eAAO,MAAM,sBAAsB,EAAE,iCAGpC,CAAC;AAiNF,MAAM,WAAW,yBAA0B,SAAQ,IAAI,CAAC,aAAa,EAAE,cAAc,CAAC;CAAG;AAEzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,oBAAqB,SAAQ,QAAQ;gBACpC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,yBAAyB;CAoF7D"}

package/lib/experimental/patterns/ec2-app.js

@@ -1,16 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GuEc2AppExperimental = void 0;
+exports.GuEc2AppExperimental = exports.RollingUpdateDurations = void 0;
 const aws_cdk_lib_1 = require("aws-cdk-lib");
 const aws_autoscaling_1 = require("aws-cdk-lib/aws-autoscaling");
 const aws_iam_1 = require("aws-cdk-lib/aws-iam");
 const autoscaling_1 = require("../../constructs/autoscaling");
 const patterns_1 = require("../../patterns");
 const singleton_1 = require("../../utils/singleton");
+exports.RollingUpdateDurations = {
+    sleep: aws_cdk_lib_1.Duration.seconds(5),
+    buffer: aws_cdk_lib_1.Duration.minutes(1),
+};
 /**
  * Ensures the `AutoScalingRollingUpdate` of an AutoScaling Group has a `PauseTime` matching the healthcheck grace period.
  * It also ensures the `CreationPolicy` resource signal `Timeout` matches the healthcheck grace period.
  *
+ * @internal
+ *
  * @privateRemarks
  * The ASG healthcheck grace period is hard-coded by {@link GuEc2App}.
  * Customisation of this value is performed via an escape hatch.
@@ -32,14 +38,10 @@ class AutoScalingRollingUpdateTimeout {
         if (construct instanceof aws_autoscaling_1.CfnAutoScalingGroup) {
             const currentRollingUpdate = construct.cfnOptions.updatePolicy?.autoScalingRollingUpdate;
             const currentCreationPolicy = construct.cfnOptions.creationPolicy;
-            /**
-             * The type of `healthCheckGracePeriod` is `number | undefined`.
-             * In reality, it will always be set as we set it in {@link GuEc2App}.
-             * The right-hand side to appease the compiler; 5 minutes is the default value used by AWS.
-             *
-             * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate-pausetime
-             */
-            const signalTimeoutSeconds = construct.healthCheckGracePeriod ?? aws_cdk_lib_1.Duration.minutes(5).toSeconds();
+            if (!construct.healthCheckGracePeriod) {
+                throw new Error(`The healthcheck grace period not set for autoscaling group ${construct.node.id}.`);
+            }
+            const signalTimeoutSeconds = construct.healthCheckGracePeriod + exports.RollingUpdateDurations.buffer.toSeconds();
             if (currentRollingUpdate) {
                 construct.cfnOptions.updatePolicy = {
                     autoScalingRollingUpdate: {
@@ -262,7 +264,7 @@ class GuEc2AppExperimental extends patterns_1.GuEc2App {
 
       until [ "$STATE" == "\\"healthy\\"" ]; do
         echo "Instance not yet healthy within target group. Current state $STATE. Sleeping..."
-        sleep 5
+        sleep ${exports.RollingUpdateDurations.sleep.toSeconds()}
         STATE=$(aws elbv2 describe-target-health \
           --target-group-arn ${targetGroup.targetGroupArn} \
           --region ${region} \

package/lib/experimental/patterns/ec2-app.js.map

@@ -1 +1 @@
-{"version":3,"file":"ec2-app.js","sourceRoot":"","sources":["../../../src/experimental/patterns/ec2-app.ts"],"names":[],"mappings":";;;AACA,6CAA8D;AAC9D,iEAAkH;AAClH,iDAAsE;AAEtE,8DAAkE;AAGlE,6CAA0C;AAC1C,qDAAkE;AAElE;;;;;;;;;;GAUG;AACH,MAAM,+BAA+B;IAInC,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,+BAA+B,CAAC,KAAK,CAAC,CAAC;SAC5D;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,SAAqB;QAChC,IAAI,SAAS,YAAY,qCAAmB,EAAE;YAC5C,MAAM,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,wBAAwB,CAAC;YACzF,MAAM,qBAAqB,GAAG,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC;YAElE;;;;;;eAMG;YACH,MAAM,oBAAoB,GAAG,SAAS,CAAC,sBAAsB,IAAI,sBAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;YAEjG,IAAI,oBAAoB,EAAE;gBACxB,SAAS,CAAC,UAAU,CAAC,YAAY,GAAG;oBAClC,wBAAwB,EAAE;wBACxB,GAAG,oBAAoB;wBACvB,SAAS,EAAE,sBAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE;qBAChE;iBACF,CAAC;aACH;YAED,IAAI,qBAAqB,EAAE;gBACzB,SAAS,CAAC,UAAU,CAAC,cAAc,GAAG;oBACpC,GAAG,qBAAqB;oBACxB,cAAc,EAAE;wBACd,GAAG,qBAAqB,CAAC,cAAc;wBACvC,OAAO,EAAE,sBAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE;qBAC9D;iBACF,CAAC;aACH;SACF;IACH,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,uCAAuC;IAK3C,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,uCAAuC,CAAC,KAAK,CAAC,CAAC;SACpE;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,SAAqB;QAChC,IAAI,SAAS,YAAY,kCAAgB,EAAE;YACzC,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;YAC3B,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAE9B;;;;;;;;;;;;;eAaG;YACH,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAA2B,EAAE,CAAC,CAAC,YAAY,gCAAkB,CAAC,CAAC;YAEtG,IAAI,CAAC,gBAAgB,EAAE;gBACrB,MAAM,IAAI,KAAK,CACb,iFAAiF,IAAI,wDAAwD,CAC9I,CAAC;aACH;YAED,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;YACtF,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,UAAU,CAAC,YAAY,EAAE,wBAAwB,CAAC;YAEnG,IAAI,oBAAoB,EAAE;gBACxB;;;;mBAIG;gBACH,mBAAmB,CAAC,eAAe,GAAG,SAAS,CAAC;gBAEhD,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAE3C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;oBACtC,IAAI,CAAC,aAAa,CAAC,GAAG,CACpB,SAAS,EACT,IAAI,0BAAY,CAAC,IAAI,CAAC,KAAK,EAAE,2BAA2B,gBAAgB,CAAC,GAAG,EAAE,EAAE;wBAC9E,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC;wBAC9C,QAAQ,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC;qBACpD,CAAC,CACH,CAAC;iBACH;gBAED,MAAM,qBAAqB,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;gBAEjE,mBAAmB,CAAC,UAAU,CAAC,YAAY,GAAG;oBAC5C,wBAAwB,EAAE;wBACxB,GAAG,oBAAoB;wBACvB,qBAAqB,EAAE,qBAAqB,CAAC,aAAa;qBAC3D;iBACF,CAAC;aACH;SACF;IACH,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,sBAAuB,SAAQ,gBAAM;IAGzC,YAAoB,KAAc;QAChC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAE1B,KAAK,CAAC,KAAK,EAAE,wBAAwB,EAAE;YACrC,UAAU,EAAE;gBACV,uCAAuC;gBACvC,IAAI,yBAAe,CAAC;oBAClB,OAAO,EAAE,CAAC,+BAA+B,CAAC;oBAC1C,MAAM,EAAE,gBAAM,CAAC,KAAK;oBACpB,SAAS,EAAE,CAAC,OAAO,CAAC;iBACrB,CAAC;gBAEF;;;;mBAIG;gBACH,IAAI,yBAAe,CAAC;oBAClB,OAAO,EAAE,CAAC,2CAA2C,CAAC;oBACtD,MAAM,EAAE,gBAAM,CAAC,KAAK;oBACpB,SAAS,EAAE,CAAC,GAAG,CAAC;iBACjB,CAAC;aACH;SACF,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;SACnD;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,oBAAqB,SAAQ,mBAAQ;IAChD,YAAY,KAAc,EAAE,KAAgC;QAC1D,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC;QACpF,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;QAClC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAElC,KAAK,CAAC,KAAK,EAAE;YACX,GAAG,KAAK;YACR,YAAY,EAAE,8BAAY,CAAC,aAAa,CAAC;gBACvC,YAAY,EAAE,gBAAgB;gBAC9B,qBAAqB,EAAE,gBAAgB;gBACvC,oBAAoB,EAAE,GAAG;gBACzB,qBAAqB,EAAE,IAAI;gBAE3B;;;;;mBAKG;gBACH,gBAAgB,EAAE,CAAC,gCAAc,CAAC,kBAAkB,CAAC;aACtD,CAAC;SACH,CAAC,CAAC;QAEH,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAC/C,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC;QAC5C,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;QAEtF,mBAAmB,CAAC,eAAe,GAAG,gBAAgB,CAAC,QAAQ,EAAE,CAAC;QAElE,mBAAmB,CAAC,UAAU,CAAC,cAAc,GAAG;YAC9C,yBAAyB,EAAE;gBACzB,6BAA6B,EAAE,GAAG;aACnC;YACD,cAAc,EAAE;gBACd,KAAK,EAAE,gBAAgB;aACxB;SACF,CAAC;QAEF,sBAAsB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAE7D;;;WAGG;QACH,QAAQ,CAAC,WAAW,CAClB,KAAK,oBAAoB,CAAC,IAAI,iBAAiB,EAC/C;;;;;6BAKuB,WAAW,CAAC,cAAc;mBACpC,MAAM;yCACgB,eAAe;;;;;;;+BAOzB,WAAW,CAAC,cAAc;qBACpC,MAAM;2CACgB,eAAe;;;;;OAKnD,EACD,KAAK,oBAAoB,CAAC,IAAI,eAAe,CAC9C,CAAC;QAEF,QAAQ,CAAC,iBAAiB,CACxB;6BACuB,OAAO;uBACb,mBAAmB,CAAC,SAAS;qBAC/B,MAAM;;SAElB,CACJ,CAAC;QAEF,oFAAoF;QACpF,qBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,+BAA+B,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,qBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,uCAAuC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACpF,CAAC;CACF;AArFD,oDAqFC","sourcesContent":["import type { IAspect } from \"aws-cdk-lib\";\nimport { Aspects, CfnParameter, Duration } from \"aws-cdk-lib\";\nimport { CfnAutoScalingGroup, CfnScalingPolicy, ScalingProcess, UpdatePolicy } from \"aws-cdk-lib/aws-autoscaling\";\nimport { Effect, Policy, PolicyStatement } from \"aws-cdk-lib/aws-iam\";\nimport type { IConstruct } from \"constructs\";\nimport { GuAutoScalingGroup } from \"../../constructs/autoscaling\";\nimport type { GuStack } from \"../../constructs/core\";\nimport type { GuEc2AppProps } from \"../../patterns\";\nimport { GuEc2App } from \"../../patterns\";\nimport { isSingletonPresentInStack } from \"../../utils/singleton\";\n\n/**\n * Ensures the `AutoScalingRollingUpdate` of an AutoScaling Group has a `PauseTime` matching the healthcheck grace period.\n * It also ensures the `CreationPolicy` resource signal `Timeout` matches the healthcheck grace period.\n *\n * @privateRemarks\n * The ASG healthcheck grace period is hard-coded by {@link GuEc2App}.\n * Customisation of this value is performed via an escape hatch.\n * An `Aspect` is the only way to observe any customisation.\n *\n * TODO Expose the healthcheck grace period as a property on {@link GuEc2App} and remove this `Aspect`.\n */\nclass AutoScalingRollingUpdateTimeout implements IAspect {\n  public readonly stack: GuStack;\n  private static instance: AutoScalingRollingUpdateTimeout | undefined;\n\n  private constructor(scope: GuStack) {\n    this.stack = scope;\n  }\n\n  public static getInstance(stack: GuStack): AutoScalingRollingUpdateTimeout {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new AutoScalingRollingUpdateTimeout(stack);\n    }\n    return this.instance;\n  }\n\n  public visit(construct: IConstruct) {\n    if (construct instanceof CfnAutoScalingGroup) {\n      const currentRollingUpdate = construct.cfnOptions.updatePolicy?.autoScalingRollingUpdate;\n      const currentCreationPolicy = construct.cfnOptions.creationPolicy;\n\n      /**\n       * The type of `healthCheckGracePeriod` is `number | undefined`.\n       * In reality, it will always be set as we set it in {@link GuEc2App}.\n       * The right-hand side to appease the compiler; 5 minutes is the default value used by AWS.\n       *\n       * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate-pausetime\n       */\n      const signalTimeoutSeconds = construct.healthCheckGracePeriod ?? Duration.minutes(5).toSeconds();\n\n      if (currentRollingUpdate) {\n        construct.cfnOptions.updatePolicy = {\n          autoScalingRollingUpdate: {\n            ...currentRollingUpdate,\n            pauseTime: Duration.seconds(signalTimeoutSeconds).toIsoString(),\n          },\n        };\n      }\n\n      if (currentCreationPolicy) {\n        construct.cfnOptions.creationPolicy = {\n          ...currentCreationPolicy,\n          resourceSignal: {\n            ...currentCreationPolicy.resourceSignal,\n            timeout: Duration.seconds(signalTimeoutSeconds).toIsoString(),\n          },\n        };\n      }\n    }\n  }\n}\n\n/**\n * An `Aspect` that adjusts the properties of an AutoScaling Group using an `AutoScalingRollingUpdate` update policy.\n *\n * It'll unset the `DesiredCapacity` of the ASG as a rolling update sets `Desired` back to the template version,\n * undoing any changes that a scale-out event may have done.\n * Having `DesiredCapacity` unset ensures the service remains at-capacity at all times.\n *\n * It'll also make the `MinInstancesInService` property dynamic via a CFN Parameter that Riff-Raff will set.\n * The value depends on the current capacity of the ASG:\n *  - If the service is running normally, it'll be set to the `MinSize` capacity\n *  - If the service is partially scaled, it'll be set to the current `DesiredCapacity`\n *  - If the service is fully scaled, it'll be set to (at least) `MaxSize` - 1\n *\n * @privateRemarks\n * - Temporarily implemented as a singleton to ensure only one instance is added to a stack,\n *   else multiple attempts to add the same CFN Parameter will be made and fail.\n * - Once out of experimental, instantiate this `Aspect` directly in {@link GuStack}.\n *\n * @see https://github.com/guardian/testing-asg-rolling-update\n */\nclass HorizontallyScalingDeploymentProperties implements IAspect {\n  public readonly stack: GuStack;\n  private readonly asgToParamMap: Map<string, CfnParameter>;\n  private static instance: HorizontallyScalingDeploymentProperties | undefined;\n\n  private constructor(scope: GuStack) {\n    this.stack = scope;\n    this.asgToParamMap = new Map();\n  }\n\n  public static getInstance(stack: GuStack): HorizontallyScalingDeploymentProperties {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new HorizontallyScalingDeploymentProperties(stack);\n    }\n\n    return this.instance;\n  }\n\n  public visit(construct: IConstruct) {\n    if (construct instanceof CfnScalingPolicy) {\n      const { node } = construct;\n      const { scopes, path } = node;\n\n      /*\n      Requiring a `CfnScalingPolicy` to be created in the scope of a `GuAutoScalingGroup`\n      is the most reliable way to associate the two together.\n\n      Though the `autoScalingGroupName` property is passed to a `CfnScalingPolicy` when instantiating,\n      this does not create a concrete link as AWS CDK sets the value to be the ASG's `Ref`.\n      That is, it is a `Token` until it is synthesised.\n      This is even if the ASG has an explicit name set.\n\n      See also:\n        - https://docs.aws.amazon.com/cdk/v2/guide/tokens.html\n        - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup-return-values\n        - https://github.com/aws/aws-cdk/blob/f6b649d47f8bc30ca741fbb7a4852d51e8275002/packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts#L1560\n       */\n      const autoScalingGroup = scopes.find((_): _ is GuAutoScalingGroup => _ instanceof GuAutoScalingGroup);\n\n      if (!autoScalingGroup) {\n        throw new Error(\n          `Failed to detect the autoscaling group relating to the scaling policy on path ${path}. Was it created in the scope of a GuAutoScalingGroup?`,\n        );\n      }\n\n      const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n      const currentRollingUpdate = cfnAutoScalingGroup.cfnOptions.updatePolicy?.autoScalingRollingUpdate;\n\n      if (currentRollingUpdate) {\n        /*\n        An autoscaling group that horizontally scales should not explicitly set `Desired`,\n        as a rolling update will set the current `Desired` back to the template version,\n        undoing any changes that a scale-out event may have done.\n         */\n        cfnAutoScalingGroup.desiredCapacity = undefined;\n\n        const asgNodeId = autoScalingGroup.node.id;\n\n        if (!this.asgToParamMap.has(asgNodeId)) {\n          this.asgToParamMap.set(\n            asgNodeId,\n            new CfnParameter(this.stack, `MinInstancesInServiceFor${autoScalingGroup.app}`, {\n              type: \"Number\",\n              default: parseInt(cfnAutoScalingGroup.minSize),\n              maxValue: parseInt(cfnAutoScalingGroup.maxSize) - 1,\n            }),\n          );\n        }\n\n        const minInstancesInService = this.asgToParamMap.get(asgNodeId)!;\n\n        cfnAutoScalingGroup.cfnOptions.updatePolicy = {\n          autoScalingRollingUpdate: {\n            ...currentRollingUpdate,\n            minInstancesInService: minInstancesInService.valueAsNumber,\n          },\n        };\n      }\n    }\n  }\n}\n\n/**\n * An IAM Policy allowing the sending of a CloudFormation signal.\n *\n * @privateRemarks\n * Implemented as a singleton as the resources can only be tightened at most to the CloudFormation stack.\n */\nclass AsgRollingUpdatePolicy extends Policy {\n  private static instance: AsgRollingUpdatePolicy | undefined;\n\n  private constructor(scope: GuStack) {\n    const { stackId } = scope;\n\n    super(scope, \"AsgRollingUpdatePolicy\", {\n      statements: [\n        // Allow usage of command `cfn-signal`.\n        new PolicyStatement({\n          actions: [\"cloudformation:SignalResource\"],\n          effect: Effect.ALLOW,\n          resources: [stackId],\n        }),\n\n        /*\n        Allow usage of command `aws elbv2 describe-target-health`.\n        AWS Elastic Load Balancing does not support resource based policies, so the resource has to be `*` (any) here.\n        See https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html\n         */\n        new PolicyStatement({\n          actions: [\"elasticloadbalancing:DescribeTargetHealth\"],\n          effect: Effect.ALLOW,\n          resources: [\"*\"],\n        }),\n      ],\n    });\n  }\n\n  public static getInstance(stack: GuStack): AsgRollingUpdatePolicy {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new AsgRollingUpdatePolicy(stack);\n    }\n\n    return this.instance;\n  }\n}\n\nexport interface GuEc2AppExperimentalProps extends Omit<GuEc2AppProps, \"updatePolicy\"> {}\n\n/**\n * An experimental pattern to instantiate an EC2 application that is updated entirely via CloudFormation.\n * It sets the update policy of the `AWS::AutoScaling::AutoScalingGroup` to `AutoScalingRollingUpdate`.\n * When a CloudFormation update is applied, the current instances in the ASG will be replaced.\n *\n * This pattern also updates the User Data, running some commands AFTER yours.\n * These changes are wrapped in start and end marking comments.\n *\n * This pattern does not enable for scaling events to trigger _during_ a deployment\n * as during testing it was found that scale-in events during deployment led to unpredictable service availability.\n *\n * If a deployment fails, for example when the healthcheck fails, CloudFormation will automatically rollback the changes.\n * This improves on the behaviour of Riff-Raff's `autoscaling` deployment which requires manual intervention on deployment failure.\n *\n * To update the application's code, a CloudFormation update must be triggered.\n * The best way to do this is to include the build number in the application artifact.\n * TODO test User Data includes a build number.\n *\n * @remarks\n * - The rate at which instances are replaced are conditional based on how scaled up the service is.\n *   The more an application is scaled, the longer it'll take to deploy.\n * - It is not necessary to use the `autoscaling` Riff-Raff deployment type in conjunction with this.\n *   Doing so won't break anything, however it'll lengthen the deployment time as instances will be rotated twice.\n *   Please remove it from any manually created `riff-raff.yaml` file.\n * - Your application should include a build number in its filename.\n *   This value will change across builds, and therefore create a CloudFormation template difference to be deployed.\n * - Requires the AWS CLI and `cfn-signal` binaries to be available on the instance, and on the `PATH`.\n *   AMIgo adds these via the `aws-tools` role.\n *\n * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate\n * @see https://github.com/guardian/testing-asg-rolling-update\n *\n * @experimental\n */\nexport class GuEc2AppExperimental extends GuEc2App {\n  constructor(scope: GuStack, props: GuEc2AppExperimentalProps) {\n    const { minimumInstances, maximumInstances = minimumInstances * 2 } = props.scaling;\n    const { applicationPort } = props;\n    const { region, stackId } = scope;\n\n    super(scope, {\n      ...props,\n      updatePolicy: UpdatePolicy.rollingUpdate({\n        maxBatchSize: maximumInstances,\n        minInstancesInService: minimumInstances,\n        minSuccessPercentage: 100,\n        waitOnResourceSignals: true,\n\n        /*\n        If a scale-in event fires during an `AutoScalingRollingUpdate` operation, the update could fail and rollback.\n        For this reason, we suspend the `AlarmNotification` process, else availability of a service cannot be guaranteed.\n        Consequently, services cannot scale-out during deployments.\n        If AWS ever supports suspending scale-out and scale-in independently, we should allow scale-out.\n         */\n        suspendProcesses: [ScalingProcess.ALARM_NOTIFICATION],\n      }),\n    });\n\n    const { autoScalingGroup, targetGroup } = this;\n    const { userData, role } = autoScalingGroup;\n    const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n\n    cfnAutoScalingGroup.desiredCapacity = minimumInstances.toString();\n\n    cfnAutoScalingGroup.cfnOptions.creationPolicy = {\n      autoScalingCreationPolicy: {\n        minSuccessfulInstancesPercent: 100,\n      },\n      resourceSignal: {\n        count: minimumInstances,\n      },\n    };\n\n    AsgRollingUpdatePolicy.getInstance(scope).attachToRole(role);\n\n    /*\n    `aws` is available via AMIgo baked AMIs.\n    See https://github.com/guardian/amigo/tree/main/roles/aws-tools.\n     */\n    userData.addCommands(\n      `# ${GuEc2AppExperimental.name} UserData Start`,\n      `\n      TOKEN=$(curl -X PUT \"http://169.254.169.254/latest/api/token\" -H \"X-aws-ec2-metadata-token-ttl-seconds: 21600\")\n      INSTANCE_ID=$(curl -H \"X-aws-ec2-metadata-token: $TOKEN\" \"http://169.254.169.254/latest/meta-data/instance-id\")\n\n      STATE=$(aws elbv2 describe-target-health \\\n        --target-group-arn ${targetGroup.targetGroupArn} \\\n        --region ${region} \\\n        --targets Id=$INSTANCE_ID,Port=${applicationPort} \\\n        --query \"TargetHealthDescriptions[0].TargetHealth.State\")\n\n      until [ \"$STATE\" == \"\\\\\"healthy\\\\\"\" ]; do\n        echo \"Instance not yet healthy within target group. Current state $STATE. Sleeping...\"\n        sleep 5\n        STATE=$(aws elbv2 describe-target-health \\\n          --target-group-arn ${targetGroup.targetGroupArn} \\\n          --region ${region} \\\n          --targets Id=$INSTANCE_ID,Port=${applicationPort} \\\n          --query \"TargetHealthDescriptions[0].TargetHealth.State\")\n      done\n\n      echo \"Instance is healthy in target group.\"\n      `,\n      `# ${GuEc2AppExperimental.name} UserData End`,\n    );\n\n    userData.addOnExitCommands(\n      `\n        cfn-signal --stack ${stackId} \\\n          --resource ${cfnAutoScalingGroup.logicalId} \\\n          --region ${region} \\\n          --exit-code $exitCode || echo 'Failed to send Cloudformation Signal'\n        `,\n    );\n\n    // TODO Once out of experimental, instantiate these `Aspect`s directly in `GuStack`.\n    Aspects.of(scope).add(AutoScalingRollingUpdateTimeout.getInstance(scope));\n    Aspects.of(scope).add(HorizontallyScalingDeploymentProperties.getInstance(scope));\n  }\n}\n"]}
+{"version":3,"file":"ec2-app.js","sourceRoot":"","sources":["../../../src/experimental/patterns/ec2-app.ts"],"names":[],"mappings":";;;AACA,6CAA8D;AAC9D,iEAAkH;AAClH,iDAAsE;AAEtE,8DAAkE;AAGlE,6CAA0C;AAC1C,qDAAkE;AAcrD,QAAA,sBAAsB,GAAsC;IACvE,KAAK,EAAE,sBAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1B,MAAM,EAAE,sBAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,+BAA+B;IAInC,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,+BAA+B,CAAC,KAAK,CAAC,CAAC;SAC5D;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,SAAqB;QAChC,IAAI,SAAS,YAAY,qCAAmB,EAAE;YAC5C,MAAM,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAC,YAAY,EAAE,wBAAwB,CAAC;YACzF,MAAM,qBAAqB,GAAG,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC;YAElE,IAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE;gBACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;aACrG;YAED,MAAM,oBAAoB,GAAG,SAAS,CAAC,sBAAsB,GAAG,8BAAsB,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAE1G,IAAI,oBAAoB,EAAE;gBACxB,SAAS,CAAC,UAAU,CAAC,YAAY,GAAG;oBAClC,wBAAwB,EAAE;wBACxB,GAAG,oBAAoB;wBACvB,SAAS,EAAE,sBAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE;qBAChE;iBACF,CAAC;aACH;YAED,IAAI,qBAAqB,EAAE;gBACzB,SAAS,CAAC,UAAU,CAAC,cAAc,GAAG;oBACpC,GAAG,qBAAqB;oBACxB,cAAc,EAAE;wBACd,GAAG,qBAAqB,CAAC,cAAc;wBACvC,OAAO,EAAE,sBAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE;qBAC9D;iBACF,CAAC;aACH;SACF;IACH,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,uCAAuC;IAK3C,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,uCAAuC,CAAC,KAAK,CAAC,CAAC;SACpE;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,SAAqB;QAChC,IAAI,SAAS,YAAY,kCAAgB,EAAE;YACzC,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;YAC3B,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAE9B;;;;;;;;;;;;;eAaG;YACH,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAA2B,EAAE,CAAC,CAAC,YAAY,gCAAkB,CAAC,CAAC;YAEtG,IAAI,CAAC,gBAAgB,EAAE;gBACrB,MAAM,IAAI,KAAK,CACb,iFAAiF,IAAI,wDAAwD,CAC9I,CAAC;aACH;YAED,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;YACtF,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,UAAU,CAAC,YAAY,EAAE,wBAAwB,CAAC;YAEnG,IAAI,oBAAoB,EAAE;gBACxB;;;;mBAIG;gBACH,mBAAmB,CAAC,eAAe,GAAG,SAAS,CAAC;gBAEhD,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAE3C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;oBACtC,IAAI,CAAC,aAAa,CAAC,GAAG,CACpB,SAAS,EACT,IAAI,0BAAY,CAAC,IAAI,CAAC,KAAK,EAAE,2BAA2B,gBAAgB,CAAC,GAAG,EAAE,EAAE;wBAC9E,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC;wBAC9C,QAAQ,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC;qBACpD,CAAC,CACH,CAAC;iBACH;gBAED,MAAM,qBAAqB,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;gBAEjE,mBAAmB,CAAC,UAAU,CAAC,YAAY,GAAG;oBAC5C,wBAAwB,EAAE;wBACxB,GAAG,oBAAoB;wBACvB,qBAAqB,EAAE,qBAAqB,CAAC,aAAa;qBAC3D;iBACF,CAAC;aACH;SACF;IACH,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,sBAAuB,SAAQ,gBAAM;IAGzC,YAAoB,KAAc;QAChC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAE1B,KAAK,CAAC,KAAK,EAAE,wBAAwB,EAAE;YACrC,UAAU,EAAE;gBACV,uCAAuC;gBACvC,IAAI,yBAAe,CAAC;oBAClB,OAAO,EAAE,CAAC,+BAA+B,CAAC;oBAC1C,MAAM,EAAE,gBAAM,CAAC,KAAK;oBACpB,SAAS,EAAE,CAAC,OAAO,CAAC;iBACrB,CAAC;gBAEF;;;;mBAIG;gBACH,IAAI,yBAAe,CAAC;oBAClB,OAAO,EAAE,CAAC,2CAA2C,CAAC;oBACtD,MAAM,EAAE,gBAAM,CAAC,KAAK;oBACpB,SAAS,EAAE,CAAC,GAAG,CAAC;iBACjB,CAAC;aACH;SACF,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,KAAc;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAA,qCAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;SACnD;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,oBAAqB,SAAQ,mBAAQ;IAChD,YAAY,KAAc,EAAE,KAAgC;QAC1D,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC;QACpF,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;QAClC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAElC,KAAK,CAAC,KAAK,EAAE;YACX,GAAG,KAAK;YACR,YAAY,EAAE,8BAAY,CAAC,aAAa,CAAC;gBACvC,YAAY,EAAE,gBAAgB;gBAC9B,qBAAqB,EAAE,gBAAgB;gBACvC,oBAAoB,EAAE,GAAG;gBACzB,qBAAqB,EAAE,IAAI;gBAE3B;;;;;mBAKG;gBACH,gBAAgB,EAAE,CAAC,gCAAc,CAAC,kBAAkB,CAAC;aACtD,CAAC;SACH,CAAC,CAAC;QAEH,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAC/C,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC;QAC5C,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAmC,CAAC;QAEtF,mBAAmB,CAAC,eAAe,GAAG,gBAAgB,CAAC,QAAQ,EAAE,CAAC;QAElE,mBAAmB,CAAC,UAAU,CAAC,cAAc,GAAG;YAC9C,yBAAyB,EAAE;gBACzB,6BAA6B,EAAE,GAAG;aACnC;YACD,cAAc,EAAE;gBACd,KAAK,EAAE,gBAAgB;aACxB;SACF,CAAC;QAEF,sBAAsB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAE7D;;;WAGG;QACH,QAAQ,CAAC,WAAW,CAClB,KAAK,oBAAoB,CAAC,IAAI,iBAAiB,EAC/C;;;;;6BAKuB,WAAW,CAAC,cAAc;mBACpC,MAAM;yCACgB,eAAe;;;;;gBAKxC,8BAAsB,CAAC,KAAK,CAAC,SAAS,EAAE;;+BAEzB,WAAW,CAAC,cAAc;qBACpC,MAAM;2CACgB,eAAe;;;;;OAKnD,EACD,KAAK,oBAAoB,CAAC,IAAI,eAAe,CAC9C,CAAC;QAEF,QAAQ,CAAC,iBAAiB,CACxB;6BACuB,OAAO;uBACb,mBAAmB,CAAC,SAAS;qBAC/B,MAAM;;SAElB,CACJ,CAAC;QAEF,oFAAoF;QACpF,qBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,+BAA+B,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,qBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,uCAAuC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACpF,CAAC;CACF;AArFD,oDAqFC","sourcesContent":["import type { IAspect } from \"aws-cdk-lib\";\nimport { Aspects, CfnParameter, Duration } from \"aws-cdk-lib\";\nimport { CfnAutoScalingGroup, CfnScalingPolicy, ScalingProcess, UpdatePolicy } from \"aws-cdk-lib/aws-autoscaling\";\nimport { Effect, Policy, PolicyStatement } from \"aws-cdk-lib/aws-iam\";\nimport type { IConstruct } from \"constructs\";\nimport { GuAutoScalingGroup } from \"../../constructs/autoscaling\";\nimport type { GuStack } from \"../../constructs/core\";\nimport type { GuEc2AppProps } from \"../../patterns\";\nimport { GuEc2App } from \"../../patterns\";\nimport { isSingletonPresentInStack } from \"../../utils/singleton\";\n\ninterface AutoScalingRollingUpdateDurations {\n  /**\n   * The time between each check of an instance's health within the target group.\n   */\n  sleep: Duration;\n\n  /**\n   * Additional time to cover the time spent polling an instance's health within the target group before sending the CloudFormation signal.\n   */\n  buffer: Duration;\n}\n\nexport const RollingUpdateDurations: AutoScalingRollingUpdateDurations = {\n  sleep: Duration.seconds(5),\n  buffer: Duration.minutes(1),\n};\n\n/**\n * Ensures the `AutoScalingRollingUpdate` of an AutoScaling Group has a `PauseTime` matching the healthcheck grace period.\n * It also ensures the `CreationPolicy` resource signal `Timeout` matches the healthcheck grace period.\n *\n * @internal\n *\n * @privateRemarks\n * The ASG healthcheck grace period is hard-coded by {@link GuEc2App}.\n * Customisation of this value is performed via an escape hatch.\n * An `Aspect` is the only way to observe any customisation.\n *\n * TODO Expose the healthcheck grace period as a property on {@link GuEc2App} and remove this `Aspect`.\n */\nclass AutoScalingRollingUpdateTimeout implements IAspect {\n  public readonly stack: GuStack;\n  private static instance: AutoScalingRollingUpdateTimeout | undefined;\n\n  private constructor(scope: GuStack) {\n    this.stack = scope;\n  }\n\n  public static getInstance(stack: GuStack): AutoScalingRollingUpdateTimeout {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new AutoScalingRollingUpdateTimeout(stack);\n    }\n    return this.instance;\n  }\n\n  public visit(construct: IConstruct) {\n    if (construct instanceof CfnAutoScalingGroup) {\n      const currentRollingUpdate = construct.cfnOptions.updatePolicy?.autoScalingRollingUpdate;\n      const currentCreationPolicy = construct.cfnOptions.creationPolicy;\n\n      if (!construct.healthCheckGracePeriod) {\n        throw new Error(`The healthcheck grace period not set for autoscaling group ${construct.node.id}.`);\n      }\n\n      const signalTimeoutSeconds = construct.healthCheckGracePeriod + RollingUpdateDurations.buffer.toSeconds();\n\n      if (currentRollingUpdate) {\n        construct.cfnOptions.updatePolicy = {\n          autoScalingRollingUpdate: {\n            ...currentRollingUpdate,\n            pauseTime: Duration.seconds(signalTimeoutSeconds).toIsoString(),\n          },\n        };\n      }\n\n      if (currentCreationPolicy) {\n        construct.cfnOptions.creationPolicy = {\n          ...currentCreationPolicy,\n          resourceSignal: {\n            ...currentCreationPolicy.resourceSignal,\n            timeout: Duration.seconds(signalTimeoutSeconds).toIsoString(),\n          },\n        };\n      }\n    }\n  }\n}\n\n/**\n * An `Aspect` that adjusts the properties of an AutoScaling Group using an `AutoScalingRollingUpdate` update policy.\n *\n * It'll unset the `DesiredCapacity` of the ASG as a rolling update sets `Desired` back to the template version,\n * undoing any changes that a scale-out event may have done.\n * Having `DesiredCapacity` unset ensures the service remains at-capacity at all times.\n *\n * It'll also make the `MinInstancesInService` property dynamic via a CFN Parameter that Riff-Raff will set.\n * The value depends on the current capacity of the ASG:\n *  - If the service is running normally, it'll be set to the `MinSize` capacity\n *  - If the service is partially scaled, it'll be set to the current `DesiredCapacity`\n *  - If the service is fully scaled, it'll be set to (at least) `MaxSize` - 1\n *\n * @privateRemarks\n * - Temporarily implemented as a singleton to ensure only one instance is added to a stack,\n *   else multiple attempts to add the same CFN Parameter will be made and fail.\n * - Once out of experimental, instantiate this `Aspect` directly in {@link GuStack}.\n *\n * @see https://github.com/guardian/testing-asg-rolling-update\n */\nclass HorizontallyScalingDeploymentProperties implements IAspect {\n  public readonly stack: GuStack;\n  private readonly asgToParamMap: Map<string, CfnParameter>;\n  private static instance: HorizontallyScalingDeploymentProperties | undefined;\n\n  private constructor(scope: GuStack) {\n    this.stack = scope;\n    this.asgToParamMap = new Map();\n  }\n\n  public static getInstance(stack: GuStack): HorizontallyScalingDeploymentProperties {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new HorizontallyScalingDeploymentProperties(stack);\n    }\n\n    return this.instance;\n  }\n\n  public visit(construct: IConstruct) {\n    if (construct instanceof CfnScalingPolicy) {\n      const { node } = construct;\n      const { scopes, path } = node;\n\n      /*\n      Requiring a `CfnScalingPolicy` to be created in the scope of a `GuAutoScalingGroup`\n      is the most reliable way to associate the two together.\n\n      Though the `autoScalingGroupName` property is passed to a `CfnScalingPolicy` when instantiating,\n      this does not create a concrete link as AWS CDK sets the value to be the ASG's `Ref`.\n      That is, it is a `Token` until it is synthesised.\n      This is even if the ASG has an explicit name set.\n\n      See also:\n        - https://docs.aws.amazon.com/cdk/v2/guide/tokens.html\n        - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup-return-values\n        - https://github.com/aws/aws-cdk/blob/f6b649d47f8bc30ca741fbb7a4852d51e8275002/packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts#L1560\n       */\n      const autoScalingGroup = scopes.find((_): _ is GuAutoScalingGroup => _ instanceof GuAutoScalingGroup);\n\n      if (!autoScalingGroup) {\n        throw new Error(\n          `Failed to detect the autoscaling group relating to the scaling policy on path ${path}. Was it created in the scope of a GuAutoScalingGroup?`,\n        );\n      }\n\n      const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n      const currentRollingUpdate = cfnAutoScalingGroup.cfnOptions.updatePolicy?.autoScalingRollingUpdate;\n\n      if (currentRollingUpdate) {\n        /*\n        An autoscaling group that horizontally scales should not explicitly set `Desired`,\n        as a rolling update will set the current `Desired` back to the template version,\n        undoing any changes that a scale-out event may have done.\n         */\n        cfnAutoScalingGroup.desiredCapacity = undefined;\n\n        const asgNodeId = autoScalingGroup.node.id;\n\n        if (!this.asgToParamMap.has(asgNodeId)) {\n          this.asgToParamMap.set(\n            asgNodeId,\n            new CfnParameter(this.stack, `MinInstancesInServiceFor${autoScalingGroup.app}`, {\n              type: \"Number\",\n              default: parseInt(cfnAutoScalingGroup.minSize),\n              maxValue: parseInt(cfnAutoScalingGroup.maxSize) - 1,\n            }),\n          );\n        }\n\n        const minInstancesInService = this.asgToParamMap.get(asgNodeId)!;\n\n        cfnAutoScalingGroup.cfnOptions.updatePolicy = {\n          autoScalingRollingUpdate: {\n            ...currentRollingUpdate,\n            minInstancesInService: minInstancesInService.valueAsNumber,\n          },\n        };\n      }\n    }\n  }\n}\n\n/**\n * An IAM Policy allowing the sending of a CloudFormation signal.\n *\n * @privateRemarks\n * Implemented as a singleton as the resources can only be tightened at most to the CloudFormation stack.\n */\nclass AsgRollingUpdatePolicy extends Policy {\n  private static instance: AsgRollingUpdatePolicy | undefined;\n\n  private constructor(scope: GuStack) {\n    const { stackId } = scope;\n\n    super(scope, \"AsgRollingUpdatePolicy\", {\n      statements: [\n        // Allow usage of command `cfn-signal`.\n        new PolicyStatement({\n          actions: [\"cloudformation:SignalResource\"],\n          effect: Effect.ALLOW,\n          resources: [stackId],\n        }),\n\n        /*\n        Allow usage of command `aws elbv2 describe-target-health`.\n        AWS Elastic Load Balancing does not support resource based policies, so the resource has to be `*` (any) here.\n        See https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html\n         */\n        new PolicyStatement({\n          actions: [\"elasticloadbalancing:DescribeTargetHealth\"],\n          effect: Effect.ALLOW,\n          resources: [\"*\"],\n        }),\n      ],\n    });\n  }\n\n  public static getInstance(stack: GuStack): AsgRollingUpdatePolicy {\n    if (!this.instance || !isSingletonPresentInStack(stack, this.instance)) {\n      this.instance = new AsgRollingUpdatePolicy(stack);\n    }\n\n    return this.instance;\n  }\n}\n\nexport interface GuEc2AppExperimentalProps extends Omit<GuEc2AppProps, \"updatePolicy\"> {}\n\n/**\n * An experimental pattern to instantiate an EC2 application that is updated entirely via CloudFormation.\n * It sets the update policy of the `AWS::AutoScaling::AutoScalingGroup` to `AutoScalingRollingUpdate`.\n * When a CloudFormation update is applied, the current instances in the ASG will be replaced.\n *\n * This pattern also updates the User Data, running some commands AFTER yours.\n * These changes are wrapped in start and end marking comments.\n *\n * This pattern does not enable for scaling events to trigger _during_ a deployment\n * as during testing it was found that scale-in events during deployment led to unpredictable service availability.\n *\n * If a deployment fails, for example when the healthcheck fails, CloudFormation will automatically rollback the changes.\n * This improves on the behaviour of Riff-Raff's `autoscaling` deployment which requires manual intervention on deployment failure.\n *\n * To update the application's code, a CloudFormation update must be triggered.\n * The best way to do this is to include the build number in the application artifact.\n * TODO test User Data includes a build number.\n *\n * @remarks\n * - The rate at which instances are replaced are conditional based on how scaled up the service is.\n *   The more an application is scaled, the longer it'll take to deploy.\n * - It is not necessary to use the `autoscaling` Riff-Raff deployment type in conjunction with this.\n *   Doing so won't break anything, however it'll lengthen the deployment time as instances will be rotated twice.\n *   Please remove it from any manually created `riff-raff.yaml` file.\n * - Your application should include a build number in its filename.\n *   This value will change across builds, and therefore create a CloudFormation template difference to be deployed.\n * - Requires the AWS CLI and `cfn-signal` binaries to be available on the instance, and on the `PATH`.\n *   AMIgo adds these via the `aws-tools` role.\n *\n * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate\n * @see https://github.com/guardian/testing-asg-rolling-update\n *\n * @experimental\n */\nexport class GuEc2AppExperimental extends GuEc2App {\n  constructor(scope: GuStack, props: GuEc2AppExperimentalProps) {\n    const { minimumInstances, maximumInstances = minimumInstances * 2 } = props.scaling;\n    const { applicationPort } = props;\n    const { region, stackId } = scope;\n\n    super(scope, {\n      ...props,\n      updatePolicy: UpdatePolicy.rollingUpdate({\n        maxBatchSize: maximumInstances,\n        minInstancesInService: minimumInstances,\n        minSuccessPercentage: 100,\n        waitOnResourceSignals: true,\n\n        /*\n        If a scale-in event fires during an `AutoScalingRollingUpdate` operation, the update could fail and rollback.\n        For this reason, we suspend the `AlarmNotification` process, else availability of a service cannot be guaranteed.\n        Consequently, services cannot scale-out during deployments.\n        If AWS ever supports suspending scale-out and scale-in independently, we should allow scale-out.\n         */\n        suspendProcesses: [ScalingProcess.ALARM_NOTIFICATION],\n      }),\n    });\n\n    const { autoScalingGroup, targetGroup } = this;\n    const { userData, role } = autoScalingGroup;\n    const cfnAutoScalingGroup = autoScalingGroup.node.defaultChild as CfnAutoScalingGroup;\n\n    cfnAutoScalingGroup.desiredCapacity = minimumInstances.toString();\n\n    cfnAutoScalingGroup.cfnOptions.creationPolicy = {\n      autoScalingCreationPolicy: {\n        minSuccessfulInstancesPercent: 100,\n      },\n      resourceSignal: {\n        count: minimumInstances,\n      },\n    };\n\n    AsgRollingUpdatePolicy.getInstance(scope).attachToRole(role);\n\n    /*\n    `aws` is available via AMIgo baked AMIs.\n    See https://github.com/guardian/amigo/tree/main/roles/aws-tools.\n     */\n    userData.addCommands(\n      `# ${GuEc2AppExperimental.name} UserData Start`,\n      `\n      TOKEN=$(curl -X PUT \"http://169.254.169.254/latest/api/token\" -H \"X-aws-ec2-metadata-token-ttl-seconds: 21600\")\n      INSTANCE_ID=$(curl -H \"X-aws-ec2-metadata-token: $TOKEN\" \"http://169.254.169.254/latest/meta-data/instance-id\")\n\n      STATE=$(aws elbv2 describe-target-health \\\n        --target-group-arn ${targetGroup.targetGroupArn} \\\n        --region ${region} \\\n        --targets Id=$INSTANCE_ID,Port=${applicationPort} \\\n        --query \"TargetHealthDescriptions[0].TargetHealth.State\")\n\n      until [ \"$STATE\" == \"\\\\\"healthy\\\\\"\" ]; do\n        echo \"Instance not yet healthy within target group. Current state $STATE. Sleeping...\"\n        sleep ${RollingUpdateDurations.sleep.toSeconds()}\n        STATE=$(aws elbv2 describe-target-health \\\n          --target-group-arn ${targetGroup.targetGroupArn} \\\n          --region ${region} \\\n          --targets Id=$INSTANCE_ID,Port=${applicationPort} \\\n          --query \"TargetHealthDescriptions[0].TargetHealth.State\")\n      done\n\n      echo \"Instance is healthy in target group.\"\n      `,\n      `# ${GuEc2AppExperimental.name} UserData End`,\n    );\n\n    userData.addOnExitCommands(\n      `\n        cfn-signal --stack ${stackId} \\\n          --resource ${cfnAutoScalingGroup.logicalId} \\\n          --region ${region} \\\n          --exit-code $exitCode || echo 'Failed to send Cloudformation Signal'\n        `,\n    );\n\n    // TODO Once out of experimental, instantiate these `Aspect`s directly in `GuStack`.\n    Aspects.of(scope).add(AutoScalingRollingUpdateTimeout.getInstance(scope));\n    Aspects.of(scope).add(HorizontallyScalingDeploymentProperties.getInstance(scope));\n  }\n}\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@guardian/cdk",
   "description": "Generic Guardian flavoured AWS CDK components",
-  "version": "59.5.0",
+  "version": "59.5.1",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -33,17 +33,17 @@
     "@guardian/eslint-plugin-tsdoc-required": "^0.1.3",
     "@guardian/tsconfig": "^1.0.0",
     "@types/git-url-parse": "^9.0.3",
-    "@types/jest": "^29.5.12",
+    "@types/jest": "^29.5.13",
     "@types/js-yaml": "^4.0.9",
     "@types/lodash.camelcase": "^4.3.9",
     "@types/lodash.kebabcase": "^4.1.9",
     "@types/lodash.upperfirst": "^4.3.9",
-    "@types/node": "22.5.4",
+    "@types/node": "22.5.5",
     "@types/yargs": "^17.0.33",
     "aws-cdk": "2.157.0",
     "aws-cdk-lib": "2.157.0",
     "constructs": "10.3.0",
-    "eslint": "^8.57.0",
+    "eslint": "^8.57.1",
     "eslint-plugin-custom-rules": "file:tools/eslint",
     "gh-pages": "^6.1.1",
     "jest": "^29.7.0",