AWS CDK Reference

Appearance

v2.275.0

CfnIPAMProps Struct ​

Properties for defining a CfnIPAM.

Source
Generated code
Type last changed
v2.197.0 · 21 May 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnIPAMProps: ec2.CfnIPAMProps = {
  defaultResourceDiscoveryOrganizationalUnitExclusions: [{
    organizationsEntityPath: 'organizationsEntityPath',
  }],
  description: 'description',
  enablePrivateGua: false,
  meteredAccount: 'meteredAccount',
  operatingRegions: [{
    regionName: 'regionName',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tier: 'tier',
};

Properties ​

defaultResourceDiscoveryOrganizationalUnitExclusionsoptionalIResolvable | IResolvable | CfnIPAM.IpamOrganizationalUnitExclusionProperty[]default_resource_discovery_organizational_unit_exclusionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IpamOrganizationalUnitExclusionProperty]]]defaultResourceDiscoveryOrganizationalUnitExclusionsoptionalIResolvableDefaultResourceDiscoveryOrganizationalUnitExclusionsoptionalIResolvableDefaultResourceDiscoveryOrganizationalUnitExclusionsoptionalinterface{}#
If your IPAM is integrated with AWS Organizations, you can exclude an [organizational unit (OU)](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#organizationalunit) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see [Exclude organizational units from IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html) in the *Amazon Virtual Private Cloud IP Address Manager User Guide* .
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description for the IPAM.
enablePrivateGuaoptionalboolean | IResolvableenable_private_guaoptionaltyping.Union[bool, IResolvable]enablePrivateGuaoptionalBooleanEnablePrivateGuaoptionalboolEnablePrivateGuaoptionalinterface{}#
Enable this option to use your own GUA ranges as private IPv6 addresses.

This option is disabled by default.

meteredAccountoptionalstringmetered_accountoptionalstrmeteredAccountoptionalStringMeteredAccountoptionalstringMeteredAccountoptional*string#
A metered account is an AWS account that is charged for active IP addresses managed in IPAM.
notes

For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide .

Possible values:

  • ipam-owner (default): The AWS account which owns the IPAM is charged for all active IP addresses managed in IPAM.
  • resource-owner : The AWS account that owns the IP address is charged for the active IP address.
operatingRegionsoptionalIResolvable | IResolvable | CfnIPAM.IpamOperatingRegionProperty[]operating_regionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IpamOperatingRegionProperty]]]operatingRegionsoptionalIResolvableOperatingRegionsoptionalIResolvableOperatingRegionsoptionalinterface{}#
The operating Regions for an IPAM.
notes

Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The key/value combination of a tag assigned to the resource.
notes

Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

tieroptionalstringtieroptionalstrtieroptionalStringTieroptionalstringTieroptional*string#
IPAM is offered in a Free Tier and an Advanced Tier.

For more information about the features available in each tier and the costs associated with the tiers, see the VPC IPAM product pricing page .