feat(ecs): add validation checks to memory cpu combinations of FARGATE compatible task definitions

[mrlikl]

Issue # (if applicable)

Closes #22216

Reason for this change

Adds a validation that would point out invalid CPU - Memory limits for a FARGATE compatible task definition. This is based on the document https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html

Description of changes

Added a validateFargateTaskDefinitionMemoryCpu method in the base task definition and run this validation when a task definition has FARGATE in requiresCompatibilities.

This is in line with the ECS requirement that even if a task definition has EC2 compatibility (along with FARGATE), FARGATE validations apply

Description of how you validated changes

Validated the changes by providing incorrect as well as correct values, fixed all the invalid combinations that are present in the unit tests

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

[lpizzinidev]

Thanks 👍 Left some comments for adjustments

[lpizzinidev]

Can we take the opportunity to remove the !s? It's a bit annoying to see them.

    if (this.isFargateCompatible) {
      if (!props.cpu || !props.memoryMiB) {
        throw new Error(`Fargate-compatible tasks require both CPU (${props.cpu}) and memory (${props.memoryMiB}) specifications`);
      }

      // validate the cpu and memory size for the Windows operation system family.
      if (props.runtimePlatform?.operatingSystemFamily?.isWindows()) {
        this.checkFargateWindowsBasedTasksSize(props.cpu, props.memoryMiB, props.runtimePlatform);
      }

      // Check the combination as per doc https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html
      this.validateFargateTaskDefinitionMemoryCpu(props.cpu, props.memoryMiB);
    }

[lpizzinidev]

Suggested change

	const validCpuMemoryCombinations = [
	{ cpu: 256, memory: [512, 1024, 2048] },
	{ cpu: 512, memory: this.range(1024, 4096, 1024) },
	{ cpu: 1024, memory: this.range(2048, 8192, 1024) },
	{ cpu: 2048, memory: this.range(4096, 16384, 1024) },
	{ cpu: 4096, memory: this.range(8192, 30720, 1024) },
	{ cpu: 8192, memory: this.range(16384, 61440, 4096) },
	{ cpu: 16384, memory: this.range(32768, 122880, 8192) },
	];
	const isValidCombination = validCpuMemoryCombinations.some((combo) => {
	return combo.cpu === Number(cpu) && combo.memory.includes(Number(memory));
	});
	if (!isValidCombination) {
	throw new Error('Invalid CPU and memory combinations for FARGATE compatible task definition - https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html');
	}
	}
	private range(start: number, end: number, step: number): number[] {
	const validCpuMemoryCombinations = [
	{ cpu: '256', memory: ['512', '1024', '2048'] },
	{ cpu: '512', memory: this.range(1024, 4096, 1024) },
	{ cpu: '1024', memory: this.range(2048, 8192, 1024) },
	{ cpu: '2048', memory: this.range(4096, 16384, 1024) },
	{ cpu: '4096', memory: this.range(8192, 30720, 1024) },
	{ cpu: '8192', memory: this.range(16384, 61440, 4096) },
	{ cpu: '16384', memory: this.range(32768, 122880, 8192) },
	];
	const isValidCombination = validCpuMemoryCombinations.some((combo) => {
	return combo.cpu === cpu && combo.memory.includes(memory);
	});
	if (!isValidCombination) {
	throw new Error('Invalid CPU and memory combinations for FARGATE compatible task definition - https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html');
	}
	}
	private range(start: number, end: number, step: number): string[] {

What about avoiding Number -> String casting?

[lpizzinidev]

We should be able to support this by adding validation on the node (like this):

this.node.addValidation({ validate: () => this. validateFargateTaskDefinitionMemoryCpu(...);

[lpizzinidev]

Suggested change

	this.validateFargateTaskDefinitionMemoryCpu(props.cpu, props.memoryMiB);
	this.node.addValidation({
	validate: () => this.validateFargateTaskDefinitionMemoryCpu(props.cpu, props.memoryMiB)
	});

Please note https://github.com/aws/aws-cdk/pull/30166/files#r1641289793

[mrlikl]

I have made all the suggested changes @lpizzinidev

[mrlikl]

Please take a look once

[lpizzinidev]

Thanks 👍

[Leo10Gama]

Thanks for the PR! Left a few comments and nits to be addressed.

Pull request has been modified.

[Leo10Gama]

Thanks for the changes, and fixing a few other typos around the repo! Just one minor concern about some of the new logic-shuffling.

[Leo10Gama]

LGTM, thanks for your contribution!

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: b4f36b2
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.