Firewall

networkfirewall.services.k8s.aws/v1alpha1

Metadata#

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.

Spec#

deleteProtection: boolean
description: string
encryptionConfiguration: 
  keyID: string
  type_: string
firewallName: string
firewallPolicyARN: string
firewallPolicyChangeProtection: boolean
loggingConfiguration: 
  logDestinationConfigs:
    logDestination: {}
    logDestinationType: string
    logType: string
subnetChangeProtection: boolean
subnetMappings:
- ipAddressType: string
  subnetID: string
tags:
- key: string
  value: string
vpcID: string

Network Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log types. || loggingConfiguration.logDestinationConfigs.[].logDestination
Optional | object
| | loggingConfiguration.logDestinationConfigs.[].logDestinationType
Optional | string
| | loggingConfiguration.logDestinationConfigs.[].logType
Optional | string
| | subnetChangeProtection
Optional | boolean
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. | | subnetMappings
Required | array
The public subnets to use for your Network Firewall firewalls. Each subnet
must belong to a different Availability Zone in the VPC. Network Firewall
creates a firewall endpoint in each subnet. | | subnetMappings.[]
Required | object
The ID for a subnet that you want to associate with the firewall. This is used with CreateFirewall and AssociateSubnets. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet’s Availability Zone. || subnetMappings.[].ipAddressType
Optional | string
| | subnetMappings.[].subnetID
Optional | string
| | tags
Optional | array
The key:value pairs to associate with the resource. | | tags.[]
Required | object
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each Amazon Web Services resource. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
| | vpcID
Required | string
The unique identifier of the VPC where Network Firewall should create the
firewall.

You can’t change this setting after you create the firewall. |

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
firewall: 
  deleteProtection: boolean
  description: string
  encryptionConfiguration: 
    keyID: string
    type_: string
  firewallARN: string
  firewallID: string
  firewallName: string
  firewallPolicyARN: string
  firewallPolicyChangeProtection: boolean
  subnetChangeProtection: boolean
  subnetMappings:
  - ipAddressType: string
    subnetID: string
  tags:
  - key: string
    value: string
  vpcID: string
firewallStatus: 
  capacityUsageSummary: 
    cidrs: 
      availableCIDRCount: integer
      ipSetReferences: {}
      utilizedCIDRCount: integer
  configurationSyncStateSummary: string
  status: string
  syncStates: {}