Package software.amazon.awscdk.services.ec2

Class CfnIPAMAllocation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ec2.CfnIPAMAllocation
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.576Z") @Stability(Stable) public class CfnIPAMAllocation extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::IPAMAllocation.

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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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

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

      • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
      • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

      Possible values: Any available IPv4 or IPv6 CIDR.

    • setCidr

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

      • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
      • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

      Possible values: Any available IPv4 or IPv6 CIDR.

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

      • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
      • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

      Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

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

      • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
      • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

      Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.