Skip to content

IpamResourceDiscovery

Source code in docs_src/capo_ec2/types/ipam_resource_discovery.py
class IpamResourceDiscovery(TypedDict, closed=True):
    owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the owner.</p>"""
    ipam_resource_discovery_id: NotRequired[
        "capo_ec2.types.ipam_resource_discovery_id.IpamResourceDiscoveryId"
    ]
    """<p>The resource discovery ID.</p>"""
    ipam_resource_discovery_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The resource discovery Amazon Resource Name (ARN).</p>"""
    ipam_resource_discovery_region: NotRequired["capo_ec2.types.string.String"]
    """<p>The resource discovery Region.</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>The resource discovery description.</p>"""
    operating_regions: NotRequired[
        "capo_ec2.types.ipam_operating_region_set.IpamOperatingRegionSet"
    ]
    """<p>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.</p>"""
    is_default: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.</p>"""
    state: NotRequired[
        "capo_ec2.types.ipam_resource_discovery_state.IpamResourceDiscoveryState"
    ]
    """<p>The lifecycle state of the resource discovery.</p> <ul> <li> <p> <code>create-in-progress</code> - Resource discovery is being created.</p> </li> <li> <p> <code>create-complete</code> - Resource discovery creation is complete.</p> </li> <li> <p> <code>create-failed</code> - Resource discovery creation has failed.</p> </li> <li> <p> <code>modify-in-progress</code> - Resource discovery is being modified.</p> </li> <li> <p> <code>modify-complete</code> - Resource discovery modification is complete.</p> </li> <li> <p> <code>modify-failed</code> - Resource discovery modification has failed.</p> </li> <li> <p> <code>delete-in-progress</code> - Resource discovery is being deleted.</p> </li> <li> <p> <code>delete-complete</code> - Resource discovery deletion is complete.</p> </li> <li> <p> <code>delete-failed</code> - Resource discovery deletion has failed.</p> </li> <li> <p> <code>isolate-in-progress</code> - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.</p> </li> <li> <p> <code>isolate-complete</code> - Resource discovery isolation is complete.</p> </li> <li> <p> <code>restore-in-progress</code> - Amazon Web Services account that created the resource discovery and was isolated has been restored.</p> </li> </ul>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>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.</p>"""
    organizational_unit_exclusions: NotRequired[
        "capo_ec2.types.ipam_organizational_unit_exclusion_set.IpamOrganizationalUnitExclusionSet"
    ]
    """<p>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.</p>"""

description instance-attribute

description: NotRequired[String]

The resource discovery description.

ipam_resource_discovery_arn instance-attribute

ipam_resource_discovery_arn: NotRequired[String]

The resource discovery Amazon Resource Name (ARN).

ipam_resource_discovery_id instance-attribute

ipam_resource_discovery_id: NotRequired[IpamResourceDiscoveryId]

The resource discovery ID.

ipam_resource_discovery_region instance-attribute

ipam_resource_discovery_region: NotRequired[String]

The resource discovery Region.

is_default instance-attribute

is_default: NotRequired[Boolean]

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 instance-attribute

operating_regions: NotRequired[IpamOperatingRegionSet]

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 instance-attribute

organizational_unit_exclusions: NotRequired[IpamOrganizationalUnitExclusionSet]

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 instance-attribute

owner_id: NotRequired[String]

The ID of the owner.

state instance-attribute

state: NotRequired[IpamResourceDiscoveryState]

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 instance-attribute

tags: NotRequired[TagList]

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.