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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.190Z")
 @Stability(value=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()))
         .publiclyAdvertisable(false)
         .sourceIpamPoolId("sourceIpamPoolId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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() `AWS::EC2::IPAMPool.AwsService`.
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 Object	getPubliclyAdvertisable() Determines if a pool is publicly advertisable.
default String	getSourceIpamPoolId() The ID of the source IPAM 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 Detail

getAddressFamily

@Stability(value=Stable)
 @NotNull
String getAddressFamily()

The address family of the pool.

getIpamScopeId

@Stability(value=Stable)
 @NotNull
String getIpamScopeId()

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

getAllocationDefaultNetmaskLength

@Stability(value=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.

getAllocationMaxNetmaskLength

@Stability(value=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.

getAllocationMinNetmaskLength

@Stability(value=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.

getAllocationResourceTags

@Stability(value=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.

getAutoImport

@Stability(value=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.

getAwsService

@Stability(value=Stable)
 @Nullable
default String getAwsService()

`AWS::EC2::IPAMPool.AwsService`.

getDescription

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

The description of the IPAM pool.

getLocale

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

getProvisionedCidrs

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

Information about the CIDRs provisioned to an IPAM pool.

getPubliclyAdvertisable

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

Determines if a pool is publicly advertisable.

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

getSourceIpamPoolId

@Stability(value=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.

getTags

@Stability(value=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.

builder

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

Returns:

a CfnIPAMPoolProps.Builder of CfnIPAMPoolProps