Firewall

class Firewall

A firewall defines the behavior of a firewall, the main VPC where the firewall is used, the Availability Zones where the firewall can be used, and one subnet to use for a firewall endpoint within each of the Availability Zones. The Availability Zones are defined implicitly in the subnet specifications.

In addition to the firewall endpoints that you define in this Firewall specification, you can create firewall endpoints in VpcEndpointAssociation resources for any VPC, in any Availability Zone where the firewall is already in use.

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 the firewall and firewall status by calling DescribeFirewall.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones.

Link copied to clipboard

The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.

Link copied to clipboard

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.

Link copied to clipboard

A description of the firewall.

Link copied to clipboard

An optional setting indicating the specific traffic analysis types to enable on the firewall.

Link copied to clipboard

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.

Link copied to clipboard

The Amazon Resource Name (ARN) of the firewall.

Link copied to clipboard

The unique identifier for the firewall.

Link copied to clipboard

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

Link copied to clipboard

The Amazon Resource Name (ARN) of the firewall policy.

Link copied to clipboard

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.

Link copied to clipboard

The number of VpcEndpointAssociation resources that use this firewall.

Link copied to clipboard

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.

Link copied to clipboard

The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

Link copied to clipboard
val tags: List<Tag>?
Link copied to clipboard

The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.

Link copied to clipboard

The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.

Link copied to clipboard

The unique identifier of the VPC where the firewall is in use.

Functions

Link copied to clipboard
inline fun copy(block: Firewall.Builder.() -> Unit = {}): Firewall
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String