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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb

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.

The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_usage_summary ⇒ Types::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.

Returns:



3158
3159
3160
3161
3162
3163
3164
3165
3166
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3158

class FirewallStatus < Struct.new(
  :status,
  :configuration_sync_state_summary,
  :sync_states,
  :capacity_usage_summary,
  :transit_gateway_attachment_sync_state)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_sync_state_summary ⇒ String

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.

Returns:

  • (String) 


3158
3159
3160
3161
3162
3163
3164
3165
3166
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3158

class FirewallStatus < Struct.new(
  :status,
  :configuration_sync_state_summary,
  :sync_states,
  :capacity_usage_summary,
  :transit_gateway_attachment_sync_state)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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.

Returns:

  • (String) 


3158
3159
3160
3161
3162
3163
3164
3165
3166
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3158

class FirewallStatus < Struct.new(
  :status,
  :configuration_sync_state_summary,
  :sync_states,
  :capacity_usage_summary,
  :transit_gateway_attachment_sync_state)
  SENSITIVE = []
  include Aws::Structure
end

#sync_states ⇒ Hash<String,Types::SyncState>

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.

Returns:



3158
3159
3160
3161
3162
3163
3164
3165
3166
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3158

class FirewallStatus < Struct.new(
  :status,
  :configuration_sync_state_summary,
  :sync_states,
  :capacity_usage_summary,
  :transit_gateway_attachment_sync_state)
  SENSITIVE = []
  include Aws::Structure
end

#transit_gateway_attachment_sync_state ⇒ Types::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.

Returns:



3158
3159
3160
3161
3162
3163
3164
3165
3166
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3158

class FirewallStatus < Struct.new(
  :status,
  :configuration_sync_state_summary,
  :sync_states,
  :capacity_usage_summary,
  :transit_gateway_attachment_sync_state)
  SENSITIVE = []
  include Aws::Structure
end