Package software.amazon.awscdk.services.ec2

Class CfnIPv4Pool

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.CfnIPv4Pool
All Implemented Interfaces:
IInspectable, IIPv4PoolRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:49.989Z") @Stability(Stable) public class CfnIPv4Pool extends CfnResource implements IInspectable, IIPv4PoolRef, ITaggableV2
Resource Type definition for AWS::EC2::IPv4Pool.

A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to AWS to manage with IPAM (BYOIP).

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.*;
 CfnIPv4Pool cfnIPv4Pool = CfnIPv4Pool.Builder.create(this, "MyCfnIPv4Pool")
         .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

    • CfnIPv4Pool

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

    • CfnIPv4Pool

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

    • CfnIPv4Pool

      @Stability(Stable) public CfnIPv4Pool(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnIPv4PoolProps props)
      Create a new AWS::EC2::IPv4Pool.

      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.

    • CfnIPv4Pool

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

      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

    • arnForIPv4Pool

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

    • isCfnIPv4Pool

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

      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 Amazon Resource Name (ARN) of the public IPv4 pool.

    • getAttrDescription

      @Stability(Stable) @NotNull public String getAttrDescription()
      A description of the public IPv4 pool.

    • getAttrNetworkBorderGroup

      @Stability(Stable) @NotNull public String getAttrNetworkBorderGroup()
      The name of the location from which the address pool is advertised.

    • getAttrPoolId

      @Stability(Stable) @NotNull public String getAttrPoolId()
      The ID of the public IPv4 pool.

    • getAttrTotalAddressCount

      @Stability(Stable) @NotNull public Number getAttrTotalAddressCount()
      The total number of addresses in the pool.

    • getAttrTotalAvailableAddressCount

      @Stability(Stable) @NotNull public Number getAttrTotalAvailableAddressCount()
      The total number of available addresses in the pool.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getIPv4PoolRef

      @Stability(Stable) @NotNull public IPv4PoolReference getIPv4PoolRef()
      A reference to a IPv4Pool resource.
      Specified by:
      getIPv4PoolRef in interface IIPv4PoolRef

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Any tags assigned to the public IPv4 pool.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Any tags assigned to the public IPv4 pool.