Package software.amazon.awscdk.services.ec2

Interface CfnIPAMPoolCidrProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIPAMPoolCidrProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:38.599Z")
@Stability(Stable)
public interface CfnIPAMPoolCidrProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIPAMPoolCidr.

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.*;
 CfnIPAMPoolCidrProps cfnIPAMPoolCidrProps = CfnIPAMPoolCidrProps.builder()
         .ipamPoolId("ipamPoolId")
         // the properties below are optional
         .cidr("cidr")
         .netmaskLength(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIPAMPoolCidrProps.Builder	builder()
default String	getCidr()	The CIDR provisioned to the IPAM pool.
String	getIpamPoolId()	The ID of the IPAM pool.
default Number	getNetmaskLength()	The netmask length of the CIDR you'd like to provision to a pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIpamPoolId

@Stability(Stable)
@NotNull
String getIpamPoolId()

The ID of the IPAM pool.

getCidr

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

The CIDR provisioned to the IPAM pool.

A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is 2001:DB8::/32 .

getNetmaskLength

@Stability(Stable)
@Nullable
default Number getNetmaskLength()

The netmask length of the CIDR you'd like to provision to a pool.

Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.

builder

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

Returns:

a CfnIPAMPoolCidrProps.Builder of CfnIPAMPoolCidrProps