software.amazon.awssdk.services.networkfirewall.model

Class SyncState

java.lang.Object

software.amazon.awssdk.services.networkfirewall.model.SyncState

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class SyncState
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SyncState.Builder,SyncState>

The status of the firewall endpoint and firewall policy configuration for a single VPC subnet.

For each VPC subnet that you associate with a firewall, Network Firewall does the following:

• Instantiates a firewall endpoint in the subnet, ready to take traffic.

• Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.

When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SyncState.Builder

Method Summary

Modifier and Type	Method and Description
Attachment	attachment() The attachment status of the firewall's association with a single VPC subnet.
static SyncState.Builder	builder()
Map<String,PerObjectStatus>	config() The configuration status of the firewall endpoint in a single VPC subnet.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConfig() For responses, this returns true if the service returned a value for the Config property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SyncState.Builder>	serializableBuilderClass()
SyncState.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

attachment

public final Attachment attachment()

The attachment status of the firewall's association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.

Returns:

The attachment status of the firewall's association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.

hasConfig

public final boolean hasConfig()

For responses, this returns true if the service returned a value for the Config 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.

config

public final Map<String,PerObjectStatus> config()

The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.

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 hasConfig() method.

Returns:

The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.

toBuilder

public SyncState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SyncState.Builder,SyncState>

builder

public static SyncState.Builder builder()

serializableBuilderClass

public static Class<? extends SyncState.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