Skip to content

FirewallStatus

Source code in docs_src/capo_network_firewall/types/firewall_status.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class FirewallStatus(TypedDict, closed=True):
    status: "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>"""
    configuration_sync_state_summary: (
        "capo_network_firewall.types.configuration_sync_state.ConfigurationSyncState"
    )
    """<p>The configuration sync state for the firewall. This summarizes the <code>Config</code> settings in the <code>SyncStates</code> for this firewall status object. </p> <p>When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere. </p> <p>This status must be <code>IN_SYNC</code> for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The <code>Status</code> setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic. </p>"""
    sync_states: NotRequired["capo_network_firewall.types.sync_states.SyncStates"]
    """<p>Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall. </p> <p>These objects provide detailed information for the settings <code>ConfigurationSyncStateSummary</code> and <code>Status</code>. </p>"""
    capacity_usage_summary: NotRequired[
        "capo_network_firewall.types.capacity_usage_summary.CapacityUsageSummary"
    ]
    """<p>Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.</p>"""
    transit_gateway_attachment_sync_state: NotRequired[
        "capo_network_firewall.types.transit_gateway_attachment_sync_state.TransitGatewayAttachmentSyncState"
    ]
    """<p>The synchronization state of the transit gateway attachment. This indicates whether the firewall's transit gateway configuration is properly synchronized and operational. Use this to verify that your transit gateway configuration changes have been applied.</p>"""

capacity_usage_summary instance-attribute 

capacity_usage_summary: NotRequired[CapacityUsageSummary]

Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.

configuration_sync_state_summary instance-attribute 

configuration_sync_state_summary: ConfigurationSyncState

The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.

When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.

This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.

status instance-attribute 

status: 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.

sync_states instance-attribute 

sync_states: NotRequired[SyncStates]

Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.

These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.

transit_gateway_attachment_sync_state instance-attribute 

transit_gateway_attachment_sync_state: NotRequired[TransitGatewayAttachmentSyncState]

The synchronization state of the transit gateway attachment. This indicates whether the firewall's transit gateway configuration is properly synchronized and operational. Use this to verify that your transit gateway configuration changes have been applied.