aws_logs_metric_filters Resource

Use the aws_logs_metric_filters InSpec audit resource to test properties of multiple AWS CloudWatch logs metric filters.

For additional information, including details on parameters and properties, see the AWS documentation on AWS Logs MetricFilter.

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.

Ensure that a filter name exists.

describe aws_logs_metric_filters do
  it { should exist }
end

This resource does not require any parameters.

filter_names: The name of the metric filter.
filter_patterns: A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.
metric_transformations: The metric transformations.
creation_times: The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
log_group_names: The name of the log group.

Ensure a filter name is available.

describe aws_logs_metric_filters do
  its('filter_names') { should include 'FILTER_NAME' }
end

Ensure a log group name is available.

describe aws_logs_metric_filters do
    its('log_group_names') { should include 'LOG_GROUP_NAME' }
end

For a full list of available matchers, see our Universal Matchers page.

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

Use should to test that the entity exists.

describe aws_logs_metric_filters do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_logs_metric_filters do
  it { should_not exist }
end

Use should to check if the filter name is available.

describe aws_logs_metric_filters do
  it { should be_available }
end

Your Principal will need the CloudWatchLogs:Client:DescribeMetricFiltersResponse action with Effect set to Allow.