Package software.amazon.awscdk.services.ec2

Interface CfnIPAMPoolProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIPAMPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:57.946Z")
@Stability(Stable)
public interface CfnIPAMPoolProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIPAMPool.

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.*;
 CfnIPAMPoolProps cfnIPAMPoolProps = CfnIPAMPoolProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIPAMPoolProps.Builder	A builder for CfnIPAMPoolProps
static final class	CfnIPAMPoolProps.Jsii$Proxy	An implementation for CfnIPAMPoolProps

Method Summary

Modifier and Type	Method	Description
static CfnIPAMPoolProps.Builder	builder()
String	getAddressFamily()	The address family of the pool.
default Number	getAllocationDefaultNetmaskLength()	The default netmask length for allocations added to this pool.
default Number	getAllocationMaxNetmaskLength()	The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
default Number	getAllocationMinNetmaskLength()	The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
default Object	getAllocationResourceTags()	Tags that are required for resources that use CIDRs from this IPAM pool.
default 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.
default String	getAwsService()	Limits which service in AWS that the pool can be used in.
default String	getDescription()	The description of the IPAM pool.
String	getIpamScopeId()	The ID of the scope in which you would like to create the IPAM pool.
default String	getLocale()	The locale of the IPAM pool.
default Object	getProvisionedCidrs()	Information about the CIDRs provisioned to an IPAM pool.
default String	getPublicIpSource()	The IP address source for pools in the public scope.
default Object	getPubliclyAdvertisable()	Determines if a pool is publicly advertisable.
default String	getSourceIpamPoolId()	The ID of the source IPAM pool.
default Object	getSourceResource()	The resource used to provision CIDRs to a resource planning pool.
default List<CfnTag>	getTags()	The key/value combination of a tag assigned to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddressFamily

@Stability(Stable)
@NotNull
String getAddressFamily()

The address family of the pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-addressfamily

getIpamScopeId

@Stability(Stable)
@NotNull
String getIpamScopeId()

The ID of the scope in which you would like to create the IPAM pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-ipamscopeid

getAllocationDefaultNetmaskLength

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationdefaultnetmasklength

getAllocationMaxNetmaskLength

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationmaxnetmasklength

getAllocationMinNetmaskLength

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationminnetmasklength

getAllocationResourceTags

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationresourcetags

getAutoImport

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-autoimport

getAwsService

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the IPAM pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-description

getLocale

@Stability(Stable)
@Nullable
default String getLocale()

The locale of the IPAM pool.

The locale for the pool should be one of the following:

• An AWS Region where you want this IPAM pool to be available for allocations.
• The network border group for an AWS Local Zone where you want this IPAM pool to be available for allocations ( supported Local Zones ). This option is only available for IPAM IPv4 pools in the public scope.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-locale

getProvisionedCidrs

@Stability(Stable)
@Nullable
default Object getProvisionedCidrs()

Information about the CIDRs provisioned to an IPAM pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-provisionedcidrs

getPublicIpSource

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publicipsource

getPubliclyAdvertisable

@Stability(Stable)
@Nullable
default Object getPubliclyAdvertisable()

Determines if a pool is publicly advertisable.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publiclyadvertisable

getSourceIpamPoolId

@Stability(Stable)
@Nullable
default String getSourceIpamPoolId()

The ID of the source IPAM pool.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceipampoolid

getSourceResource

@Stability(Stable)
@Nullable
default Object getSourceResource()

The resource used to provision CIDRs to a resource planning pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceresource

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-tags

builder

@Stability(Stable)
static CfnIPAMPoolProps.Builder builder()

Returns:

a CfnIPAMPoolProps.Builder of CfnIPAMPoolProps