Package software.amazon.awscdk.services.ec2

Interface CfnIPAMAllocationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIPAMAllocationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-27T17:02:00.491Z")
@Stability(Stable)
public interface CfnIPAMAllocationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIPAMAllocation.

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIPAMAllocationProps.Builder	builder()
default String	getCidr()	The CIDR you would like to allocate from the IPAM pool.
default String	getDescription()	A description for the allocation.
String	getIpamPoolId()	The ID of the IPAM pool from which you would like to allocate a CIDR.
default Number	getNetmaskLength()	The netmask length of the CIDR you would like to allocate from the IPAM 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 from which you would like to allocate a CIDR.

See Also:

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

getCidr

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

The CIDR you would like to allocate from the IPAM pool. Note the following:.

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible values: Any available IPv4 or IPv6 CIDR.

See Also:

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

getDescription

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

A description for the allocation.

See Also:

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

getNetmaskLength

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

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:.

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

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-ipamallocation.html#cfn-ec2-ipamallocation-netmasklength

builder

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

Returns:

a CfnIPAMAllocationProps.Builder of CfnIPAMAllocationProps