Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Interface CfnIPAMMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIPAMMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.420Z")
@Stability(Stable)
public interface CfnIPAMMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnIPAMPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ec2.*;
 CfnIPAMMixinProps cfnIPAMMixinProps = CfnIPAMMixinProps.builder()
         .defaultResourceDiscoveryOrganizationalUnitExclusions(List.of(IpamOrganizationalUnitExclusionProperty.builder()
                 .organizationsEntityPath("organizationsEntityPath")
                 .build()))
         .description("description")
         .enablePrivateGua(false)
         .meteredAccount("meteredAccount")
         .operatingRegions(List.of(IpamOperatingRegionProperty.builder()
                 .regionName("regionName")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tier("tier")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIPAMMixinProps.Builder	builder()
default Object	getDefaultResourceDiscoveryOrganizationalUnitExclusions()	If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM.
default String	getDescription()	The description for the IPAM.
default Object	getEnablePrivateGua()	Enable this option to use your own GUA ranges as private IPv6 addresses.
default String	getMeteredAccount()	A metered account is an AWS account that is charged for active IP addresses managed in IPAM.
default Object	getOperatingRegions()	The operating Regions for an IPAM.
default List<CfnTag>	getTags()	The key/value combination of a tag assigned to the resource.
default String	getTier()	IPAM is offered in a Free Tier and an Advanced Tier.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultResourceDiscoveryOrganizationalUnitExclusions

@Stability(Stable)
@Nullable
default Object getDefaultResourceDiscoveryOrganizationalUnitExclusions()

If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) 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 in the Amazon Virtual Private Cloud IP Address Manager User Guide .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnIPAMPropsMixin.IpamOrganizationalUnitExclusionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-defaultresourcediscoveryorganizationalunitexclusions

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description for the IPAM.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-description

getEnablePrivateGua

@Stability(Stable)
@Nullable
default Object getEnablePrivateGua()

Enable this option to use your own GUA ranges as private IPv6 addresses.

This option is disabled by default.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-enableprivategua

getMeteredAccount

@Stability(Stable)
@Nullable
default String getMeteredAccount()

A metered account is an AWS account that is charged for active IP addresses managed in IPAM.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-meteredaccount

getOperatingRegions

@Stability(Stable)
@Nullable
default Object getOperatingRegions()

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 in the Amazon VPC IPAM User Guide .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnIPAMPropsMixin.IpamOperatingRegionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tags

getTier

@Stability(Stable)
@Nullable
default String getTier()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tier

builder

@Stability(Stable)
static CfnIPAMMixinProps.Builder builder()

Returns:

a CfnIPAMMixinProps.Builder of CfnIPAMMixinProps