fix(ecs): add support for hook details field

Author: kg-aws

packages/@aws-cdk-testing/framework-integ/test/aws-ecs/test/base/integ.blue-green-deployment-strategy.js.snapshot/aws-ecs-blue-green-deployment.assets.json

@@ -742,6 +742,7 @@
     "DeploymentConfiguration": {
      "LifecycleHooks": [
       {
+       "HookDetails": "{\"stringKey\":\"stringValue\",\"intKey\":1,\"boolKey\":true,\"listKey\":[\"stringValue1\",\"stringValue2\"]}",
        "HookTargetArn": {
         "Fn::GetAtt": [
          "LambdaHookBF1BC8B4",

packages/@aws-cdk-testing/framework-integ/test/aws-ecs/test/base/integ.blue-green-deployment-strategy.js.snapshot/aws-ecs-blue-green-deployment.template.json

@@ -125,6 +125,12 @@ const service = new ecs.FargateService(stack, 'Service', {
 
 service.addLifecycleHook(new ecs.DeploymentLifecycleLambdaTarget(lambdaHook, 'PreScaleUp', {
   lifecycleStages: [ecs.DeploymentLifecycleStage.PRE_SCALE_UP],
+  hookDetails: {
+    stringKey: 'stringValue',
+    intKey: 1,
+    boolKey: true,
+    listKey: ['stringValue1', 'stringValue2'],
+  },
 }));
 
 const target = service.loadBalancerTarget({

packages/@aws-cdk-testing/framework-integ/test/aws-ecs/test/base/integ.blue-green-deployment-strategy.js.snapshot/integ.json

@@ -2200,6 +2200,7 @@ const service = new ecs.FargateService(this, 'Service', {
 
 service.addLifecycleHook(new ecs.DeploymentLifecycleLambdaTarget(lambdaHook, 'PreScaleHook', {
   lifecycleStages: [ecs.DeploymentLifecycleStage.PRE_SCALE_UP],
+  hookDetails: {'stringKey':'stringValue', 'intKey':1, 'boolKey':true, "list": ["abc",1,true]},
 }));
 
 const target = service.loadBalancerTarget({

packages/@aws-cdk-testing/framework-integ/test/aws-ecs/test/base/integ.blue-green-deployment-strategy.js.snapshot/manifest.json

@@ -879,6 +879,7 @@ export abstract class BaseService extends Resource
         hookTargetArn: config.targetArn,
         roleArn: config.role!.roleArn,
         lifecycleStages: config.lifecycleStages.map(stage => stage.toString()),
+        hookDetails: config.hookDetails,
       };
     });
   }

packages/@aws-cdk-testing/framework-integ/test/aws-ecs/test/base/integ.blue-green-deployment-strategy.js.snapshot/tree.json

@@ -1,6 +1,38 @@
 import { IConstruct } from 'constructs';
 import * as iam from '../../aws-iam';
 import * as lambda from '../../aws-lambda';
+import { Fn } from '../../core';
+
+/**
+ * Error thrown when hook details validation fails
+ */
+class HookDetailsValidationError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'HookDetailsValidationError';
+  }
+}
+
+/**
+ * Validates that input is a valid JSON object and returns it as a stringified JSON using Fn::ToJsonString
+ * @param hookDetails The input to validate (must be a JSON object)
+ * @returns The stringified JSON using CloudFormation's Fn::ToJsonString intrinsic function
+ * @throws HookDetailsValidationError if the input is not a valid JSON object
+ */
+export function stringifyHookDetails(hookDetails: any): string {
+  // Reject arrays
+  if (Array.isArray(hookDetails)) {
+    throw new HookDetailsValidationError('hookDetails must be a JSON object, got: array');
+  }
+
+  // Check if it's a plain object
+  if (typeof hookDetails === 'object' && hookDetails.constructor === Object) {
+    return Fn.toJsonString(hookDetails);
+  }
+
+  // Everything else is invalid (primitives, functions, dates, etc.)
+  throw new HookDetailsValidationError(`hookDetails must be a JSON object, got: ${typeof hookDetails}`);
+}
 
 /**
  * Deployment lifecycle stages where hooks can be executed
@@ -55,6 +87,12 @@ export interface DeploymentLifecycleHookTargetConfig {
    * The lifecycle stages when this hook should be executed
    */
   readonly lifecycleStages: DeploymentLifecycleStage[];
+
+  /**
+   * Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).
+   * @default - No custom parameters will be passed
+   */
+  readonly hookDetails?: string;
 }
 
 /**
@@ -65,7 +103,6 @@ export interface IDeploymentLifecycleHookTarget {
    * Bind this target to a deployment lifecycle hook
    *
    * @param scope The construct scope
-   * @param id A unique identifier for this binding
    */
   bind(scope: IConstruct): DeploymentLifecycleHookTargetConfig;
 }
@@ -84,6 +121,19 @@ export interface DeploymentLifecycleLambdaTargetProps {
    * The lifecycle stages when this hook should be executed
    */
   readonly lifecycleStages: DeploymentLifecycleStage[];
+
+  /**
+   * Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).
+   *
+   * This field accepts JSON objects only
+   *
+   * @example
+   * // JSON object
+   * hookDetails: { environment: "production", timeout: 300 }
+   *
+   * @default - No custom parameters will be passed
+   */
+  readonly hookDetails?: any;
 }
 
 /**
@@ -122,6 +172,8 @@ export class DeploymentLifecycleLambdaTarget implements IDeploymentLifecycleHook
       targetArn: this.handler.functionArn,
       role: this._role,
       lifecycleStages: this.props.lifecycleStages,
+      hookDetails: (this.props.hookDetails === undefined || this.props.hookDetails === null)?
+        this.props.hookDetails : stringifyHookDetails(this.props.hookDetails),
     };
   }
 }