Class CfnIPAM

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnIPAM

Implements

IInspectable

IIPAMRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIPAM : CfnResource, IInspectable, IIPAMRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnIPAM Inherits CfnResource Implements IInspectable, IIPAMRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

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 cfnIPAM = new CfnIPAM(this, "MyCfnIPAM", 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

CfnIPAM(Construct, string, ICfnIPAMProps?)

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.

Properties

AttrArn	The ARN of the IPAM.
AttrDefaultResourceDiscoveryAssociationId	The ID of the default resource discovery association.
AttrDefaultResourceDiscoveryId	The ID of the default resource discovery.
AttrIpamId	The ID of the IPAM.
AttrPrivateDefaultScopeId	The ID of the default private scope.
AttrPublicDefaultScopeId	The ID of the default public scope.
AttrResourceDiscoveryAssociationCount	The number of resource discovery associations.
AttrScopeCount	The number of scopes.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.
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.
IpamRef	A reference to a IPAM resource.
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	Tag Manager which manages the tags for this resource.
TagsRaw	The key/value combination of a tag assigned to the resource.
Tier	IPAM is offered in a Free Tier and an Advanced Tier.

Methods

FromIPAMArn(Construct, string, string)	Creates a new IIPAMRef from an ARN.
FromIpamId(Construct, string, string)	Creates a new IIPAMRef from a ipamId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.

Constructors

CfnIPAM(Construct, string, ICfnIPAMProps?)

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.

public CfnIPAM(Construct scope, string id, ICfnIPAMProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnIPAMProps

Resource properties.

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the IPAM.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrDefaultResourceDiscoveryAssociationId

The ID of the default resource discovery association.

public virtual string AttrDefaultResourceDiscoveryAssociationId { get; }

Property Value

string

Remarks

CloudformationAttribute: DefaultResourceDiscoveryAssociationId

AttrDefaultResourceDiscoveryId

The ID of the default resource discovery.

public virtual string AttrDefaultResourceDiscoveryId { get; }

Property Value

string

Remarks

CloudformationAttribute: DefaultResourceDiscoveryId

AttrIpamId

The ID of the IPAM.

public virtual string AttrIpamId { get; }

Property Value

string

Remarks

CloudformationAttribute: IpamId

AttrPrivateDefaultScopeId

The ID of the default private scope.

public virtual string AttrPrivateDefaultScopeId { get; }

Property Value

string

Remarks

CloudformationAttribute: PrivateDefaultScopeId

AttrPublicDefaultScopeId

The ID of the default public scope.

public virtual string AttrPublicDefaultScopeId { get; }

Property Value

string

Remarks

CloudformationAttribute: PublicDefaultScopeId

AttrResourceDiscoveryAssociationCount

The number of resource discovery associations.

public virtual double AttrResourceDiscoveryAssociationCount { get; }

Property Value

double

Remarks

CloudformationAttribute: ResourceDiscoveryAssociationCount

AttrScopeCount

The number of scopes.

public virtual double AttrScopeCount { get; }

Property Value

double

Remarks

CloudformationAttribute: ScopeCount

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

CfnProperties

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

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 virtual object? DefaultResourceDiscoveryOrganizationalUnitExclusions { get; set; }

Property Value

object

Remarks

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

Description

The description for the IPAM.

public virtual string? Description { get; set; }

Property Value

string

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

EnablePrivateGua

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

public virtual object? EnablePrivateGua { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

IpamRef

A reference to a IPAM resource.

public virtual IIPAMReference IpamRef { get; }

Property Value

IIPAMReference

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

MeteredAccount

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

public virtual string? MeteredAccount { get; set; }

Property Value

string

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

OperatingRegions

The operating Regions for an IPAM.

public virtual object? OperatingRegions { get; set; }

Property Value

object

Remarks

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

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

Tier

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

public virtual string? Tier { get; set; }

Property Value

string

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

Methods

FromIPAMArn(Construct, string, string)

Creates a new IIPAMRef from an ARN.

public static IIPAMRef FromIPAMArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IIPAMRef

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

FromIpamId(Construct, string, string)

Creates a new IIPAMRef from a ipamId.

public static IIPAMRef FromIpamId(Construct scope, string id, string ipamId)

Parameters

scope Construct

id string

ipamId string

Returns

IIPAMRef

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

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

CloudformationResource: AWS::EC2::IPAM

ExampleMetadata: fixture=_generated

Implements

IInspectable

IIPAMRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable