(aws-batch): Allow specifying ComputeResource tags in managed EC2 compute environments

[tvoipio]

Describe the feature

Managed EC compute environments allow specifying a tags attribute in ComputeResource (see https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html) to apply specific tags to EC2 instances launched by Batch/ECS. These are used e.g. for cost allocation.

The CloudFormation resource does support providing tags in ComputeResource: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-batch-computeenvironment-computeresources.html

The functionality seems to be available in aws_cdk.aws_batch.CfnComputeEnvironment via CfnComputeEnvironment.ComputeResourcesProperty's tags kwarg/property, but not exposed to the L2 construct.

I could hack my way around this using an escape hatch, but as there seems to be no reason not to expose the ComputeResource tags to the L2 construct, could this be provided directly by CDK?

Use Case

I need to use an escape hatch to provide necessary tags to managed EC2 environment compute resources in order to e.g. allocate costs correctly and get the Name tag set properly to be able to identify Batch EC2 instances in the EC2 console

Proposed Solution

Add a property/keyword argument (excuse my Python vocabulary) to the L2 construct ManagedEc2EcsComputeEnvironment. Based on my limited understanding of the construct code, in https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts add a property computeResourceTags to ManagedEc2EcsComputeEnvironmentProps and use it instead of/in addition to this.tags.renderedTags in

aws-cdk/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts

Line 755 in e4cc047

tags: this.tags.renderedTags as any,

(and

aws-cdk/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts

Line 1130 in e4cc047

tags: this.tags.renderedTags as any,

to apply the same to EKS based environments?)

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

AWS CDK Library version (aws-cdk-lib)

2.225.0 (Python package version)

AWS CDK CLI version

2.1033.0 (build 1ec3310)

Environment details (OS name and version, etc.)

macOS Sequoia 15.7.1

[pahud]

Hi @tvoipio,

Thanks for the detailed feature request!

You're correct that ComputeResources.Tags is supported at L1 but not exposed in the L2 construct. The Tags.of() API only targets the resource-level Tags property and cannot reach nested properties like ComputeResources.Tags - these serve different purposes (resource tags vs. EC2 instance tags).

Workaround

Until this is implemented, you can use an escape hatch:

cfn_compute_env = compute_env.node.default_child
cfn_compute_env.add_property_override(
    "ComputeResources.Tags",
    {
        "Name": "Batch Instance - Production",
        "CostCenter": "Engineering"
    }
)

Proposed Solution

Adding a computeResourceTags property to expose the L1 capability is the right approach. This follows the established pattern used by LaunchTemplate.TagSpecifications where instance-level tags are exposed as explicit props separate from resource-level tags. PRs welcome!

[9pace]

Thank you for submitting this issue. You can use the following code to address your concerns.

const cfn_compute_env = new ComputeEnvironment(stack, 'MyCE', {
    ...defaultProps,
});

Tags.of(ce).add('Name',  'Batch Instance - Production');
Tags.of(ce).add('CostCenter', 'Engineering');

This adds the tags to the ComputeResource property as is tested here:

aws-cdk/packages/aws-cdk-lib/aws-batch/test/managed-compute-environment.test.ts

Lines 649 to 669 in cbf0b03

	test('respects tags', () => {
	// WHEN
	const ce = new ComputeEnvironment(stack, 'MyCE', {
	...defaultProps,
	});
	Tags.of(ce).add('superfood', 'acai');
	Tags.of(ce).add('super', 'salamander');
	// THEN
	Template.fromStack(stack).hasResourceProperties('AWS::Batch::ComputeEnvironment', {
	...expectedProps,
	ComputeResources: {
	...defaultComputeResources,
	Tags: {
	superfood: 'acai',
	super: 'salamander',
	},
	},
	});
	});

For more information about tags in the CDK refer to: https://docs.aws.amazon.com/cdk/v2/guide/tagging.html

[9pace]

@tvoipio Please let me know if this solution satisfies your constraints. The current implementation does not provide control over only the ComputeResource tags as ComputeEnvironment will receive the same tags added with Tags.of().

[github-actions]

This issue has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.