Package software.amazon.awscdk.services.ec2

Class CfnIPAMPool

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.CfnIPAMPool
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.580Z") @Stability(Stable) public class CfnIPAMPool extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::IPAMPool.

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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnIPAMPool

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

    • CfnIPAMPool

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

    • CfnIPAMPool

      @Stability(Stable) public CfnIPAMPool(@NotNull 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 -
      • 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.

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The key/value combination of a tag assigned to the resource.

      Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

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

      If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

    • setAllocationDefaultNetmaskLength

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

      If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

    • getAllocationMaxNetmaskLength

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

      The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

    • setAllocationMaxNetmaskLength

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

      The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

    • getAllocationMinNetmaskLength

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

      The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

    • setAllocationMinNetmaskLength

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

      The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

    • getAllocationResourceTags

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

      Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

    • setAllocationResourceTags

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

      Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

    • setAllocationResourceTags

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

      Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

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

      The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

      A locale must be set on the pool for this feature to work.

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

      The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

      A locale must be set on the pool for this feature to work.

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

      The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

      A locale must be set on the pool for this feature to work.

    • getAwsService

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

      "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

    • setAwsService

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

      "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

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

      In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

    • setLocale

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

      In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

    • getProvisionedCidrs

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

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

      Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP . For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide .

    • setPublicIpSource

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

      Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP . For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide .

    • getPubliclyAdvertisable

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

      This option is not available for pools with AddressFamily set to ipv4 .

    • setPubliclyAdvertisable

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

      This option is not available for pools with AddressFamily set to ipv4 .

    • setPubliclyAdvertisable

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

      This option is not available for pools with AddressFamily set to ipv4 .

    • getSourceIpamPoolId

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

      You can use this option to create an IPAM pool within an existing source pool.

    • setSourceIpamPoolId

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

      You can use this option to create an IPAM pool within an existing source pool.