aws_dhcp_options Resource

DEPRECATION NOTICE

The aws_dhcp_options InSpec audit resource is deprecated and replaced by the aws_ec2_dhcp_option and aws_ec2_dhcp_options resources.

Use the aws_dhcp_options InSpec audit resource to test properties of a single AWS DHCP Options.

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

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 an aws_dhcp_options exists

describe aws_dhcp_options('dopt-0123456789abcdefg') do
  it { should exist }
end

describe aws_dhcp_options(dhcp_options_id: 'dopt-0123456789abcdefg') do
  it { should exist }
end

Parameters

dhcp_options_id (required): This resource accepts a single parameter, the DHCP Options ID which uniquely identifies the DHCP Options. This can be passed either as a string or as a dhcp_options_id: 'value' key-value entry in a hash.

Properties

dhcp_configurations: The list of dhcp configurations.
domain_name_servers: The list of domain name servers in the dhcp configuration.
ntp_servers: The list of ntp servers in the dhcp configuration.
tags: The tags of the DHCP Options.

Examples

Test tags on the DHCP options.

describe aws_dhcp_options('dopt-0123456789abcdefg') do
  its('tags') { should include(:Environment => 'env-name',
                               :Name => 'dhcp-options-name')}
end

AWS Permissions

Your Principal will need the EC2:Client:DescribeDhcpOptionsResult action with Effect set to Allow.

You can find detailed documentation at Actions, Resources, and Condition Keys for Amazon EC2.