aws_network_firewall_logging_configuration Resource

[edit on GitHub]

Use the aws_network_firewall_logging_configuration InSpec audit resource to test properties of a single specific AWS Network Firewall Logging Configuration.

The AWS::NetworkFirewall::LoggingConfiguration resource defines the destinations and logging options for an AWS::NetworkFirewall::Firewall.

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

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_logging_configuration(firewall_name: 'FIREWALL_NAME') do
  it { should exist }
end

Parameters

firewall_name (required)

The Amazon Resource Name (ARN) of the firewall.

Properties

firewall_arn

The Amazon Resource Name (ARN) of the firewall.

logging_configuration_log_destination_configs_log_type

The type of log to send.

logging_configuration_log_destination_configs_log_destination_type

The type of storage destination to send these logs to.

logging_configuration_log_destination_configs_log_destination

The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.

Examples

Ensure a firewall ARN is available.

describe aws_network_firewall_logging_configuration(firewall_name: 'FIREWALL_NAME') do
  its('firewall_arn') { should eq 'FIREWALL_ARN' }
end

Ensure that the log type is available.

describe aws_network_firewall_logging_configuration(firewall_name: 'FIREWALL_NAME') do
    its('logging_configuration_log_destination_configs_log_type') { should eq 'LOG_TYPE' }
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_logging_configuration(firewall_name: 'FIREWALL_NAME') do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_network_firewall_logging_configuration(firewall_name: 'FIREWALL_NAME') do
  it { should_not exist }
end

be_available

Use should to check if the entity is available.

describe aws_network_firewall_logging_configuration(firewall_name: 'FIREWALL_NAME') do
  it { should be_available }
end

AWS Permissions

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