aws_network_firewall_firewalls Resource

[edit on GitHub]

Use the aws_network_firewall_firewalls InSpec audit resource to test properties of multiple AWS Network Firewall firewalls.

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

For additional information, including details on parameters and properties, see the AWS documentation on AWS Network Firewall Firewall.

Installation

This resource is available in the Chef InSpec AWS resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your AWS environment for InSpec and creating an InSpec profile that uses the InSpec AWS resource pack.

Syntax

Ensure that the firewall exists.

describe aws_network_firewall_firewalls do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

firewall_names

The descriptive name of the firewall.

Field: firewall_name

firewall_arns

The Amazon Resource Name (ARN) of the firewall.

Field: firewall_arn

Examples

Ensure a firewall name is available.

describe aws_network_firewall_firewalls do
  its('firewall_names') { should include 'FIREWALL_NAME' }
end

Ensure that the firewall ARN is FIREWALL_ARN.

describe aws_network_firewall_firewalls do
    its('firewall_arns') { should include 'FIREWALL_ARN' }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

The controls will pass if the describe method returns at least one result.

exist

Use should to test that the entity exists.

describe aws_network_firewall_firewalls do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_network_firewall_firewalls do
  it { should_not exist }
end

be_available

Use should to check if the entity is available.

describe aws_network_firewall_firewalls do
  it { should be_available }
end

AWS Permissions

Your Principal will need the NetworkFirewall:Client:DescribeFirewallResponse action with Effect set to Allow.