Package software.amazon.awscdk.services.ec2

Class CfnIPAM

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnIPAM
All Implemented Interfaces:
IInspectable, IIPAMRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:02.919Z") @Stability(Stable) public class CfnIPAM extends CfnResource implements IInspectable, IIPAMRef, ITaggable
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.services.ec2.*;
 CfnIPAM cfnIPAM = CfnIPAM.Builder.create(this, "MyCfnIPAM")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIPAM

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

    • CfnIPAM

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

    • CfnIPAM

      @Stability(Stable) public CfnIPAM(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnIPAMProps props)
      Create a new AWS::EC2::IPAM.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnIPAM

      @Stability(Stable) public CfnIPAM(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::EC2::IPAM.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromIPAMArn

      @Stability(Stable) @NotNull public static IIPAMRef fromIPAMArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IIPAMRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromIpamId

      @Stability(Stable) @NotNull public static IIPAMRef fromIpamId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String ipamId)
      Creates a new IIPAMRef from a ipamId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      ipamId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the IPAM.

    • getAttrDefaultResourceDiscoveryAssociationId

      @Stability(Stable) @NotNull public String getAttrDefaultResourceDiscoveryAssociationId()
      The ID of the default resource discovery association.

    • getAttrDefaultResourceDiscoveryId

      @Stability(Stable) @NotNull public String getAttrDefaultResourceDiscoveryId()
      The ID of the default resource discovery.

    • getAttrIpamId

      @Stability(Stable) @NotNull public String getAttrIpamId()
      The ID of the IPAM.

    • getAttrPrivateDefaultScopeId

      @Stability(Stable) @NotNull public String getAttrPrivateDefaultScopeId()
      The ID of the default private scope.

    • getAttrPublicDefaultScopeId

      @Stability(Stable) @NotNull public String getAttrPublicDefaultScopeId()
      The ID of the default public scope.

    • getAttrResourceDiscoveryAssociationCount

      @Stability(Stable) @NotNull public Number getAttrResourceDiscoveryAssociationCount()
      The number of resource discovery associations.

    • getAttrScopeCount

      @Stability(Stable) @NotNull public Number getAttrScopeCount()
      The number of scopes.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIpamRef

      @Stability(Stable) @NotNull public IPAMReference getIpamRef()
      A reference to a IPAM resource.
      Specified by:
      getIpamRef in interface IIPAMRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDefaultResourceDiscoveryOrganizationalUnitExclusions

      @Stability(Stable) @Nullable public 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 CfnIPAM.IpamOrganizationalUnitExclusionProperty>

    • setDefaultResourceDiscoveryOrganizationalUnitExclusions

      @Stability(Stable) public void setDefaultResourceDiscoveryOrganizationalUnitExclusions(@Nullable IResolvable value)
      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 .

    • setDefaultResourceDiscoveryOrganizationalUnitExclusions

      @Stability(Stable) public void setDefaultResourceDiscoveryOrganizationalUnitExclusions(@Nullable List<Object> value)
      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 .

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description for the IPAM.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description for the IPAM.

    • getEnablePrivateGua

      @Stability(Stable) @Nullable public Object getEnablePrivateGua()
      Enable this option to use your own GUA ranges as private IPv6 addresses.

      Returns union: either Boolean or IResolvable

    • setEnablePrivateGua

      @Stability(Stable) public void setEnablePrivateGua(@Nullable Boolean value)
      Enable this option to use your own GUA ranges as private IPv6 addresses.

    • setEnablePrivateGua

      @Stability(Stable) public void setEnablePrivateGua(@Nullable IResolvable value)
      Enable this option to use your own GUA ranges as private IPv6 addresses.

    • getMeteredAccount

      @Stability(Stable) @Nullable public String getMeteredAccount()
      A metered account is an AWS account that is charged for active IP addresses managed in IPAM.

    • setMeteredAccount

      @Stability(Stable) public void setMeteredAccount(@Nullable String value)
      A metered account is an AWS account that is charged for active IP addresses managed in IPAM.

    • getOperatingRegions

      @Stability(Stable) @Nullable public Object getOperatingRegions()
      The operating Regions for an IPAM.

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

    • setOperatingRegions

      @Stability(Stable) public void setOperatingRegions(@Nullable IResolvable value)
      The operating Regions for an IPAM.

    • setOperatingRegions

      @Stability(Stable) public void setOperatingRegions(@Nullable List<Object> value)
      The operating Regions for an IPAM.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The key/value combination of a tag assigned to the resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The key/value combination of a tag assigned to the resource.

    • getTier

      @Stability(Stable) @Nullable public String getTier()
      IPAM is offered in a Free Tier and an Advanced Tier.

    • setTier

      @Stability(Stable) public void setTier(@Nullable String value)
      IPAM is offered in a Free Tier and an Advanced Tier.