AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::NetworkFirewall::Types::Firewall

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The firewall defines the configuration settings for an AWS 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 AWS 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#delete_protectionBoolean

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:

  • (Boolean)

    A flag indicating whether it is possible to delete the firewall.

#descriptionString

A description of the firewall.

Returns:

  • (String)

    A description of the firewall.

#firewall_arnString

The Amazon Resource Name (ARN) of the firewall.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the firewall.

#firewall_idString

The unique identifier for the firewall.

Returns:

  • (String)

    The unique identifier for the firewall.

#firewall_nameString

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

Returns:

  • (String)

    The descriptive name of the firewall.

#firewall_policy_arnString

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:

  • (String)

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

#firewall_policy_change_protectionBoolean

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:

  • (Boolean)

    A setting indicating whether the firewall is protected against a change to the firewall policy association.

#subnet_change_protectionBoolean

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:

  • (Boolean)

    A setting indicating whether the firewall is protected against changes to the subnet associations.

#subnet_mappingsArray<Types::SubnetMapping>

The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.

Returns:

  • (Array<Types::SubnetMapping>)

    The public subnets that Network Firewall is using for the firewall.

#tagsArray<Types::Tag>

Returns:

#vpc_idString

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

Returns:

  • (String)

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