aws_cloudwatchlogs_destination Resource

[edit on GitHub]

Use the aws_cloudwatchlogs_destination InSpec audit resource to test properties of a single specific AWS Logs destination.

The AWS::Logs::Destination resource type specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.

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

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 destination name exists.

describe aws_cloudwatchlogs_destination(destination_name_prefix: "DESTINATION_NAME") do
  it { should exist }
end

Parameters

destination_name_prefix (required)

The name of the destination.

Properties

destination_name

The name of the destination.

target_arn

The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

role_arn

The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.

access_policy

An IAM policy document governing the Amazon Web Services accounts, which can create subscription filters against this destination.

arn

The ARN of this destination.

creation_time

The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Examples

Ensure destination name is available.

describe aws_cloudwatchlogs_destination(destination_name_prefix: "DESTINATION_NAME") do
  its('destination_name') { should eq 'DESTINATION_NAME' }
end

Ensure that the IAM role ARN is available.

describe aws_cloudwatchlogs_destination(destination_name_prefix: "DESTINATION_NAME") do
    its('role_arn') { should eq 'ROLE_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 describe method returns at least one result.

exist

Use should to test that the entity exists.

describe aws_cloudwatchlogs_destination(destination_name_prefix: "DESTINATION_NAME") do
  it { should exist }
end

Use should_not to test that the entity does not exist.

describe aws_cloudwatchlogs_destination(destination_name_prefix: "DESTINATION_NAME") do
  it { should_not exist }
end

be_available

Use should to check if the entity is available.

describe aws_cloudwatchlogs_destination(destination_name_prefix: "DESTINATION_NAME") do
  it { should be_available }
end

AWS Permissions

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