Skip to content

EC2  >  Structures  >  IpamScope

IpamScope

Structure Class

IpamScope dataclass

Bases: _SerdeShape

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.

Attributes

description class-attribute instance-attribute
description: str | None = ...

The description of the scope.

external_authority_configuration class-attribute instance-attribute
external_authority_configuration: IpamScopeExternalAuthorityConfiguration | None = ...

The external authority configuration for this IPAM scope, if configured.

The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.

ipam_arn class-attribute instance-attribute
ipam_arn: str | None = ...

The ARN of the IPAM.

ipam_region class-attribute instance-attribute
ipam_region: str | None = ...

The Amazon Web Services Region of the IPAM scope.

ipam_scope_arn class-attribute instance-attribute
ipam_scope_arn: str | None = ...

The Amazon Resource Name (ARN) of the scope.

ipam_scope_id class-attribute instance-attribute
ipam_scope_id: str | None = ...

The ID of the scope.

ipam_scope_type class-attribute instance-attribute
ipam_scope_type: str | None = ...

The type of the scope.

is_default class-attribute instance-attribute
is_default: bool | None = ...

Defines if the scope is the default scope or not.

owner_id class-attribute instance-attribute
owner_id: str | None = ...

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

pool_count class-attribute instance-attribute
pool_count: int | None = ...

The number of pools in the scope.

state class-attribute instance-attribute
state: str | None = ...

The state of the IPAM scope.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

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.