Class FirewallStatus

java.lang.Object
software.amazon.awssdk.services.networkfirewall.model.FirewallStatus
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FirewallStatus.Builder,FirewallStatus>
@Generated("software.amazon.awssdk:codegen") public final class FirewallStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FirewallStatus.Builder,FirewallStatus>

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:

  • Method Details

    • status

      public final FirewallStatusValue status()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return FirewallStatusValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.
      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return FirewallStatusValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.
      See Also:

    • configurationSyncStateSummary

      public final ConfigurationSyncState configurationSyncStateSummary()

      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.

      If the service returns an enum value that is not available in the current SDK version, configurationSyncStateSummary will return ConfigurationSyncState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationSyncStateSummaryAsString().

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

      See Also:

    • configurationSyncStateSummaryAsString

      public final String configurationSyncStateSummaryAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, configurationSyncStateSummary will return ConfigurationSyncState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationSyncStateSummaryAsString().

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

      See Also:

    • hasSyncStates

      public final boolean hasSyncStates()
      For responses, this returns true if the service returned a value for the SyncStates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • syncStates

      public final Map<String,SyncState> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSyncStates() method.

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

    • capacityUsageSummary

      public final CapacityUsageSummary 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:
      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.

    • transitGatewayAttachmentSyncState

      public final TransitGatewayAttachmentSyncState 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:
      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.

    • toBuilder

      public FirewallStatus.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FirewallStatus.Builder,FirewallStatus>
      Returns:
      a builder for type T

    • builder

      public static FirewallStatus.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FirewallStatus.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.