NetworkConfig / VpcConfig | VpcTemplatesConfig / (SubnetConfig) / IpamAllocationConfig

VPC IPAM allocation configuration.

Use this configuration to dynamically assign a VPC or subnet CIDR from an IPAM pool.

VPC allocations:

- ipamPoolName: accelerator-regional-pool
netmaskLength: 24

Subnet allocations:

ipamPoolName: accelerator-regional-pool
netmaskLength: 24
interface IIpamAllocationConfig {
    ipamPoolName: string;
    netmaskLength: number;
}

Properties

ipamPoolName: string

The IPAM pool name to request the allocation from.

CAUTION: Changing this property value after initial deployment causes the VPC or subnet to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

This is the logical name property of the IPAM pool as defined in network-config.yaml. The IPAM pool referenced must either be deployed to or have shareTargets configured for the account(s)/OU(s) that will be requesting the allocation.

IpamPoolConfig

netmaskLength: number

The subnet mask length to request.

CAUTION: Changing this property value after initial deployment causes the VPC or subnet to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

Specify only the CIDR prefix length for the subnet, i.e. 24. If the IPAM pool referenced in ipamPoolName does not have enough space for this allocation, resource creation will fail.

IpamPoolConfig