Firewall (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.networkfirewall.model.Firewall

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Firewall
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Firewall()

Constructors
Constructor and Description
`Firewall()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Firewall`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getDeleteProtection()` A flag indicating whether it is possible to delete the firewall.
`String`	`getDescription()` A description of the firewall.
`EncryptionConfiguration`	`getEncryptionConfiguration()` A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
`String`	`getFirewallArn()` The Amazon Resource Name (ARN) of the firewall.
`String`	`getFirewallId()` The unique identifier for the firewall.
`String`	`getFirewallName()` The descriptive name of the firewall.
`String`	`getFirewallPolicyArn()` The Amazon Resource Name (ARN) of the firewall policy.
`Boolean`	`getFirewallPolicyChangeProtection()` A setting indicating whether the firewall is protected against a change to the firewall policy association.
`Boolean`	`getSubnetChangeProtection()` A setting indicating whether the firewall is protected against changes to the subnet associations.
`List<SubnetMapping>`	`getSubnetMappings()` The public subnets that Network Firewall is using for the firewall.
`List<Tag>`	`getTags()`
`String`	`getVpcId()` The unique identifier of the VPC where the firewall is in use.
`int`	`hashCode()`
`Boolean`	`isDeleteProtection()` A flag indicating whether it is possible to delete the firewall.
`Boolean`	`isFirewallPolicyChangeProtection()` A setting indicating whether the firewall is protected against a change to the firewall policy association.
`Boolean`	`isSubnetChangeProtection()` A setting indicating whether the firewall is protected against changes to the subnet associations.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDeleteProtection(Boolean deleteProtection)` A flag indicating whether it is possible to delete the firewall.
`void`	`setDescription(String description)` A description of the firewall.
`void`	`setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)` A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
`void`	`setFirewallArn(String firewallArn)` The Amazon Resource Name (ARN) of the firewall.
`void`	`setFirewallId(String firewallId)` The unique identifier for the firewall.
`void`	`setFirewallName(String firewallName)` The descriptive name of the firewall.
`void`	`setFirewallPolicyArn(String firewallPolicyArn)` The Amazon Resource Name (ARN) of the firewall policy.
`void`	`setFirewallPolicyChangeProtection(Boolean firewallPolicyChangeProtection)` A setting indicating whether the firewall is protected against a change to the firewall policy association.
`void`	`setSubnetChangeProtection(Boolean subnetChangeProtection)` A setting indicating whether the firewall is protected against changes to the subnet associations.
`void`	`setSubnetMappings(Collection<SubnetMapping> subnetMappings)` The public subnets that Network Firewall is using for the firewall.
`void`	`setTags(Collection<Tag> tags)`
`void`	`setVpcId(String vpcId)` The unique identifier of the VPC where the firewall is in use.
`String`	`toString()` Returns a string representation of this object.
`Firewall`	`withDeleteProtection(Boolean deleteProtection)` A flag indicating whether it is possible to delete the firewall.
`Firewall`	`withDescription(String description)` A description of the firewall.
`Firewall`	`withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)` A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
`Firewall`	`withFirewallArn(String firewallArn)` The Amazon Resource Name (ARN) of the firewall.
`Firewall`	`withFirewallId(String firewallId)` The unique identifier for the firewall.
`Firewall`	`withFirewallName(String firewallName)` The descriptive name of the firewall.
`Firewall`	`withFirewallPolicyArn(String firewallPolicyArn)` The Amazon Resource Name (ARN) of the firewall policy.
`Firewall`	`withFirewallPolicyChangeProtection(Boolean firewallPolicyChangeProtection)` A setting indicating whether the firewall is protected against a change to the firewall policy association.
`Firewall`	`withSubnetChangeProtection(Boolean subnetChangeProtection)` A setting indicating whether the firewall is protected against changes to the subnet associations.
`Firewall`	`withSubnetMappings(Collection<SubnetMapping> subnetMappings)` The public subnets that Network Firewall is using for the firewall.
`Firewall`	`withSubnetMappings(SubnetMapping... subnetMappings)` The public subnets that Network Firewall is using for the firewall.
`Firewall`	`withTags(Collection<Tag> tags)`
`Firewall`	`withTags(Tag... tags)`
`Firewall`	`withVpcId(String vpcId)` The unique identifier of the VPC where the firewall is in use.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Firewall
```
public Firewall()
```
- Method Detail
  - setFirewallName
```
public void setFirewallName(String firewallName)
```
    The descriptive name of the firewall. You can't change the name of a firewall after you create it.
    
    Parameters:
    
    firewallName - The descriptive name of the firewall. You can't change the name of a firewall after you create it.
  - getFirewallName
```
public String getFirewallName()
```
    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.
  - withFirewallName
```
public Firewall withFirewallName(String firewallName)
```
    The descriptive name of the firewall. You can't change the name of a firewall after you create it.
    
    Parameters:
    
    firewallName - The descriptive name of the firewall. You can't change the name of a firewall after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFirewallArn
```
public void setFirewallArn(String firewallArn)
```
    The Amazon Resource Name (ARN) of the firewall.
    
    Parameters:
    
    firewallArn - The Amazon Resource Name (ARN) of the firewall.
  - getFirewallArn
```
public String getFirewallArn()
```
    The Amazon Resource Name (ARN) of the firewall.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the firewall.
  - withFirewallArn
```
public Firewall withFirewallArn(String firewallArn)
```
    The Amazon Resource Name (ARN) of the firewall.
    
    Parameters:
    
    firewallArn - The Amazon Resource Name (ARN) of the firewall.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFirewallPolicyArn
```
public void setFirewallPolicyArn(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.
    
    Parameters:
    
    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.
  - getFirewallPolicyArn
```
public String getFirewallPolicyArn()
```
    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.
  - withFirewallPolicyArn
```
public Firewall withFirewallPolicyArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcId
```
public void setVpcId(String vpcId)
```
    The unique identifier of the VPC where the firewall is in use.
    
    Parameters:
    
    vpcId - The unique identifier of the VPC where the firewall is in use.
  - getVpcId
```
public String getVpcId()
```
    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.
  - withVpcId
```
public Firewall withVpcId(String vpcId)
```
    The unique identifier of the VPC where the firewall is in use.
    
    Parameters:
    
    vpcId - The unique identifier of the VPC where the firewall is in use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubnetMappings
```
public List<SubnetMapping> getSubnetMappings()
```
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    
    Returns:
    
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
  - setSubnetMappings
```
public void setSubnetMappings(Collection<SubnetMapping> subnetMappings)
```
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    
    Parameters:
    
    subnetMappings - The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
  - withSubnetMappings
```
public Firewall withSubnetMappings(SubnetMapping... subnetMappings)
```
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubnetMappings(java.util.Collection) or withSubnetMappings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    subnetMappings - The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetMappings
```
public Firewall withSubnetMappings(Collection<SubnetMapping> subnetMappings)
```
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    
    Parameters:
    
    subnetMappings - The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeleteProtection
```
public void setDeleteProtection(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.
    
    Parameters:
    
    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.
  - getDeleteProtection
```
public Boolean getDeleteProtection()
```
    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.
  - withDeleteProtection
```
public Firewall withDeleteProtection(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDeleteProtection
```
public Boolean isDeleteProtection()
```
    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.
  - setSubnetChangeProtection
```
public void setSubnetChangeProtection(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.
    
    Parameters:
    
    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.
  - getSubnetChangeProtection
```
public Boolean getSubnetChangeProtection()
```
    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.
  - withSubnetChangeProtection
```
public Firewall withSubnetChangeProtection(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSubnetChangeProtection
```
public Boolean isSubnetChangeProtection()
```
    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.
  - setFirewallPolicyChangeProtection
```
public void setFirewallPolicyChangeProtection(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.
    
    Parameters:
    
    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.
  - getFirewallPolicyChangeProtection
```
public Boolean getFirewallPolicyChangeProtection()
```
    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.
  - withFirewallPolicyChangeProtection
```
public Firewall withFirewallPolicyChangeProtection(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isFirewallPolicyChangeProtection
```
public Boolean isFirewallPolicyChangeProtection()
```
    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.
  - setDescription
```
public void setDescription(String description)
```
    A description of the firewall.
    
    Parameters:
    
    description - A description of the firewall.
  - getDescription
```
public String getDescription()
```
    A description of the firewall.
    
    Returns:
    
    A description of the firewall.
  - withDescription
```
public Firewall withDescription(String description)
```
    A description of the firewall.
    
    Parameters:
    
    description - A description of the firewall.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFirewallId
```
public void setFirewallId(String firewallId)
```
    The unique identifier for the firewall.
    
    Parameters:
    
    firewallId - The unique identifier for the firewall.
  - getFirewallId
```
public String getFirewallId()
```
    The unique identifier for the firewall.
    
    Returns:
    
    The unique identifier for the firewall.
  - withFirewallId
```
public Firewall withFirewallId(String firewallId)
```
    The unique identifier for the firewall.
    
    Parameters:
    
    firewallId - The unique identifier for the firewall.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Returns:
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Parameters:
    
    tags -
  - withTags
```
public Firewall withTags(Tag... tags)
```
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public Firewall withTags(Collection<Tag> tags)
```
    Parameters:
    
    tags -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncryptionConfiguration
```
public void setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
```
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
    
    Parameters:
    
    encryptionConfiguration - A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
  - getEncryptionConfiguration
```
public EncryptionConfiguration getEncryptionConfiguration()
```
    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.
  - withEncryptionConfiguration
```
public Firewall withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
```
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
    
    Parameters:
    
    encryptionConfiguration - A complex type that contains the Amazon Web Services KMS encryption configuration settings for your 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 Firewall clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.485

Class Firewall

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Firewall

Method Detail

setFirewallName

getFirewallName

withFirewallName

setFirewallArn

getFirewallArn

withFirewallArn

setFirewallPolicyArn

getFirewallPolicyArn

withFirewallPolicyArn

setVpcId

getVpcId

withVpcId

getSubnetMappings

setSubnetMappings

withSubnetMappings

withSubnetMappings

setDeleteProtection

getDeleteProtection

withDeleteProtection

isDeleteProtection

setSubnetChangeProtection

getSubnetChangeProtection

withSubnetChangeProtection

isSubnetChangeProtection

setFirewallPolicyChangeProtection

getFirewallPolicyChangeProtection

withFirewallPolicyChangeProtection

isFirewallPolicyChangeProtection

setDescription

getDescription

withDescription

setFirewallId

getFirewallId

withFirewallId

getTags

setTags

withTags

withTags

setEncryptionConfiguration

getEncryptionConfiguration

withEncryptionConfiguration

toString

equals

hashCode

clone

marshall