AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::EC2::IPAMAllocation

CfnIPAMAllocation

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.

Import

import { CfnIPAMAllocation } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.CfnIPAMAllocation

Properties

Configuration passed to the constructor as CfnIPAMAllocationProps.

ipamPoolIdRequired
string

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

cidrOptional
string

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.

descriptionOptional
string

A description for the allocation.

netmaskLengthOptional
number

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic