aws-cdk-lib.aws_ec2.CfnIPAMAllocationProps

CfnIPAMAllocationProps Struct

Properties for defining a CfnIPAMAllocation.

Source

Generated code

Type last changed

v2.2.0 · 15 Dec 2021

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnIPAMAllocationProps: ec2.CfnIPAMAllocationProps = {
  ipamPoolId: 'ipamPoolId',

  // the properties below are optional
  cidr: 'cidr',
  description: 'description',
  netmaskLength: 123,
};

Properties

cidrstringcidrstrcidrStringCidrstringCidr*string#

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

notes

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

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A description for the allocation.

ipamPoolIdstringipam_pool_idstripamPoolIdStringIpamPoolIdstringIpamPoolId*stringrequired#

The ID of the IPAM pool from which you would like to allocate a CIDR.

netmaskLengthnumbernetmask_lengthint | floatnetmaskLengthNumberNetmaskLengthdoubleNetmaskLength*float64#

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

notes

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

Used as props by

• CfnIPAMAllocation