aws-ecs-patterns: ApplicationLoadBalancedFargateService not generating health check

[oechsler]

Describe the bug

The current implementation of the ApplicationLoadBalancedFargateService is not generating the health checks definition for the service in CloudFormation.

Example code that produces the Issue:

const service = new ApplicationLoadBalancedFargateService(
  this.scope,
  `${this.defineServiceName()}-${this.namingPrefix}-service`,
  {
    serviceName: `${this.defineServiceName()}-${this.namingPrefix}`,
    cluster: this.ecsConstruct.cluster,
    taskDefinition: taskDefinition,
    circuitBreaker: { rollback: true },
    desiredCount: 1,
    healthCheck: {
      command: ['CMD-SHELL', '/opt/health-check.sh >> /proc/1/fd/1 2>&1 || exit 1'],
      interval: Duration.seconds(10),
      retries: 3,
      startPeriod: Duration.seconds(30),
      timeout: Duration.seconds(8),
    },
    loadBalancerName: `${this.namingPrefix}-frontend`,
    targetProtocol: ApplicationProtocol.HTTP,
    protocolVersion: ApplicationProtocolVersion.GRPC,
    certificate: certificate,
    cloudMapOptions: this.baseService.defineCloudMapOptions(
      this.ecsConstruct.cluster.defaultCloudMapNamespace!,
    ),
  },
);

Generated CloudFormation output:

{
  // ...
  "...146D4EEB": {
   "Type": "AWS::ECS::TaskDefinition",
   "Properties": {
    "ContainerDefinitions": [
     {
      "Environment": [
       // ...
      ],
      "Essential": true,
      "Image": {
       "Fn::Sub": "..."
      },
      "LogConfiguration": {
       "LogDriver": "awslogs",
       "Options": {
        "awslogs-group": {
         "Ref": "..."
        },
        "awslogs-stream-prefix": "...",
        "awslogs-region": "..."
       }
      },
      "Name": "...",
      "PortMappings": [
       {
        "AppProtocol": "grpc",
        "ContainerPort": 9000,
        "HostPort": 9000,
        "Name": "f-9000",
        "Protocol": "tcp"
       },
       // ...
      ],
      "StartTimeout": 150
     }
    ],
    "Cpu": "1024",
    "ExecutionRoleArn": {
     "Fn::GetAtt": [
      "...",
      "Arn"
     ]
    },
    "Family": "...",
    "Memory": "4096",
    "NetworkMode": "awsvpc",
    "RequiresCompatibilities": [
     "FARGATE"
    ],
    "RuntimePlatform": {
     "CpuArchitecture": "ARM64",
     "OperatingSystemFamily": "LINUX"
    },
    "TaskRoleArn": {
     "Fn::GetAtt": [
      "...",
      "Arn"
     ]
    }
   },
   "Metadata": {
    "aws:cdk:path": "..."
   }
  },
  // ...
}

Names censored

Expected Behavior

That the defined health check in CDK code is generated in the CloudFormation output and deployed to AWS.

Current Behavior

No health check is generated, nor deployed.

Reproduction Steps

1. Define ApplicationLoadBalancedFargateService from provided example with healthCheck set.
2. Run cdk synth
3. Check output in cdk.out

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.137.0 (build bb90b4c)

Framework Version

No response

Node.js Version

v20.12.1

OS

macOS 14.4.1 (23E224)

Language

TypeScript

Language Version

No response

Other information

No response

[pahud]

It actually runs this for you under the hood:

aws-cdk/packages/aws-cdk-lib/aws-ecs-patterns/lib/fargate/application-load-balanced-fargate-service.ts

Lines 91 to 93 in 41d2c52

	const container = this.taskDefinition.addContainer(containerName, {
	image: taskImageOptions.image,
	healthCheck: props.healthCheck,

Can you share how to define your taskDefinition in CDK?

[oechsler]

new ecs.FargateTaskDefinition(
  this.scope,
  `${this.serviceName}-${this.namingPrefix}-task-def`,
  {
    runtimePlatform: {
      cpuArchitecture: CpuArchitecture.ARM64,
      operatingSystemFamily: OperatingSystemFamily.LINUX,
    },
    cpu: props.cpu,
    memoryLimitMiB: props.memoryLimitMiB,
  },
);

taskDefinition.addContainer(`${this.serviceName}-${this.namingPrefix}-container`, {
  image: props.image,
  containerName: `${this.serviceName}-${this.namingPrefix}`,
  logging: new ecs.AwsLogDriver({
    streamPrefix: `${this.serviceName}-${this.namingPrefix}`,
    logGroup: this.defineLogGroup(),
  }),
  environment: this.getCommonEnvironmentVariables(this.dbConstruct, props.frontendService),
  portMappings: props.portMappings,
  startTimeout: props.delay,
});

Here you go