aws_network_firewall_rule_groups Resource

[edit on GitHub]

Use the aws_network_firewall_rule_groups InSpec audit resource to test properties of multiple AWS Network Firewall rule groups.

The AWS::NetworkFirewall::RuleGroup resource defines a reusable collection of stateless or stateful network traffic filtering rules.

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

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 rule group exists.

describe aws_network_firewall_rule_groups do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

names

The descriptive name of the rule group.

Field: name

arns

The Amazon Resource Name (ARN) of the rule group.

Field: arn

Examples

Ensure a name is available.

describe aws_network_firewall_rule_groups do
  its('names') { should include 'RULE_GROUP_NaAME' }
end

Ensure that the arn is available.

describe aws_network_firewall_rule_groups do
    its('arns') { should include '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 list method returns at least one result.

exist

Use should to test that the entity exists.

describe aws_network_firewall_rule_groups do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_network_firewall_rule_groups do
  it { should_not exist }
end

AWS Permissions

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