Skip to content

IpamResourceDiscoveryAssociation

Source code in docs_src/capo_ec2/types/ipam_resource_discovery_association.py
class IpamResourceDiscoveryAssociation(TypedDict, closed=True):
    owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Web Services account ID of the resource discovery owner.</p>"""
    ipam_resource_discovery_association_id: NotRequired[
        "capo_ec2.types.ipam_resource_discovery_association_id.IpamResourceDiscoveryAssociationId"
    ]
    """<p>The resource discovery association ID.</p>"""
    ipam_resource_discovery_association_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The resource discovery association Amazon Resource Name (ARN).</p>"""
    ipam_resource_discovery_id: NotRequired[
        "capo_ec2.types.ipam_resource_discovery_id.IpamResourceDiscoveryId"
    ]
    """<p>The resource discovery ID.</p>"""
    ipam_id: NotRequired["capo_ec2.types.ipam_id.IpamId"]
    """<p>The IPAM ID.</p>"""
    ipam_arn: NotRequired["capo_ec2.types.resource_arn.ResourceArn"]
    """<p>The IPAM ARN.</p>"""
    ipam_region: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPAM home Region.</p>"""
    is_default: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.</p>"""
    resource_discovery_status: NotRequired[
        "capo_ec2.types.ipam_associated_resource_discovery_status.IpamAssociatedResourceDiscoveryStatus"
    ]
    """<p>The resource discovery status.</p> <ul> <li> <p> <code>active</code> - Connection or permissions required to read the results of the resource discovery are intact.</p> </li> <li> <p> <code>not-found</code> - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.</p> </li> </ul>"""
    state: NotRequired[
        "capo_ec2.types.ipam_resource_discovery_association_state.IpamResourceDiscoveryAssociationState"
    ]
    """<p>The lifecycle state of the association when you associate or disassociate a resource discovery.</p> <ul> <li> <p> <code>associate-in-progress</code> - Resource discovery is being associated.</p> </li> <li> <p> <code>associate-complete</code> - Resource discovery association is complete.</p> </li> <li> <p> <code>associate-failed</code> - Resource discovery association has failed.</p> </li> <li> <p> <code>disassociate-in-progress</code> - Resource discovery is being disassociated.</p> </li> <li> <p> <code>disassociate-complete</code> - Resource discovery disassociation is complete.</p> </li> <li> <p> <code>disassociate-failed </code> - Resource discovery disassociation has failed.</p> </li> <li> <p> <code>isolate-in-progress</code> - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery association 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> - Resource discovery is being 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>"""

ipam_arn instance-attribute

ipam_arn: NotRequired[ResourceArn]

The IPAM ARN.

ipam_id instance-attribute

ipam_id: NotRequired[IpamId]

The IPAM ID.

ipam_region instance-attribute

ipam_region: NotRequired[String]

The IPAM home Region.

ipam_resource_discovery_association_arn instance-attribute

ipam_resource_discovery_association_arn: NotRequired[String]

The resource discovery association Amazon Resource Name (ARN).

ipam_resource_discovery_association_id instance-attribute

ipam_resource_discovery_association_id: NotRequired[IpamResourceDiscoveryAssociationId]

The resource discovery association ID.

ipam_resource_discovery_id instance-attribute

ipam_resource_discovery_id: NotRequired[IpamResourceDiscoveryId]

The resource discovery ID.

is_default instance-attribute

is_default: NotRequired[Boolean]

Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.

owner_id instance-attribute

owner_id: NotRequired[String]

The Amazon Web Services account ID of the resource discovery owner.

resource_discovery_status instance-attribute

resource_discovery_status: NotRequired[IpamAssociatedResourceDiscoveryStatus]

The resource discovery status.

  • active - Connection or permissions required to read the results of the resource discovery are intact.

  • not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.

state instance-attribute

The lifecycle state of the association when you associate or disassociate a resource discovery.

  • associate-in-progress - Resource discovery is being associated.

  • associate-complete - Resource discovery association is complete.

  • associate-failed - Resource discovery association has failed.

  • disassociate-in-progress - Resource discovery is being disassociated.

  • disassociate-complete - Resource discovery disassociation is complete.

  • disassociate-failed - Resource discovery disassociation has failed.

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

  • isolate-complete - Resource discovery isolation is complete.

  • restore-in-progress - Resource discovery is being 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.