1.204.0

interface CfnIPAMAllocationProps

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnIPAMAllocationProps
Javasoftware.amazon.awscdk.services.ec2.CfnIPAMAllocationProps
Pythonaws_cdk.aws_ec2.CfnIPAMAllocationProps
TypeScript @aws-cdk/aws-ec2 » CfnIPAMAllocationProps

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 * as ec2 from '@aws-cdk/aws-ec2';
const cfnIPAMAllocationProps: ec2.CfnIPAMAllocationProps = {
  ipamPoolId: 'ipamPoolId',

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

Properties

NameTypeDescription
ipamPoolIdstringThe ID of the IPAM pool from which you would like to allocate a CIDR.
cidr?stringThe CIDR you would like to allocate from the IPAM pool. Note the following:.
description?stringA description for the allocation.
netmaskLength?numberThe netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:.

ipamPoolId

Type: string

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

cidr?

Type: string (optional)

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.

description?

Type: string (optional)

A description for the allocation.

netmaskLength?

Type: number (optional)

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.

← PreviousNext →