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

Class CfnIPAMPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnIPAMPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.429Z")
@Stability(Stable)
public class CfnIPAMPropsMixin
extends Mixin
implements software.constructs.IMixin

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

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnIPAMPropsMixin cfnIPAMPropsMixin = CfnIPAMPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnIPAMPropsMixin.Builder	A fluent builder for CfnIPAMPropsMixin.
static interface	CfnIPAMPropsMixin.IpamOperatingRegionProperty	The operating Regions for an IPAM.
static interface	CfnIPAMPropsMixin.IpamOrganizationalUnitExclusionProperty	If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnIPAMPropsMixin(CfnIPAMMixinProps props)	Create a mixin to apply properties to AWS::EC2::IPAM.
	CfnIPAMPropsMixin(CfnIPAMMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::EC2::IPAM.
protected	CfnIPAMPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIPAMPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnIPAMMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnIPAMPropsMixin

protected CfnIPAMPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnIPAMPropsMixin

protected CfnIPAMPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnIPAMPropsMixin

@Stability(Stable)
public CfnIPAMPropsMixin(@NotNull
 CfnIPAMMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::EC2::IPAM.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnIPAMPropsMixin

@Stability(Stable)
public CfnIPAMPropsMixin(@NotNull
 CfnIPAMMixinProps props)

Create a mixin to apply properties to AWS::EC2::IPAM.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnIPAMMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()