aws_cloudwatchlogs_subscription_filter Resource
Use the aws_cloudwatchlogs_subscription_filter
InSpec audit resource to test properties of a single specific AWS Logs Subscription Filter.
The AWS::Logs::SubscriptionFilter specifies a subscription filter and associates it with the specified log group.
For additional information, including details on parameters and properties, see the AWS documentation on AWS Logs SubscriptionFilter..
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 the subscription filter exists.
describe aws_cloudwatchlogs_subscription_filter(log_group_name: "LOG_GROUP_NAME", filter_name_prefix: "FILTER_NAME") do
it { should exist }
end
Parameters
log_group_name
and filter_name_prefix
(required)
log_group_name
- The name of the log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
filter_name_prefix
- The name of the subscription filter.
Properties
filter_name
- The name of the subscription filter.
log_group_name
- The name of the log group.
filter_pattern
- A symbolic description of how CloudWatch Logs should interpret the data in each log event.
destination_arn
- The Amazon Resource Name (ARN) of the destination.
role_arn
- The ARN of the IAM role.
distribution
- The method used to distribute log data to the destination, which can be either random or grouped by log stream.
creation_time
- The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Examples
Ensure a filter name is available.
describe aws_cloudwatchlogs_subscription_filter(log_group_name: "LOG_GROUP_NAME", filter_name_prefix: "FILTER_NAME") do
its('filter_name') { should eq 'FILTER_NAME' }
end
Ensure a filter log group name is available.
describe aws_cloudwatchlogs_subscription_filter(log_group_name: "LOG_GROUP_NAME", filter_name_prefix: "FILTER_NAME") do
its('log_group_name') { should eq 'LOG_GROUP_NAME' }
end
Matchers
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.
exist
Use should
to test that the entity exists.
describe aws_cloudwatchlogs_subscription_filter(log_group_name: "LOG_GROUP_NAME", filter_name_prefix: "FILTER_NAME") do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_cloudwatchlogs_subscription_filter(log_group_name: "LOG_GROUP_NAME", filter_name_prefix: "FILTER_NAME") do
it { should_not exist }
end
be_available
Use should
to check if the entity is available.
describe aws_cloudwatchlogs_subscription_filter(log_group_name: "LOG_GROUP_NAME", filter_name_prefix: "FILTER_NAME") do
it { should be_available }
end
AWS Permissions
Your Principal will need the CloudWatchLogs:Client:DescribeSubscriptionFiltersResponse
action with Effect
set to Allow
.