java.lang.Object
- software.amazon.awssdk.services.networkfirewall.model.Firewall

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Firewall.Builder,Firewall>
```
@Generated("software.amazon.awssdk:codegen")
public final class Firewall
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Firewall.Builder,Firewall>
```
The firewall defines the configuration settings for an Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both objects by calling DescribeFirewall.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Firewall.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Firewall.Builder`	`builder()`
`Boolean`	`deleteProtection()`	A flag indicating whether it is possible to delete the firewall.
`String`	`description()`	A description of the firewall.
`EncryptionConfiguration`	`encryptionConfiguration()`	A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`firewallArn()`	The Amazon Resource Name (ARN) of the firewall.
`String`	`firewallId()`	The unique identifier for the firewall.
`String`	`firewallName()`	The descriptive name of the firewall.
`String`	`firewallPolicyArn()`	The Amazon Resource Name (ARN) of the firewall policy.
`Boolean`	`firewallPolicyChangeProtection()`	A setting indicating whether the firewall is protected against a change to the firewall policy association.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSubnetMappings()`	For responses, this returns true if the service returned a value for the SubnetMappings property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Firewall.Builder>`	`serializableBuilderClass()`
`Boolean`	`subnetChangeProtection()`	A setting indicating whether the firewall is protected against changes to the subnet associations.
`List<SubnetMapping>`	`subnetMappings()`	The public subnets that Network Firewall is using for the firewall.
`List<Tag>`	`tags()`
`Firewall.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`vpcId()`	The unique identifier of the VPC where the firewall is in use.

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
  - firewallName
```
public final String firewallName()
```
    The descriptive name of the firewall. You can't change the name of a firewall after you create it.
    
    Returns:
    
    The descriptive name of the firewall. You can't change the name of a firewall after you create it.
  - firewallArn
```
public final String firewallArn()
```
    The Amazon Resource Name (ARN) of the firewall.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the firewall.
  - firewallPolicyArn
```
public final String firewallPolicyArn()
```
    The Amazon Resource Name (ARN) of the firewall policy.
    
    The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the firewall policy.
    
    The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
  - vpcId
```
public final String vpcId()
```
    The unique identifier of the VPC where the firewall is in use.
    
    Returns:
    
    The unique identifier of the VPC where the firewall is in use.
  - hasSubnetMappings
```
public final boolean hasSubnetMappings()
```
    For responses, this returns true if the service returned a value for the SubnetMappings 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.
  - subnetMappings
```
public final List<SubnetMapping> subnetMappings()
```
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    
    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 hasSubnetMappings() method.
    
    Returns:
    
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
  - deleteProtection
```
public final Boolean deleteProtection()
```
    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
    
    Returns:
    
    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
  - subnetChangeProtection
```
public final Boolean subnetChangeProtection()
```
    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
    
    Returns:
    
    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
  - firewallPolicyChangeProtection
```
public final Boolean firewallPolicyChangeProtection()
```
    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
    
    Returns:
    
    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
  - description
```
public final String description()
```
    A description of the firewall.
    
    Returns:
    
    A description of the firewall.
  - firewallId
```
public final String firewallId()
```
    The unique identifier for the firewall.
    
    Returns:
    
    The unique identifier for the firewall.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    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 hasTags() method.
    
    Returns:
  - encryptionConfiguration
```
public final EncryptionConfiguration encryptionConfiguration()
```
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
    
    Returns:
    
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
  - toBuilder
```
public Firewall.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Firewall.Builder,Firewall>
  - builder
```
public static Firewall.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Firewall.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

Class Firewall

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

firewallName

firewallArn

firewallPolicyArn

vpcId

hasSubnetMappings

subnetMappings

deleteProtection

subnetChangeProtection

firewallPolicyChangeProtection

description

firewallId

hasTags

tags

encryptionConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields