Skip to content

Attachment

Source code in docs_src/capo_network_firewall/types/attachment.py
class Attachment(TypedDict, closed=True):
    subnet_id: NotRequired["capo_network_firewall.types.az_subnet.AzSubnet"]
    """<p>The unique identifier of the subnet that you've specified to be used for a firewall endpoint. </p>"""
    endpoint_id: NotRequired["capo_network_firewall.types.endpoint_id.EndpointId"]
    """<p>The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. </p>"""
    status: NotRequired[
        "capo_network_firewall.types.attachment_status.AttachmentStatus"
    ]
    """<p>The current status of the firewall endpoint instantiation in the subnet. </p> <p>When this value is <code>READY</code>, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example <code>CREATING</code> or <code>DELETING</code>.</p>"""
    status_message: NotRequired[
        "capo_network_firewall.types.status_message.StatusMessage"
    ]
    """<p>If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A <code>FAILED</code> status indicates a non-recoverable state, and a <code>ERROR</code> status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-troubleshooting-endpoint-failures.html">Troubleshooting firewall endpoint failures</a> in the <i>Network Firewall Developer Guide</i>.</p>"""
    dns_name: NotRequired["capo_network_firewall.types.dns_name.DnsName"]
    """<p>The DNS name that resolves to the firewall endpoint in the subnet. This is populated for proxy mode firewalls, where clients direct traffic to the firewall's proxy using this name. </p>"""

dns_name instance-attribute

dns_name: NotRequired[DnsName]

The DNS name that resolves to the firewall endpoint in the subnet. This is populated for proxy mode firewalls, where clients direct traffic to the firewall's proxy using this name.

endpoint_id instance-attribute

endpoint_id: NotRequired[EndpointId]

The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.

status instance-attribute

status: NotRequired[AttachmentStatus]

The current status of the firewall endpoint instantiation in the subnet.

When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.

status_message instance-attribute

status_message: NotRequired[StatusMessage]

If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.

subnet_id instance-attribute

subnet_id: NotRequired[AzSubnet]

The unique identifier of the subnet that you've specified to be used for a firewall endpoint.