aws_rds_group_option Resource

Use the aws_rds_group_option InSpec audit resource to test detailed properties of an individual RDS cluster.An aws_rds_group_option resource block uses resource parameters to search for an RDS option group, and then tests that RDS option group. If no RDS option group match, no error is raised, but the exists matcher will return false and all properties will be nil.

RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server.

For additional information, including details on parameters and properties, see the AWS documentation on RDS Option Group.

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 if the option group exists

describe aws_rds_group_option('default:aurora-5-6') do
  it { should exist }
end

# Can also use hash syntax

describe aws_rds_group_option(option_group_name: 'default:aurora-5-6') do
  it { should exist }
end

Parameters

option_group_name (required)

This resource accepts a single parameter, the user-supplied option_group_name. This parameter isn’t case-sensitive. This can be passed either as a string or as a option_group_name: 'value' key-value entry in a hash.

Properties

option_group_name

The name RDS option group.

option_group_description

The name of the database associated with each RDS cluster.

engine_name

The name of the engine associated with each RDS cluster.

major_engine_version

The major engine version of a option group.

option_group_arn

The arn of a option group.

vpc_id

The vpc id of option group.

allows_vpc_and_non_vpc_instance_memberships

The storage allocated to each cluster.

For a comprehensive list of properties available to test on an RDS option group see the AWS Response Object.

Examples

Test the engine used with an aws_rds_group_option.

describe aws_rds_group_option(option_group_name: 'mysql') do
  its('engine_name')         { should eq 'mysql' }
  its('major_engine_version') { should eq '5.6.37' }
end

Test the options to allocated to an aws_rds_group_option.

describe aws_rds_group_option(option_group_name: 'mysql') do
  its('options.option_name') { should eq 'test' }
  its('options.permanent') { should eq true }
end

Matchers

This resource has the following special matchers.

exist

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

Use should_not to test the entity should not exist.

describe aws_rds_group_option(option_group_name: 'mysql') do
  it { should exist }
end

describe aws_rds_group_option(option_group_name: 'mysql') do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the RDS:Client:OptionGroups action with Effect set to Allow.

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