AWS::EC2::IPAMCfnIPAM
IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization. For more information, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* . There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see [Example policy](https://docs.aws.amazon.com/vpc/latest/ipam/iam-ipam-policy-examples.html) in the *Amazon VPC IPAM User Guide* .
Import
import { CfnIPAM } from 'aws-cdk-lib/aws-ec2';Or use the module namespace:
import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.CfnIPAMProperties
Configuration passed to the constructor as CfnIPAMProps.
defaultResourceDiscoveryOrganizationalUnitExclusionsOptionalIResolvable | IResolvable | IpamOrganizationalUnitExclusionProperty[]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* .
descriptionOptionalstringThe description for the IPAM.
enablePrivateGuaOptionalboolean | IResolvableEnable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
meteredAccountOptionalstringA metered account is an AWS account that is charged for active IP addresses managed in IPAM. For more information, see [Enable cost distribution](https://docs.aws.amazon.com/vpc/latest/ipam/ipam-enable-cost-distro.html) 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 | IpamOperatingRegionProperty[]The operating Regions for an IPAM. 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](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide* .
tagsOptionalCfnTag[]The key/value combination of a tag assigned to the resource. 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.
tierOptionalstringIPAM 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](https://docs.aws.amazon.com/vpc/pricing/) .
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Get the Amazon EC2 Cheat Sheet
Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-ec2AWS::EC2::IPAM