(@aws-cdk/aws-ec2-alpha): Optional locale on IPAM pool is not optional

[pemattr]

Describe the bug

https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-ec2-alpha.PoolOptions.html

The above defines locale as an optional string but when trying to synth it fails with the below error.

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

Undefined is accepted and a default is used? But considering I'm providing multiple operatingRegions maybe that isn't possible

Current Behavior

/home/..../node_modules/@aws-cdk/aws-ec2-alpha/lib/ipam.ts:582
    throw new Error(`The provided locale '${poolOptions.locale}' is not in the operating regions.`);
          ^
Error: The provided locale 'undefined' is not in the operating regions.
    at createIpamPool (/home/..../node_modules/@aws-cdk/aws-ec2-alpha/lib/ipam.ts:582:11)
    at IpamScopeBase.addPool (/home/..../node_modules/@aws-cdk/aws-ec2-alpha/lib/ipam.ts:466:12)
    at Object.<anonymous> (/home/..../src/index.ts:19:19)
    at Module._compile (node:internal/modules/cjs/loader:1554:14)
    at Module.m._compile (/home/..../node_modules/ts-node/src/index.ts:1618:23)
    at node:internal/modules/cjs/loader:1706:10
    at Object.require.extensions.<computed> [as .ts] (/home/..../node_modules/ts-node/src/index.ts:1621:12)
    at Module.load (node:internal/modules/cjs/loader:1289:32)
    at Function._load (node:internal/modules/cjs/loader:1108:12)
    at TracingChannel.traceSync (node:diagnostics_channel:322:14)
Subprocess exited with error 1

Reproduction Steps

import { App, Stack } from 'aws-cdk-lib';
import { AddressFamily, Ipam } from '@aws-cdk/aws-ec2-alpha';
const app = new App();

const stack = new Stack(app, 'Stack');

const ipam = new Ipam(stack, 'Ipam');

ipam.privateScope.addPool('Pool', {
  addressFamily: AddressFamily.IP_V4,
});

Possible Solution

locale probably needs to be made non-optional

Additional Information/Context

No response

CDK CLI Version

2.1010.0 (build 6b421db)

Framework Version

No response

Node.js Version

v22.14.0

OS

Windows 11 WSL2 Ubuntu 24.04.2 LTS

Language

TypeScript

Language Version

No response

Other information

No response

[ykethan]

Hey @pemattr, thank you for reporting this issue. I was indeed to able to run into this error message when utilizing the following

import { AddressFamily, Ipam } from "@aws-cdk/aws-ec2-alpha";
import { App, Stack } from "aws-cdk-lib";

export class Repro34179Stack extends Stack {
  constructor(scope: App, id: string) {
    super(scope, id);

    const ipam = new Ipam(this, "Ipam");
    ipam.privateScope.addPool("Pool", {
      addressFamily: AddressFamily.IP_V4,
    });
  }
}

The locale does appear to be an optional property as well on CloudFormation documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-locale) but the operation does appear to determine the operating region from locale.

aws-cdk/packages/@aws-cdk/aws-ec2-alpha/lib/ipam.ts

Lines 569 to 583 in 0438773

	function createIpamPool(
	scope: Construct,
	id: string,
	scopeOptions: IpamScopeProps,
	poolOptions: PoolOptions,
	scopeId: string,
	): IpamPool {
	const isLocaleInOperatingRegions = scopeOptions.ipamOperatingRegions
	? scopeOptions.ipamOperatingRegions.map(region => ({ regionName: region }))
	.some(region => region.regionName === poolOptions.locale)
	: false;
	if (!isLocaleInOperatingRegions) {
	throw new Error(`The provided locale '${poolOptions.locale}' is not in the operating regions.`);
	}

similar to #34178, we will need to update the logic and feature gaps to provide a better experience with this construct.

From the top of the my mind we may need to make the locale as required with possibly a enum with the supported operating regions.

on additional, testing noticed passing in supported Local Zones as locale did not mitigate the issue.

import { AddressFamily, Ipam } from "@aws-cdk/aws-ec2-alpha";
import { App, Stack } from "aws-cdk-lib";

export class Repro34179Stack extends Stack {
  constructor(scope: App, id: string) {
    super(scope, id);

    const ipam = new Ipam(this, "Ipam");
    ipam.privateScope.addPool("Pool", {
      addressFamily: AddressFamily.IP_V4,
      locale: "us-east-1-msp-1",
    });
  }
}

[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.