Ipam - Amazon Elastic Compute Cloud
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Ipam

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

Contents

defaultResourceDiscoveryAssociationId

The IPAM's default resource discovery association ID.

Type: String

Required: No

defaultResourceDiscoveryId

The IPAM's default resource discovery ID.

Type: String

Required: No

description

The description for the IPAM.

Type: String

Required: No

ipamArn

The Amazon Resource Name (ARN) of the IPAM.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1283.

Required: No

ipamId

The ID of the IPAM.

Type: String

Required: No

ipamRegion

The Amazon Region of the IPAM.

Type: String

Required: No

operatingRegionSet

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

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

Type: Array of IpamOperatingRegion objects

Required: No

ownerId

The Amazon account ID of the owner of the IPAM.

Type: String

Required: No

privateDefaultScopeId

The ID of the IPAM's default private scope.

Type: String

Required: No

publicDefaultScopeId

The ID of the IPAM's default public scope.

Type: String

Required: No

resourceDiscoveryAssociationCount

The IPAM's resource discovery association count.

Type: Integer

Required: No

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.

Type: Integer

Required: No

state

The state of the IPAM.

Type: String

Valid Values: create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progress

Required: No

stateMessage

The state message.

Type: String

Required: No

tagSet

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.

Type: Array of Tag objects

Required: No

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.

Type: String

Valid Values: free | advanced

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: