AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-ec2-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IpamProps Struct ​

Options to create a new Ipam in the account.

Stability
Experimental
Source
lib/ipam.ts

Example ​

ts
const stack = new Stack();
const ipam = new Ipam(this, 'Ipam', {
  operatingRegions: ['us-west-1']
});
const ipamPublicPool = ipam.publicScope.addPool('PublicPoolA', {
  addressFamily: AddressFamily.IP_V6,
  awsService: AwsServiceName.EC2,
  locale: 'us-west-1',
  publicIpSource: IpamPoolPublicIpSource.AMAZON,
});
ipamPublicPool.provisionCidr('PublicPoolACidrA', { netmaskLength: 52 } );

const ipamPrivatePool = ipam.privateScope.addPool('PrivatePoolA', {
  addressFamily: AddressFamily.IP_V4,
});
ipamPrivatePool.provisionCidr('PrivatePoolACidrA', { netmaskLength: 8 } );

new VpcV2(this, 'Vpc', {
  primaryAddressBlock: IpAddresses.ipv4('10.0.0.0/24'),
  secondaryAddressBlocks: [
    IpAddresses.amazonProvidedIpv6({ cidrBlockName: 'AmazonIpv6' }),
    IpAddresses.ipv6Ipam({
      ipamPool: ipamPublicPool,
      netmaskLength: 52,
      cidrBlockName: 'ipv6Ipam',
    }),
    IpAddresses.ipv4Ipam({
      ipamPool: ipamPrivatePool,
      netmaskLength: 8,
      cidrBlockName: 'ipv4Ipam',
    }),
  ],
});

Properties ​

ipamNameoptionalstringipam_nameoptionalstripamNameoptionalStringIpamNameoptionalstringIpamNameoptional*string#
Name of IPAM that can be used for tagging resource.

Default: If no name provided, no tags will be added to the IPAM

operatingRegionsoptionalstring[]operating_regionsoptionaltyping.List[str]operatingRegionsoptionalList<String>OperatingRegionsoptionalstring[]OperatingRegionsoptional*[]*string#
The operating Regions for an IPAM.

Default: Stack.region if defined in the stack

notes

Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .