feat(elasticloadbalancingv2): add support for multi-value headers in Lambda target groups #34298
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…Lambda target groups
…adersEnabled and executed integ test
github-actions
bot
added
beginning-contributor
…gets imports for multi-value headers
aws-cdk-automation
added
the
pr/needs-community-review
badmintoncryer
suggested changes
Apr 30, 2025
Contributor
badmintoncryer
left a comment
badmintoncryer
left a comment
There was a problem hiding this comment.
Thank you for your contribution! Most of changes are seems to be good, and I've added some small comments.
Comment on lines
116
to
117
| * The possible values are true or false. | ||
| * The default value is false. |
Contributor
There was a problem hiding this comment.
I think it seems redundant. Could you please remove them?
Suggested change
| * The possible values are true or false. | |
| * The default value is false. |
Comment on lines
889
to
922
| test('lambda.multi_value_headers.enabled is not set when multiValueHeadersEnabled is false', () => { | ||
| // GIVEN | ||
| const app = new cdk.App(); | ||
| const stack = new cdk.Stack(app, 'Stack'); | ||
|
|
||
| // WHEN | ||
| new elbv2.ApplicationTargetGroup(stack, 'TG', { | ||
| targetType: elbv2.TargetType.LAMBDA, | ||
| multiValueHeadersEnabled: false, | ||
| }); | ||
|
|
||
| // THEN | ||
| Template.fromStack(stack).hasResourceProperties('AWS::ElasticLoadBalancingV2::TargetGroup', { | ||
| TargetType: 'lambda', | ||
| TargetGroupAttributes: Match.absent(), | ||
| }); | ||
| }); | ||
|
|
||
| test('lambda.multi_value_headers.enabled is not set when multiValueHeadersEnabled is not specified', () => { | ||
| // GIVEN | ||
| const app = new cdk.App(); | ||
| const stack = new cdk.Stack(app, 'Stack'); | ||
|
|
||
| // WHEN | ||
| new elbv2.ApplicationTargetGroup(stack, 'TG', { | ||
| targetType: elbv2.TargetType.LAMBDA, | ||
| }); | ||
|
|
||
| // THEN | ||
| Template.fromStack(stack).hasResourceProperties('AWS::ElasticLoadBalancingV2::TargetGroup', { | ||
| TargetType: 'lambda', | ||
| TargetGroupAttributes: Match.absent(), | ||
| }); | ||
| }); |
Contributor
There was a problem hiding this comment.
Could you please use test.each?
Suggested change
| test('lambda.multi_value_headers.enabled is not set when multiValueHeadersEnabled is false', () => { | |
| // GIVEN | |
| const app = new cdk.App(); | |
| const stack = new cdk.Stack(app, 'Stack'); | |
| // WHEN | |
| new elbv2.ApplicationTargetGroup(stack, 'TG', { | |
| targetType: elbv2.TargetType.LAMBDA, | |
| multiValueHeadersEnabled: false, | |
| }); | |
| // THEN | |
| Template.fromStack(stack).hasResourceProperties('AWS::ElasticLoadBalancingV2::TargetGroup', { | |
| TargetType: 'lambda', | |
| TargetGroupAttributes: Match.absent(), | |
| }); | |
| }); | |
| test('lambda.multi_value_headers.enabled is not set when multiValueHeadersEnabled is not specified', () => { | |
| // GIVEN | |
| const app = new cdk.App(); | |
| const stack = new cdk.Stack(app, 'Stack'); | |
| // WHEN | |
| new elbv2.ApplicationTargetGroup(stack, 'TG', { | |
| targetType: elbv2.TargetType.LAMBDA, | |
| }); | |
| // THEN | |
| Template.fromStack(stack).hasResourceProperties('AWS::ElasticLoadBalancingV2::TargetGroup', { | |
| TargetType: 'lambda', | |
| TargetGroupAttributes: Match.absent(), | |
| }); | |
| }); | |
| test.each([false, undefined])('lambda.multi_value_headers.enabled is not set when multiValueHeadersEnabled is %s', (multiValueHeadersEnabled) => { | |
| // GIVEN | |
| const app = new cdk.App(); | |
| const stack = new cdk.Stack(app, 'Stack'); | |
| // WHEN | |
| new elbv2.ApplicationTargetGroup(stack, 'TG', { | |
| targetType: elbv2.TargetType.LAMBDA, | |
| multiValueHeadersEnabled, | |
| }); | |
| // THEN | |
| Template.fromStack(stack).hasResourceProperties('AWS::ElasticLoadBalancingV2::TargetGroup', { | |
| TargetType: 'lambda', | |
| TargetGroupAttributes: Match.absent(), | |
| }); | |
| }); |
Comment on lines
987
to
1013
| test('Throws an error when multiValueHeadersEnabled is true for non-Lambda target type (IP)', () => { | ||
| // GIVEN | ||
| const app = new cdk.App(); | ||
| const stack = new cdk.Stack(app, 'Stack'); | ||
| const vpc = new ec2.Vpc(stack, 'VPC'); | ||
|
|
||
| // WHEN & THEN | ||
| expect(() => new elbv2.ApplicationTargetGroup(stack, 'TargetGroup', { | ||
| vpc, | ||
| targetType: elbv2.TargetType.IP, | ||
| multiValueHeadersEnabled: true, | ||
| })).toThrow('multiValueHeadersEnabled is only supported for Lambda targets.'); | ||
| }); | ||
|
|
||
| test('Throws an error when multiValueHeadersEnabled is true for non-Lambda target type (Instance)', () => { | ||
| // GIVEN | ||
| const app = new cdk.App(); | ||
| const stack = new cdk.Stack(app, 'Stack'); | ||
| const vpc = new ec2.Vpc(stack, 'VPC'); | ||
|
|
||
| // WHEN & THEN | ||
| expect(() => new elbv2.ApplicationTargetGroup(stack, 'TargetGroup', { | ||
| vpc, | ||
| targetType: elbv2.TargetType.INSTANCE, | ||
| multiValueHeadersEnabled: true, | ||
| })).toThrow('multiValueHeadersEnabled is only supported for Lambda targets.'); | ||
| }); |
Contributor
There was a problem hiding this comment.
Suggested change
| test('Throws an error when multiValueHeadersEnabled is true for non-Lambda target type (IP)', () => { | |
| // GIVEN | |
| const app = new cdk.App(); | |
| const stack = new cdk.Stack(app, 'Stack'); | |
| const vpc = new ec2.Vpc(stack, 'VPC'); | |
| // WHEN & THEN | |
| expect(() => new elbv2.ApplicationTargetGroup(stack, 'TargetGroup', { | |
| vpc, | |
| targetType: elbv2.TargetType.IP, | |
| multiValueHeadersEnabled: true, | |
| })).toThrow('multiValueHeadersEnabled is only supported for Lambda targets.'); | |
| }); | |
| test('Throws an error when multiValueHeadersEnabled is true for non-Lambda target type (Instance)', () => { | |
| // GIVEN | |
| const app = new cdk.App(); | |
| const stack = new cdk.Stack(app, 'Stack'); | |
| const vpc = new ec2.Vpc(stack, 'VPC'); | |
| // WHEN & THEN | |
| expect(() => new elbv2.ApplicationTargetGroup(stack, 'TargetGroup', { | |
| vpc, | |
| targetType: elbv2.TargetType.INSTANCE, | |
| multiValueHeadersEnabled: true, | |
| })).toThrow('multiValueHeadersEnabled is only supported for Lambda targets.'); | |
| }); | |
| test.each([elbv2.TargetType.IP, elbv2.TargetType.INSTANCE])('Throws an error when multiValueHeadersEnabled is true for non-Lambda target type (%s)', (targetType) => { | |
| // GIVEN | |
| const app = new cdk.App(); | |
| const stack = new cdk.Stack(app, 'Stack'); | |
| const vpc = new ec2.Vpc(stack, 'VPC'); | |
| // WHEN & THEN | |
| expect(() => new elbv2.ApplicationTargetGroup(stack, 'TargetGroup', { | |
| vpc, | |
| targetType, | |
| multiValueHeadersEnabled: true, | |
| })).toThrow('multiValueHeadersEnabled is only supported for Lambda targets.'); | |
| }); |
|
|
||
| ### Multi-Value Headers with Lambda Targets | ||
|
|
||
| When using a Lambda function as a target, you can enable multi-value headers to allow the load balancer to send headers with multiple values: |
Contributor
There was a problem hiding this comment.
I think it is better to add documentation link.
Suggested change
| When using a Lambda function as a target, you can enable multi-value headers to allow the load balancer to send headers with multiple values: | |
| When using a Lambda function as a target, you can enable [multi-value headers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html#multi-value-headers) to allow the load balancer to send headers with multiple values: |
aws-cdk-automation
removed
the
pr/needs-community-review
…r multi-value headers in Lambda target groups
Contributor
Author
|
@badmintoncryer |
aws-cdk-automation
added
the
pr/needs-maintainer-review
scorbiere
previously approved these changes
May 9, 2025
Contributor
scorbiere
left a comment
scorbiere
left a comment
There was a problem hiding this comment.
Thanks @kawabata-mcl for your contribution.
Note: We usually try to add assertion(s) in the integ test, but in this current case, I think it would make the integ test very complex. That's why I am not asking for this change.
scorbiere
approved these changes
May 9, 2025
Contributor
|
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
removed
the
pr/needs-maintainer-review
Contributor
|
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). |
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Contributor
|
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). |
Contributor
|
Comments on closed issues and PRs are hard for our team to see. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue # (if applicable)
None
Reason for this change
We can set a multi-value headers property for a lambda target group from cloudformation, but this was not supported in the AWS CDK L2 construct.
Description of changes
Add multiValueHeadersEnabled property to ApplicationTargetGroupProps and set it in the ApplicationTargetGroup constructor.
Describe any new or updated permissions being added
None
Description of how you validated changes
Added both unit and integration tests.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license