software.amazon.awssdk.services.networkfirewall.model

Class FirewallStatus

java.lang.Object

software.amazon.awssdk.services.networkfirewall.model.FirewallStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FirewallStatus.Builder,FirewallStatus>

@Generated(value="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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FirewallStatus.Builder

Method Summary

Modifier and Type	Method and Description
static FirewallStatus.Builder	builder()
ConfigurationSyncState	configurationSyncStateSummary() The configuration sync state for the firewall.
String	configurationSyncStateSummaryAsString() The configuration sync state for the firewall.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSyncStates() Returns true if the SyncStates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends FirewallStatus.Builder>	serializableBuilderClass()
FirewallStatusValue	status() The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it.
String	statusAsString() The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it.
Map<String,SyncState>	syncStates() The subnets that you've configured for use by the Network Firewall firewall.
FirewallStatus.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

status

public final FirewallStatusValue status()

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.

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'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.

See Also:

FirewallStatusValue

statusAsString

public final String statusAsString()

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.

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'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.

See Also:

FirewallStatusValue

configurationSyncStateSummary

public final ConfigurationSyncState configurationSyncStateSummary()

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.

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

See Also:

ConfigurationSyncState

configurationSyncStateSummaryAsString

public final String configurationSyncStateSummaryAsString()

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.

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

See Also:

ConfigurationSyncState

hasSyncStates

public final boolean hasSyncStates()

Returns true if the SyncStates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

syncStates

public final Map<String,SyncState> syncStates()

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.

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

You can use hasSyncStates() to see if a value was sent in this field.

Returns:

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.

toBuilder

public FirewallStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FirewallStatus.Builder,FirewallStatus>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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