interface CfnIPAMProps

Language	Type name
.NET	Amazon.CDK.AWS.EC2.CfnIPAMProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnIPAMProps
Java	software.amazon.awscdk.services.ec2.CfnIPAMProps
Python	aws_cdk.aws_ec2.CfnIPAMProps
TypeScript	aws-cdk-lib » aws_ec2 » CfnIPAMProps

Properties for defining a CfnIPAM.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html

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 cfnIPAMProps: ec2.CfnIPAMProps = {
  description: 'description',
  enablePrivateGua: false,
  operatingRegions: [{
    regionName: 'regionName',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tier: 'tier',
};

Properties

Name	Type	Description
description?	string	The description for the IPAM.
enablePrivateGua?	boolean | IResolvable	Enable this option to use your own GUA ranges as private IPv6 addresses.
operatingRegions?	IResolvable | IResolvable | IpamOperatingRegionProperty[]	The operating Regions for an IPAM.
tags?	CfnTag[]	The key/value combination of a tag assigned to the resource.
tier?	string	IPAM is offered in a Free Tier and an Advanced Tier.

---

description?

Type: string (optional)

The description for the IPAM.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-description

---

enablePrivateGua?

Type: boolean | IResolvable (optional)

Enable this option to use your own GUA ranges as private IPv6 addresses.

This option is disabled by default.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-enableprivategua

---

operatingRegions?

Type: IResolvable | IResolvable | IpamOperatingRegionProperty[] (optional)

The operating Regions for an IPAM.

Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions

---

tags?

Type: CfnTag[] (optional)

The key/value combination of a tag assigned to the resource.

Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tags

---

tier?

Type: string (optional)

IPAM is offered in a Free Tier and an Advanced Tier.

For more information about the features available in each tier and the costs associated with the tiers, see the VPC IPAM product pricing page .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tier