aws_cloudfront_key_groups Resource

[edit on GitHub]

Use the aws_cloudfront_key_groups InSpec audit resource to test properties of multiple AWS CloudFront key groups.

For additional information, including details on parameters and properties, see the AWS documentation on AWS CloudFront key group..

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 key group exists.

describe aws_cloudfront_key_groups do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

ids

The identifier for the key group.

Field: id

last_modified_times

The date and time when the key group was last modified.

Field: last_modified_time

names

A name to identify the key group.

Field: name

items

A list of the identifiers of the public keys in the key group.

Field: items

comments

A comment to describe the key group. The comment cannot be longer than 128 characters.

Field: comment

Examples

Ensure an ID is available.

describe aws_cloudfront_key_groups do
  its('ids') { should include 'ID' }
end

Ensure that the key group name is available.

describe aws_cloudfront_key_groups do
    its('names') { should include 'KEY_GROUP_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_cloudfront_key_groups do
  it { should exist }
end

Use should_not to test that an entity does not exist.

describe aws_cloudfront_key_groups do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the CloudFront:Client:ListKeyGroupsResult action with Effect set to Allow.