aws_waf_ip_sets resource

[edit on GitHub]

Use the aws_waf_ip_sets Chef InSpec audit resource to test the properties of multiple AWS Web Application Firewall (WAF) IP sets.

For additional information, including details on parameters and properties, see the AWS documentation on AWS::WAF::IPSet resource.

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 IP set exists.

describe aws_waf_ip_sets do
  it { should exist }
end

Parameters

ip_set_id (required)

The ID for an IP set.

Properties

ip_set_ids

The IPSetId for an IPSet.

Field: ip_set_id

names

A friendly name or description of the IPSet.

Field: name

Examples

Ensure an IP set is available.

describe aws_waf_ip_sets do
  its('ip_set_ids') { should include 'IP_SET_ID' }
end

Ensure an IP set name is available.

describe aws_waf_ip_sets do
    its('names') { should include 'IP_SET_NAME' }
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_waf_ip_sets do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_waf_ip_sets do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the WAF:Client:ListIPSetsResponse action with Effect set to Allow.