Skip to content

DescribeFirewallMetadataResponse

Source code in docs_src/capo_network_firewall/types/describe_firewall_metadata_response.py
class DescribeFirewallMetadataResponse(TypedDict, closed=True):
    firewall_arn: NotRequired["capo_network_firewall.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the firewall.</p>"""
    firewall_policy_arn: NotRequired[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the firewall policy.</p>"""
    description: NotRequired["capo_network_firewall.types.description.Description"]
    """<p>A description of the firewall.</p>"""
    status: NotRequired[
        "capo_network_firewall.types.firewall_status_value.FirewallStatusValue"
    ]
    """<p>The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is <code>READY</code> only when the <code>ConfigurationSyncStateSummary</code> value is <code>IN_SYNC</code> and the <code>Attachment</code> <code>Status</code> values for all of the configured subnets are <code>READY</code>. </p>"""
    supported_availability_zones: NotRequired[
        "capo_network_firewall.types.supported_availability_zones.SupportedAvailabilityZones"
    ]
    """<p>The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined. </p>"""
    transit_gateway_attachment_id: NotRequired[
        "capo_network_firewall.types.transit_gateway_attachment_id.TransitGatewayAttachmentId"
    ]
    """<p>The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.</p>"""

description instance-attribute

description: NotRequired[Description]

A description of the firewall.

firewall_arn instance-attribute

firewall_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the firewall.

firewall_policy_arn instance-attribute

firewall_policy_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the firewall policy.

status instance-attribute

status: NotRequired[FirewallStatusValue]

The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.

supported_availability_zones instance-attribute

supported_availability_zones: NotRequired[SupportedAvailabilityZones]

The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.

transit_gateway_attachment_id instance-attribute

transit_gateway_attachment_id: NotRequired[TransitGatewayAttachmentId]

The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.