CfnIPAMAllocationProps Struct
Properties for defining a CfnIPAMAllocation.
| Source | |
|---|---|
| Type last changed |
Example
ts
// 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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
cfn_ipam_allocation_props = ec2.CfnIPAMAllocationProps(
ipam_pool_id="ipamPoolId",
# the properties below are optional
cidr="cidr",
description="description",
netmask_length=123
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var cfnIPAMAllocationProps = new CfnIPAMAllocationProps {
IpamPoolId = "ipamPoolId",
// the properties below are optional
Cidr = "cidr",
Description = "description",
NetmaskLength = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnIPAMAllocationProps := &CfnIPAMAllocationProps{
IpamPoolId: jsii.String("ipamPoolId"),
// the properties below are optional
Cidr: jsii.String("cidr"),
Description: jsii.String("description"),
NetmaskLength: jsii.Number(123),
}
Properties
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.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #A description for the allocation.
The ID of the IPAM pool from which you would like to allocate a CIDR.
netmaskLengthoptionalnumbernetmask_lengthoptionalint | floatnetmaskLengthoptionalNumberNetmaskLengthoptionaldoubleNetmaskLengthoptional*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.