aws_waf_byte_match_sets resource
Use the aws_waf_byte_match_sets
Chef InSpec audit resource to test the properties of multiple AWS (Web Application Firewall) WAF byte match sets.
For additional information, including details on parameters and properties, see the AWS documentation on the AWS::WAF::ByteMatchSet
resource type.
Install
This resource is available in the Chef InSpec AWS resource pack.
For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the Chef InSpec documentation on the AWS cloud platform.
Syntax
Ensure that a byte match set exists.
describe aws_waf_byte_match_sets do
it { should exist }
end
Parameters
This resource does not require any parameters.
Properties
byte_match_set_ids
- The unique identifier for the ByteMatchSet.
Field:
byte_match_set_id
names
- The name of the ByteMatchSet.
Field:
name
Examples
Ensure a byte match set is available.
describe aws_waf_byte_match_sets do
its('byte_match_set_ids') { should include 'BYTE_MATCH_SET_ID' }
end
Ensure a byte match set name is available.
describe aws_waf_byte_match_sets do
its('names') { should include 'BYTE_MATCH_SET_NAME' }
end
Matchers
This Chef InSpec audit resource has the following special matchers.
For a full list of available matchers, see 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_byte_match_sets do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_waf_byte_match_sets do
it { should_not exist }
end
AWS Permissions
Your Principal will need the WAF:Client:ListByteMatchSetsResponse
action with Effect
set to Allow
.