AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::NetworkFirewall::Types::FirewallStatus

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_sync_state_summaryString

The configuration sync state for the firewall. This summarizes the sync states reported in the Config settings for all of the Availability Zones where you have configured the firewall.

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 zones where the firewall is in use. 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.

Possible values:

  • PENDING
  • IN_SYNC

Returns:

  • (String)

    The configuration sync state for the firewall.

#statusString

The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you\'ve configured it. 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.

Possible values:

  • PROVISIONING
  • DELETING
  • READY

Returns:

  • (String)

    The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you\'ve configured it.

#sync_statesHash<String,Types::SyncState>

The subnets that you\'ve configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you\'ve configured a subnet. These objects provide details of the information that is summarized in the ConfigurationSyncStateSummary and Status, broken down by zone and configuration object.

Returns:

  • (Hash<String,Types::SyncState>)

    The subnets that you\'ve configured for use by the Network Firewall firewall.