Package software.amazon.awscdk.services.ec2

Class CfnIPAMPool

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.CfnIPAMPool
All Implemented Interfaces:
IInspectable, IIPAMPoolRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:34.767Z") @Stability(Stable) public class CfnIPAMPool extends CfnResource implements IInspectable, IIPAMPoolRef, ITaggable
In IPAM, a pool is a collection of contiguous IP addresses CIDRs.

Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

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.*;
 CfnIPAMPool cfnIPAMPool = CfnIPAMPool.Builder.create(this, "MyCfnIPAMPool")
         .addressFamily("addressFamily")
         .ipamScopeId("ipamScopeId")
         // the properties below are optional
         .allocationDefaultNetmaskLength(123)
         .allocationMaxNetmaskLength(123)
         .allocationMinNetmaskLength(123)
         .allocationResourceTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .autoImport(false)
         .awsService("awsService")
         .description("description")
         .locale("locale")
         .provisionedCidrs(List.of(ProvisionedCidrProperty.builder()
                 .cidr("cidr")
                 .build()))
         .publicIpSource("publicIpSource")
         .publiclyAdvertisable(false)
         .sourceIpamPoolId("sourceIpamPoolId")
         .sourceResource(SourceResourceProperty.builder()
                 .resourceId("resourceId")
                 .resourceOwner("resourceOwner")
                 .resourceRegion("resourceRegion")
                 .resourceType("resourceType")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnIPAMPool

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

    • CfnIPAMPool

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

    • CfnIPAMPool

      @Stability(Stable) public CfnIPAMPool(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIPAMPoolProps props)
      Create a new AWS::EC2::IPAMPool.

      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. This parameter is required.

  • Method Details

    • arnForIPAMPool

      @Stability(Stable) @NotNull public static String arnForIPAMPool(@NotNull IIPAMPoolRef resource)
      Parameters:
      resource - This parameter is required.

    • fromIPAMPoolArn

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

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

    • fromIpamPoolId

      @Stability(Stable) @NotNull public static IIPAMPoolRef fromIpamPoolId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String ipamPoolId)
      Creates a new IIPAMPoolRef from a ipamPoolId.

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

    • isCfnIPAMPool

      @Stability(Stable) @NotNull public static Boolean isCfnIPAMPool(@NotNull Object x)
      Checks whether the given object is a CfnIPAMPool.

      Parameters:
      x - 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 pool.

    • getAttrIpamArn

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

    • getAttrIpamPoolId

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

    • getAttrIpamScopeArn

      @Stability(Stable) @NotNull public String getAttrIpamScopeArn()
      The ARN of the scope of the IPAM pool.

    • getAttrIpamScopeType

      @Stability(Stable) @NotNull public String getAttrIpamScopeType()
      The scope of the IPAM.

    • getAttrPoolDepth

      @Stability(Stable) @NotNull public Number getAttrPoolDepth()
      The depth of pools in your IPAM pool.

      The pool depth quota is 10.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the IPAM pool.

    • getAttrStateMessage

      @Stability(Stable) @NotNull public String getAttrStateMessage()
      A message related to the failed creation of an IPAM pool.

    • getCfnProperties

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

    • getIpamPoolRef

      @Stability(Stable) @NotNull public IPAMPoolReference getIpamPoolRef()
      A reference to a IPAMPool resource.
      Specified by:
      getIpamPoolRef in interface IIPAMPoolRef

    • getTags

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

    • getAddressFamily

      @Stability(Stable) @NotNull public String getAddressFamily()
      The address family of the pool.

    • setAddressFamily

      @Stability(Stable) public void setAddressFamily(@NotNull String value)
      The address family of the pool.

    • getIpamScopeId

      @Stability(Stable) @NotNull public String getIpamScopeId()
      The ID of the scope in which you would like to create the IPAM pool.

    • setIpamScopeId

      @Stability(Stable) public void setIpamScopeId(@NotNull String value)
      The ID of the scope in which you would like to create the IPAM pool.

    • getAllocationDefaultNetmaskLength

      @Stability(Stable) @Nullable public Number getAllocationDefaultNetmaskLength()
      The default netmask length for allocations added to this pool.

    • setAllocationDefaultNetmaskLength

      @Stability(Stable) public void setAllocationDefaultNetmaskLength(@Nullable Number value)
      The default netmask length for allocations added to this pool.

    • getAllocationMaxNetmaskLength

      @Stability(Stable) @Nullable public Number getAllocationMaxNetmaskLength()
      The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.

    • setAllocationMaxNetmaskLength

      @Stability(Stable) public void setAllocationMaxNetmaskLength(@Nullable Number value)
      The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.

    • getAllocationMinNetmaskLength

      @Stability(Stable) @Nullable public Number getAllocationMinNetmaskLength()
      The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.

    • setAllocationMinNetmaskLength

      @Stability(Stable) public void setAllocationMinNetmaskLength(@Nullable Number value)
      The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.

    • getAllocationResourceTags

      @Stability(Stable) @Nullable public Object getAllocationResourceTags()
      Tags that are required for resources that use CIDRs from this IPAM pool.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTag>

    • setAllocationResourceTags

      @Stability(Stable) public void setAllocationResourceTags(@Nullable IResolvable value)
      Tags that are required for resources that use CIDRs from this IPAM pool.

    • setAllocationResourceTags

      @Stability(Stable) public void setAllocationResourceTags(@Nullable List<Object> value)
      Tags that are required for resources that use CIDRs from this IPAM pool.

    • getAutoImport

      @Stability(Stable) @Nullable public Object getAutoImport()
      If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.

      Returns union: either Boolean or IResolvable

    • setAutoImport

      @Stability(Stable) public void setAutoImport(@Nullable Boolean value)
      If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.

    • setAutoImport

      @Stability(Stable) public void setAutoImport(@Nullable IResolvable value)
      If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.

    • getAwsService

      @Stability(Stable) @Nullable public String getAwsService()
      Limits which service in AWS that the pool can be used in.

    • setAwsService

      @Stability(Stable) public void setAwsService(@Nullable String value)
      Limits which service in AWS that the pool can be used in.

    • getDescription

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

    • setDescription

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

    • getLocale

      @Stability(Stable) @Nullable public String getLocale()
      The locale of the IPAM pool.

    • setLocale

      @Stability(Stable) public void setLocale(@Nullable String value)
      The locale of the IPAM pool.

    • getProvisionedCidrs

      @Stability(Stable) @Nullable public Object getProvisionedCidrs()
      Information about the CIDRs provisioned to an IPAM pool.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnIPAMPool.ProvisionedCidrProperty>

    • setProvisionedCidrs

      @Stability(Stable) public void setProvisionedCidrs(@Nullable IResolvable value)
      Information about the CIDRs provisioned to an IPAM pool.

    • setProvisionedCidrs

      @Stability(Stable) public void setProvisionedCidrs(@Nullable List<Object> value)
      Information about the CIDRs provisioned to an IPAM pool.

    • getPublicIpSource

      @Stability(Stable) @Nullable public String getPublicIpSource()
      The IP address source for pools in the public scope.

    • setPublicIpSource

      @Stability(Stable) public void setPublicIpSource(@Nullable String value)
      The IP address source for pools in the public scope.

    • getPubliclyAdvertisable

      @Stability(Stable) @Nullable public Object getPubliclyAdvertisable()
      Determines if a pool is publicly advertisable.

      Returns union: either Boolean or IResolvable

    • setPubliclyAdvertisable

      @Stability(Stable) public void setPubliclyAdvertisable(@Nullable Boolean value)
      Determines if a pool is publicly advertisable.

    • setPubliclyAdvertisable

      @Stability(Stable) public void setPubliclyAdvertisable(@Nullable IResolvable value)
      Determines if a pool is publicly advertisable.

    • getSourceIpamPoolId

      @Stability(Stable) @Nullable public String getSourceIpamPoolId()
      The ID of the source IPAM pool.

    • setSourceIpamPoolId

      @Stability(Stable) public void setSourceIpamPoolId(@Nullable String value)
      The ID of the source IPAM pool.

    • getSourceResource

      @Stability(Stable) @Nullable public Object getSourceResource()
      The resource used to provision CIDRs to a resource planning pool.

      Returns union: either IResolvable or CfnIPAMPool.SourceResourceProperty

    • setSourceResource

      @Stability(Stable) public void setSourceResource(@Nullable IResolvable value)
      The resource used to provision CIDRs to a resource planning pool.

    • setSourceResource

      @Stability(Stable) public void setSourceResource(@Nullable CfnIPAMPool.SourceResourceProperty value)
      The resource used to provision CIDRs to a resource planning pool.

    • 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.