feat(elasticloadbalancingv2): subnet mappings for network load balancer #33736

badmintoncryer · 2025-03-11T15:18:22Z

Issue # (if applicable)

Closes #9696.

Reason for this change

Cloudformation supports the configuration of subnet information through subnetMapping more detailed than using subnetIds but AWS CDK doesn't support this.

https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html

Description of changes

Add subnetMappings to NetworkLoadBalancerProps
Define SourceNatIpv6Prefix class and SubnetMapping interface at base-loadbalancer.ts

Describe any new or updated permissions being added

None

Description of how you validated changes

Add both unit and integ 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

(This review is outdated)

codecov · 2025-03-13T14:33:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.98%. Comparing base (74cbe27) to head (0de13ae).
Report is 27 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #33736   +/-   ##
=======================================
  Coverage   83.98%   83.98%           
=======================================
  Files         120      120           
  Lines        6976     6976           
  Branches     1178     1178           
=======================================
  Hits         5859     5859           
  Misses       1005     1005           
  Partials      112      112

Flag	Coverage Δ
suite.unit	`83.98% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`∅ <ø> (∅)`
packages/aws-cdk-lib/core	`83.98% <ø> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

badmintoncryer · 2025-03-18T14:30:47Z

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/nlb/network-load-balancer.ts

+      if (props.internetFacing !== true && props.subnetMappings.some(sm => sm.allocationId !== undefined)) {
+        throw new ValidationError('Cannot specify `allocationId` for a internal load balancer.', this);
+      }


This setting causes deployment failure.

Resource handler returned message: "Elastic IPs are not supported for load balancers with scheme 'internal' (Service: ElasticLoadBalancingV2, Status Code: 400, Request ID: 37af9234-ae03-4bc7-a8a5-3a3bc5e08eba) (SDK Attempt Count: 1)" (RequestToken: 7e147881-8745-a761-4deb-0dea575f6352, HandlerErrorCode: InvalidRequest)

badmintoncryer · 2025-03-18T14:31:41Z

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/nlb/network-load-balancer.ts

+      if (props.enablePrefixForIpv6SourceNat !== true && props.subnetMappings.some(sm => sm.sourceNatIpv6Prefix !== undefined)) {
+        throw new ValidationError('Cannot specify `sourceNatIpv6Prefix` for a load balancer that does not have `enablePrefixForIpv6SourceNat` enabled.', this);
+      }


This setting causes deployment failure.

Resource handler returned message: "'EnablePrefixForIpv6SourceNat' must be set to 'on', before 'SourceNatIpv6Prefix' can be specified. (Service: ElasticLoadBalancingV2, Status Code: 400, Request ID: 68ca21fc-6c22-4375-86f5-4fa27b0a7e7b) (SDK Attempt Count: 1)" (RequestToken: f07c93ee-f6ea-d3ad-e24b-9724d5611526, HandlerErrorCode: InvalidRequest)

badmintoncryer · 2025-03-18T14:34:19Z

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/shared/base-load-balancer.ts

+/**
+ * Specifies a subnet for a load balancer
+ */
+export interface SubnetMapping {


Currently, subnetMapping exists only as a configuration item for NLB, but I defined it in base-loadbalancer.ts in anticipation that items for ALB may be added in the future.

paulhcsun

Overall this lgtm, just left a few minor comments.

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/shared/base-load-balancer.ts

paulhcsun · 2025-04-11T00:02:47Z

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/shared/base-load-balancer.ts

+        internetConnectivityEstablished = baseProps.vpc.selectSubnets(
+          { subnetFilters: [ec2.SubnetFilter.byIds(mappedSubnetIds)] },
+        ).internetConnectivityEstablished;


nit: could we rename this variable so it has a different name from the actual property that we're checking when filtering. It feels a bit confusing if they're named the same.

Suggested change

internetConnectivityEstablished = baseProps.vpc.selectSubnets(

{ subnetFilters: [ec2.SubnetFilter.byIds(mappedSubnetIds)] },

).internetConnectivityEstablished;

internetConnectivityEstablishedSubnets = baseProps.vpc.selectSubnets(

{ subnetFilters: [ec2.SubnetFilter.byIds(mappedSubnetIds)] },

).internetConnectivityEstablished;

…e-load-balancer.ts Co-authored-by: paulhcsun <[email protected]>

paulhcsun

Great stuff! Thank you for your contribution on this highly requested feature!

paulhcsun · 2025-04-11T17:25:07Z

@Mergifyio update

mergify · 2025-04-11T17:25:13Z

update

☑️ Nothing to do

#commits-behind > 0 [📌 update requirement]
-closed [📌 update requirement]
-conflict [📌 update requirement]
queue-position = -1 [📌 update requirement]

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/nlb/network-load-balancer.ts

…k-load-balancer.ts

Pull request has been modified.

aws-cdk-automation · 2025-04-11T18:34:01Z

AWS CodeBuild CI Report

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

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

mergify · 2025-04-11T18:34:23Z

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 · 2025-04-11T18:35:28Z

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.

badmintoncryer added 5 commits March 4, 2025 23:45

temp

1ef6bc9

Merge remote-tracking branch 'origin/main' into 9696-subnetMapping

3652087

feat: subnetMappings

2ce49bd

remove comment

b04883c

add subnet mapping

995377f

aws-cdk-automation requested a review from a team March 11, 2025 15:18

github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p1 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Mar 11, 2025

aws-cdk-automation previously requested changes Mar 11, 2025

View reviewed changes

badmintoncryer added 5 commits March 12, 2025 00:30

refactor

3ffe9b6

Merge branch 'main' into 9696-subnetMapping

3687c3c

Merge remote-tracking branch 'origin/main' into 9696-subnetMapping

5749c50

fix

82854aa

refactor

207842f

badmintoncryer added 7 commits March 14, 2025 22:15

temp integ test

6486a7a

update

14a8be6

add integ

363a7d3

add unit test

907fcaf

Merge remote-tracking branch 'origin/main' into 9696-subnetMapping

12f1237

refactor

0536fed

fix specifying ip

dded475

badmintoncryer added 5 commits March 18, 2025 08:39

refactor

da0bfbf

update readme

88c0cd1

refactor

b92c3eb

fix

ceb4bac

update jsdoc

608831d

badmintoncryer commented Mar 18, 2025

View reviewed changes

badmintoncryer added 2 commits March 21, 2025 18:03

Merge branch 'main' into 9696-subnetMapping

2b8e096

fix import order

fa445da

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 21, 2025

Merge branch 'main' into 9696-subnetMapping

138e8dc

badmintoncryer mentioned this pull request Mar 24, 2025

[aws-elasticloadbalancingv2] Add support for SubnetMapping to Network Load Balancer #9696

Closed

2 tasks

Merge branch 'main' into 9696-subnetMapping

2bacdaa

github-actions bot mentioned this pull request Apr 1, 2025

Monthly PR metrics report #33994

Open

Merge branch 'main' into 9696-subnetMapping

3a11746

paulhcsun self-assigned this Apr 9, 2025

Merge branch 'main' into 9696-subnetMapping

25f3349

paulhcsun reviewed Apr 11, 2025

View reviewed changes

badmintoncryer and others added 3 commits April 11, 2025 18:39

Update packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/shared/bas…

d4747cd

…e-load-balancer.ts Co-authored-by: paulhcsun <[email protected]>

update

9c37278

Merge branch 'main' into 9696-subnetMapping

e10e304

paulhcsun previously approved these changes Apr 11, 2025

View reviewed changes

paulhcsun reviewed Apr 11, 2025

View reviewed changes

packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/nlb/network-load-balancer.ts Outdated Show resolved Hide resolved

Update packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/nlb/networ…

0de13ae

…k-load-balancer.ts

paulhcsun approved these changes Apr 11, 2025

View reviewed changes

mergify bot merged commit c6905c6 into aws:main Apr 11, 2025
23 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Apr 11, 2025

badmintoncryer deleted the 9696-subnetMapping branch April 11, 2025 23:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(elasticloadbalancingv2): subnet mappings for network load balancer #33736

feat(elasticloadbalancingv2): subnet mappings for network load balancer #33736

Uh oh!

badmintoncryer commented Mar 11, 2025 •

edited

Loading

Uh oh!

aws-cdk-automation left a comment •

edited

Loading

Uh oh!

codecov bot commented Mar 13, 2025 •

edited

Loading

Uh oh!

badmintoncryer Mar 18, 2025 •

edited

Loading

Uh oh!

badmintoncryer Mar 18, 2025

Uh oh!

badmintoncryer Mar 18, 2025

Uh oh!

paulhcsun left a comment

Uh oh!

Uh oh!

Uh oh!

paulhcsun Apr 11, 2025

Uh oh!

paulhcsun left a comment

Uh oh!

paulhcsun commented Apr 11, 2025

Uh oh!

mergify bot commented Apr 11, 2025

Uh oh!

Uh oh!

aws-cdk-automation commented Apr 11, 2025

Uh oh!

mergify bot commented Apr 11, 2025

Uh oh!

Uh oh!

github-actions bot commented Apr 11, 2025

Uh oh!

Uh oh!

feat(elasticloadbalancingv2): subnet mappings for network load balancer #33736

feat(elasticloadbalancingv2): subnet mappings for network load balancer #33736

Uh oh!

Conversation

badmintoncryer commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue # (if applicable)

Reason for this change

Description of changes

Describe any new or updated permissions being added

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

badmintoncryer Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

badmintoncryer Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

badmintoncryer Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

paulhcsun left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

paulhcsun Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

paulhcsun left a comment

Choose a reason for hiding this comment

Uh oh!

paulhcsun commented Apr 11, 2025

Uh oh!

mergify bot commented Apr 11, 2025

☑️ Nothing to do

Uh oh!

Uh oh!

aws-cdk-automation commented Apr 11, 2025

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Apr 11, 2025

Uh oh!

Uh oh!

github-actions bot commented Apr 11, 2025

Uh oh!

Uh oh!

badmintoncryer commented Mar 11, 2025 •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

codecov bot commented Mar 13, 2025 •

edited

Loading

badmintoncryer Mar 18, 2025 •

edited

Loading