Skip to content

NetworkResource

Source code in docs_src/capo_networkmanager/types/network_resource.py
class NetworkResource(TypedDict, closed=True):
    registered_gateway_arn: NotRequired[
        "capo_networkmanager.types.resource_arn.ResourceArn"
    ]
    """<p>The ARN of the gateway.</p>"""
    core_network_id: NotRequired[
        "capo_networkmanager.types.core_network_id.CoreNetworkId"
    ]
    """<p>The ID of a core network.</p>"""
    aws_region: NotRequired[
        "capo_networkmanager.types.external_region_code.ExternalRegionCode"
    ]
    """<p>The Amazon Web Services Region.</p>"""
    account_id: NotRequired["capo_networkmanager.types.aws_account_id.AWSAccountId"]
    """<p>The Amazon Web Services account ID.</p>"""
    resource_type: NotRequired[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ]
    """<p>The resource type.</p> <p>The following are the supported resource types for Direct Connect:</p> <ul> <li> <p> <code>dxcon</code> </p> </li> <li> <p> <code>dx-gateway</code> </p> </li> <li> <p> <code>dx-vif</code> </p> </li> </ul> <p>The following are the supported resource types for Network Manager:</p> <ul> <li> <p> <code>attachment</code> </p> </li> <li> <p> <code>connect-peer</code> </p> </li> <li> <p> <code>connection</code> </p> </li> <li> <p> <code>core-network</code> </p> </li> <li> <p> <code>device</code> </p> </li> <li> <p> <code>link</code> </p> </li> <li> <p> <code>peering</code> </p> </li> <li> <p> <code>site</code> </p> </li> </ul> <p>The following are the supported resource types for Amazon VPC:</p> <ul> <li> <p> <code>customer-gateway</code> </p> </li> <li> <p> <code>transit-gateway</code> </p> </li> <li> <p> <code>transit-gateway-attachment</code> </p> </li> <li> <p> <code>transit-gateway-connect-peer</code> </p> </li> <li> <p> <code>transit-gateway-route-table</code> </p> </li> <li> <p> <code>vpn-connection</code> </p> </li> </ul>"""
    resource_id: NotRequired[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ]
    """<p>The ID of the resource.</p>"""
    resource_arn: NotRequired["capo_networkmanager.types.resource_arn.ResourceArn"]
    """<p>The ARN of the resource.</p>"""
    definition: NotRequired[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ]
    """<p>Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.</p>"""
    definition_timestamp: NotRequired["capo_networkmanager.types.date_time.DateTime"]
    """<p>The time that the resource definition was retrieved.</p>"""
    tags: NotRequired["capo_networkmanager.types.tag_list.TagList"]
    """<p>The tags.</p>"""
    metadata: NotRequired[
        "capo_networkmanager.types.network_resource_metadata_map.NetworkResourceMetadataMap"
    ]
    """<p>The resource metadata.</p>"""

account_id instance-attribute

account_id: NotRequired[AWSAccountId]

The Amazon Web Services account ID.

aws_region instance-attribute

aws_region: NotRequired[ExternalRegionCode]

The Amazon Web Services Region.

core_network_id instance-attribute

core_network_id: NotRequired[CoreNetworkId]

The ID of a core network.

definition instance-attribute

definition: NotRequired[ConstrainedString]

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

definition_timestamp instance-attribute

definition_timestamp: NotRequired[DateTime]

The time that the resource definition was retrieved.

metadata instance-attribute

metadata: NotRequired[NetworkResourceMetadataMap]

The resource metadata.

registered_gateway_arn instance-attribute

registered_gateway_arn: NotRequired[ResourceArn]

The ARN of the gateway.

resource_arn instance-attribute

resource_arn: NotRequired[ResourceArn]

The ARN of the resource.

resource_id instance-attribute

resource_id: NotRequired[ConstrainedString]

The ID of the resource.

resource_type instance-attribute

resource_type: NotRequired[ConstrainedString]

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon

  • dx-gateway

  • dx-vif

The following are the supported resource types for Network Manager:

  • attachment

  • connect-peer

  • connection

  • core-network

  • device

  • link

  • peering

  • site

The following are the supported resource types for Amazon VPC:

  • customer-gateway

  • transit-gateway

  • transit-gateway-attachment

  • transit-gateway-connect-peer

  • transit-gateway-route-table

  • vpn-connection

tags instance-attribute

tags: NotRequired[TagList]

The tags.