AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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 Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

Inheritance Hierarchy

System.Object
  Amazon.EC2.Model.Ipam

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class Ipam

The Ipam type exposes the following members

Constructors

NameDescription
Public Method Ipam()

Properties

NameTypeDescription
Public Property DefaultResourceDiscoveryAssociationId System.String

Gets and sets the property DefaultResourceDiscoveryAssociationId.

The IPAM's default resource discovery association ID.

Public Property DefaultResourceDiscoveryId System.String

Gets and sets the property DefaultResourceDiscoveryId.

The IPAM's default resource discovery ID.

Public Property Description System.String

Gets and sets the property Description.

The description for the IPAM.

Public Property EnablePrivateGua System.Nullable<System.Boolean>

Gets and sets the property EnablePrivateGua.

Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Public Property IpamArn System.String

Gets and sets the property IpamArn.

The Amazon Resource Name (ARN) of the IPAM.

Public Property IpamId System.String

Gets and sets the property IpamId.

The ID of the IPAM.

Public Property IpamRegion System.String

Gets and sets the property IpamRegion.

The Amazon Web Services Region of the IPAM.

Public Property MeteredAccount Amazon.EC2.IpamMeteredAccount

Gets and sets the property MeteredAccount.

A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.

Possible values:

  • ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.

  • resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.

Public Property OperatingRegions System.Collections.Generic.List<Amazon.EC2.Model.IpamOperatingRegion>

Gets and sets the property OperatingRegions.

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property OwnerId System.String

Gets and sets the property OwnerId.

The Amazon Web Services account ID of the owner of the IPAM.

Public Property PrivateDefaultScopeId System.String

Gets and sets the property PrivateDefaultScopeId.

The ID of the IPAM's default private scope.

Public Property PublicDefaultScopeId System.String

Gets and sets the property PublicDefaultScopeId.

The ID of the IPAM's default public scope.

Public Property ResourceDiscoveryAssociationCount System.Nullable<System.Int32>

Gets and sets the property ResourceDiscoveryAssociationCount.

The IPAM's resource discovery association count.

Public Property ScopeCount System.Nullable<System.Int32>

Gets and sets the property ScopeCount.

The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

Public Property State Amazon.EC2.IpamState

Gets and sets the property State.

The state of the IPAM.

Public Property StateMessage System.String

Gets and sets the property StateMessage.

The state message.

Public Property Tags System.Collections.Generic.List<Amazon.EC2.Model.Tag>

Gets and sets the property Tags.

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.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property Tier Amazon.EC2.IpamTier

Gets and sets the property Tier.

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 Amazon VPC pricing > IPAM tab.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer