Class CfnIPAMProps

Properties for defining a CfnIPAM.

Inheritance

object

CfnIPAMProps

Implements

ICfnIPAMProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIPAMProps : ICfnIPAMProps

Syntax (vb)

Public Class CfnIPAMProps Implements ICfnIPAMProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// 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 cfnIPAMProps = new CfnIPAMProps {
                 DefaultResourceDiscoveryOrganizationalUnitExclusions = new [] { new IpamOrganizationalUnitExclusionProperty {
                     OrganizationsEntityPath = "organizationsEntityPath"
                 } },
                 Description = "description",
                 EnablePrivateGua = false,
                 MeteredAccount = "meteredAccount",
                 OperatingRegions = new [] { new IpamOperatingRegionProperty {
                     RegionName = "regionName"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Tier = "tier"
             };

Synopsis

Constructors

CfnIPAMProps()

Properties for defining a CfnIPAM.

Properties

DefaultResourceDiscoveryOrganizationalUnitExclusions	If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see Exclude organizational units from IPAM in the Amazon Virtual Private Cloud IP Address Manager User Guide .
Description	The description for the IPAM.
EnablePrivateGua	Enable this option to use your own GUA ranges as private IPv6 addresses.
MeteredAccount	A metered account is an AWS account that is charged for active IP addresses managed in IPAM.
OperatingRegions	The operating Regions for an IPAM.
Tags	The key/value combination of a tag assigned to the resource.
Tier	IPAM is offered in a Free Tier and an Advanced Tier.

Constructors

CfnIPAMProps()

Properties for defining a CfnIPAM.

public CfnIPAMProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// 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 cfnIPAMProps = new CfnIPAMProps {
                 DefaultResourceDiscoveryOrganizationalUnitExclusions = new [] { new IpamOrganizationalUnitExclusionProperty {
                     OrganizationsEntityPath = "organizationsEntityPath"
                 } },
                 Description = "description",
                 EnablePrivateGua = false,
                 MeteredAccount = "meteredAccount",
                 OperatingRegions = new [] { new IpamOperatingRegionProperty {
                     RegionName = "regionName"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Tier = "tier"
             };

Properties

DefaultResourceDiscoveryOrganizationalUnitExclusions

If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see Exclude organizational units from IPAM in the Amazon Virtual Private Cloud IP Address Manager User Guide .

public object? DefaultResourceDiscoveryOrganizationalUnitExclusions { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnIPAM.IIpamOrganizationalUnitExclusionProperty)[]

Description

The description for the IPAM.

public string? Description { get; set; }

Property Value

string

Remarks

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

EnablePrivateGua

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

public object? EnablePrivateGua { get; set; }

Property Value

object

Remarks

This option is disabled by default.

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

Type union: either bool or IResolvable

MeteredAccount

A metered account is an AWS account that is charged for active IP addresses managed in IPAM.

public string? MeteredAccount { get; set; }

Property Value

string

Remarks

For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide .

Possible values:

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

OperatingRegions

The operating Regions for an IPAM.

public object? OperatingRegions { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions

Type union: either IResolvable or (either IResolvable or CfnIPAM.IIpamOperatingRegionProperty)[]

Tags

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

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tags

Tier

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

public string? Tier { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tier

Implements

ICfnIPAMProps