Skip to content

EC2  >  Structures  >  IpamResourceDiscovery

IpamResourceDiscovery

Structure Class

IpamResourceDiscovery dataclass

Bases: _SerdeShape

A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Attributes

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

The resource discovery description.

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

The resource discovery Amazon Resource Name (ARN).

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

The resource discovery ID.

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

The resource discovery Region.

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

Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.

operating_regions class-attribute instance-attribute
operating_regions: list[IpamOperatingRegion] | None = ...

The operating Regions for the resource discovery. 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.

organizational_unit_exclusions class-attribute instance-attribute
organizational_unit_exclusions: list[IpamOrganizationalUnitExclusion] | None = ...

If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.

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

The ID of the owner.

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

The lifecycle state of the resource discovery.

  • create-in-progress - Resource discovery is being created.

  • create-complete - Resource discovery creation is complete.

  • create-failed - Resource discovery creation has failed.

  • modify-in-progress - Resource discovery is being modified.

  • modify-complete - Resource discovery modification is complete.

  • modify-failed - Resource discovery modification has failed.

  • delete-in-progress - Resource discovery is being deleted.

  • delete-complete - Resource discovery deletion is complete.

  • delete-failed - Resource discovery deletion has failed.

  • isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.

  • isolate-complete - Resource discovery isolation is complete.

  • restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.

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

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.