Package software.amazon.awscdk.services.ec2

Class CfnIPAMAllocation

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.CfnIPAMAllocation
All Implemented Interfaces:
IInspectable, IIPAMAllocationRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.746Z") @Stability(Stable) public class CfnIPAMAllocation extends CfnResource implements IInspectable, IIPAMAllocationRef
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.

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.*;
 CfnIPAMAllocation cfnIPAMAllocation = CfnIPAMAllocation.Builder.create(this, "MyCfnIPAMAllocation")
         .ipamPoolId("ipamPoolId")
         // the properties below are optional
         .cidr("cidr")
         .description("description")
         .netmaskLength(123)
         .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

    • CfnIPAMAllocation

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

    • CfnIPAMAllocation

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

    • CfnIPAMAllocation

      @Stability(Stable) public CfnIPAMAllocation(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIPAMAllocationProps props)
      Create a new AWS::EC2::IPAMAllocation.

      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

    • isCfnIPAMAllocation

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

      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.

    • getAttrIpamPoolAllocationId

      @Stability(Stable) @NotNull public String getAttrIpamPoolAllocationId()
      The ID of an allocation.

    • getCfnProperties

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

    • getIpamAllocationRef

      @Stability(Stable) @NotNull public IPAMAllocationReference getIpamAllocationRef()
      A reference to a IPAMAllocation resource.
      Specified by:
      getIpamAllocationRef in interface IIPAMAllocationRef

    • getIpamPoolId

      @Stability(Stable) @NotNull public String getIpamPoolId()
      The ID of the IPAM pool from which you would like to allocate a CIDR.

    • setIpamPoolId

      @Stability(Stable) public void setIpamPoolId(@NotNull String value)
      The ID of the IPAM pool from which you would like to allocate a CIDR.

    • getCidr

      @Stability(Stable) @Nullable public String getCidr()
      The CIDR you would like to allocate from the IPAM pool.

      Note the following:.

    • setCidr

      @Stability(Stable) public void setCidr(@Nullable String value)
      The CIDR you would like to allocate from the IPAM pool.

      Note the following:.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the allocation.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the allocation.

    • getNetmaskLength

      @Stability(Stable) @Nullable public Number getNetmaskLength()
      The netmask length of the CIDR you would like to allocate from the IPAM pool.

      Note the following:.

    • setNetmaskLength

      @Stability(Stable) public void setNetmaskLength(@Nullable Number value)
      The netmask length of the CIDR you would like to allocate from the IPAM pool.

      Note the following:.