Package software.amazon.awscdk.services.ec2.alpha

Interface IpamPoolCidrProvisioningOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IpamPoolCidrProvisioningOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:49.807Z")
@Stability(Experimental)
public interface IpamPoolCidrProvisioningOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options to provision CIDRs to an IPAM pool.

Used to create a new IpamPoolCidr

Example:

 Stack stack = new Stack();
 Ipam ipam = Ipam.Builder.create(this, "Ipam")
         .operatingRegions(List.of("us-west-1"))
         .build();
 IIpamPool ipamPublicPool = ipam.publicScope.addPool("PublicPoolA", PoolOptions.builder()
         .addressFamily(AddressFamily.IP_V6)
         .awsService(AwsServiceName.EC2)
         .locale("us-west-1")
         .publicIpSource(IpamPoolPublicIpSource.AMAZON)
         .build());
 ipamPublicPool.provisionCidr("PublicPoolACidrA", IpamPoolCidrProvisioningOptions.builder().netmaskLength(52).build());
 IIpamPool ipamPrivatePool = ipam.privateScope.addPool("PrivatePoolA", PoolOptions.builder()
         .addressFamily(AddressFamily.IP_V4)
         .build());
 ipamPrivatePool.provisionCidr("PrivatePoolACidrA", IpamPoolCidrProvisioningOptions.builder().netmaskLength(8).build());
 VpcV2.Builder.create(this, "Vpc")
         .primaryAddressBlock(IpAddresses.ipv4("10.0.0.0/24"))
         .secondaryAddressBlocks(List.of(IpAddresses.amazonProvidedIpv6(SecondaryAddressProps.builder().cidrBlockName("AmazonIpv6").build()), IpAddresses.ipv6Ipam(IpamOptions.builder()
                 .ipamPool(ipamPublicPool)
                 .netmaskLength(52)
                 .cidrBlockName("ipv6Ipam")
                 .build()), IpAddresses.ipv4Ipam(IpamOptions.builder()
                 .ipamPool(ipamPrivatePool)
                 .netmaskLength(8)
                 .cidrBlockName("ipv4Ipam")
                 .build())))
         .build();
 

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IpamPoolCidrProvisioningOptions.Builder	A builder for IpamPoolCidrProvisioningOptions
static final class	IpamPoolCidrProvisioningOptions.Jsii$Proxy	An implementation for IpamPoolCidrProvisioningOptions

Method Summary

Modifier and Type	Method	Description
static IpamPoolCidrProvisioningOptions.Builder	builder()
default String	getCidr()	(experimental) Ipv6 CIDR block for the IPAM pool.
default Number	getNetmaskLength()	(experimental) Ipv6 Netmask length for the CIDR.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCidr

@Stability(Experimental)
@Nullable
default String getCidr()

(experimental) Ipv6 CIDR block for the IPAM pool.

Default: - pool provisioned without netmask length, need netmask length in this case

getNetmaskLength

@Stability(Experimental)
@Nullable
default Number getNetmaskLength()

(experimental) Ipv6 Netmask length for the CIDR.

Default: - pool provisioned without netmask length, need cidr range in this case

builder

@Stability(Experimental)
static IpamPoolCidrProvisioningOptions.Builder builder()

Returns:

a IpamPoolCidrProvisioningOptions.Builder of IpamPoolCidrProvisioningOptions