• Public
  • Public/Protected
  • All

Interface IpamScope

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see How IPAM works in the Amazon VPC IPAM User Guide.


  • IpamScope



Optional Description

Description: undefined | string

The description of the scope.

Optional IpamArn

IpamArn: undefined | string

The ARN of the IPAM.

Optional IpamRegion

IpamRegion: undefined | string

The Amazon Web Services Region of the IPAM scope.

Optional IpamScopeArn

IpamScopeArn: undefined | string

The Amazon Resource Name (ARN) of the scope.

Optional IpamScopeId

IpamScopeId: undefined | string

The ID of the scope.

Optional IpamScopeType

IpamScopeType: IpamScopeType | string

The type of the scope.

Optional IsDefault

IsDefault: undefined | false | true

Defines if the scope is the default scope or not.

Optional OwnerId

OwnerId: undefined | string

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

Optional PoolCount

PoolCount: undefined | number

The number of pools in the scope.

Optional State

State: IpamScopeState | string

The state of the IPAM scope.

Optional Tags

Tags: Tag[]

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.