com.amazonaws.services.networkfirewall.model

Class FirewallStatus

java.lang.Object

com.amazonaws.services.networkfirewall.model.FirewallStatus

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FirewallStatus
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FirewallStatus()

Method Summary

Modifier and Type	Method and Description
FirewallStatus	addSyncStatesEntry(String key, SyncState value) Add a single SyncStates entry
FirewallStatus	clearSyncStatesEntries() Removes all the entries added into SyncStates.
FirewallStatus	clone()
boolean	equals(Object obj)
CapacityUsageSummary	getCapacityUsageSummary() Describes the capacity usage of the resources contained in a firewall's reference sets.
String	getConfigurationSyncStateSummary() The configuration sync state for the firewall.
String	getStatus() The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it.
Map<String,SyncState>	getSyncStates() The subnets that you've configured for use by the Network Firewall firewall.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCapacityUsageSummary(CapacityUsageSummary capacityUsageSummary) Describes the capacity usage of the resources contained in a firewall's reference sets.
void	setConfigurationSyncStateSummary(String configurationSyncStateSummary) The configuration sync state for the firewall.
void	setStatus(String status) The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it.
void	setSyncStates(Map<String,SyncState> syncStates) The subnets that you've configured for use by the Network Firewall firewall.
String	toString() Returns a string representation of this object.
FirewallStatus	withCapacityUsageSummary(CapacityUsageSummary capacityUsageSummary) Describes the capacity usage of the resources contained in a firewall's reference sets.
FirewallStatus	withConfigurationSyncStateSummary(ConfigurationSyncState configurationSyncStateSummary) The configuration sync state for the firewall.
FirewallStatus	withConfigurationSyncStateSummary(String configurationSyncStateSummary) The configuration sync state for the firewall.
FirewallStatus	withStatus(FirewallStatusValue status) The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it.
FirewallStatus	withStatus(String status) The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it.
FirewallStatus	withSyncStates(Map<String,SyncState> syncStates) The subnets that you've configured for use by the Network Firewall firewall.

Methods inherited from class java.lang.Object

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

Constructor Detail

FirewallStatus

public FirewallStatus()

Method Detail

setStatus

public void setStatus(String 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.

Parameters:

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.

See Also:

FirewallStatusValue

getStatus

public String getStatus()

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.

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

withStatus

public FirewallStatus withStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FirewallStatusValue

withStatus

public FirewallStatus withStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FirewallStatusValue

setConfigurationSyncStateSummary

public void setConfigurationSyncStateSummary(String 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.

Parameters:

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.

See Also:

ConfigurationSyncState

getConfigurationSyncStateSummary

public String getConfigurationSyncStateSummary()

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.

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

withConfigurationSyncStateSummary

public FirewallStatus withConfigurationSyncStateSummary(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigurationSyncState

withConfigurationSyncStateSummary

public FirewallStatus withConfigurationSyncStateSummary(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigurationSyncState

getSyncStates

public Map<String,SyncState> getSyncStates()

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:

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.

setSyncStates

public void setSyncStates(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.

Parameters:

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.

withSyncStates

public FirewallStatus withSyncStates(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addSyncStatesEntry

public FirewallStatus addSyncStatesEntry(String key,
                                         SyncState value)

Add a single SyncStates entry

See Also:

withSyncStates(java.util.Map<java.lang.String, com.amazonaws.services.networkfirewall.model.SyncState>)

clearSyncStatesEntries

public FirewallStatus clearSyncStatesEntries()

Removes all the entries added into SyncStates.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCapacityUsageSummary

public void setCapacityUsageSummary(CapacityUsageSummary capacityUsageSummary)

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

Parameters:

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

getCapacityUsageSummary

public CapacityUsageSummary getCapacityUsageSummary()

Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates 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 calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.

withCapacityUsageSummary

public FirewallStatus withCapacityUsageSummary(CapacityUsageSummary capacityUsageSummary)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public FirewallStatus clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo