aws_rds_clusters Resource

[edit on GitHub]

Use the aws_rds_clusters InSpec audit resource to test properties of a collection of AWS RDS clusters.

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

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 you have exactly 3 clusters

describe aws_rds_clusters do
  its('db_cluster_identifiers.count') { should cmp 3 }
end

Parameters

This resource does not require any parameters.

Properties

cluster_identifier

The unique IDs of the RDS clusters returned.

database_name

The name of the database associated with each RDS cluster.

cluster_\members

The RDS instances attached to each RDS cluster.

engine

The name of the database engine used by each cluster.

engine_version

The version of the database engine used by each cluster.

status

The current status of each cluster.

allocated_storage

The storage allocated to each cluster.

storage_encrypted

Returns T/F whether the cluster is encrypted or not.

availability_zones

A list of availability zones of the RDS clusters returned.

multi_az

Returns T/F depending on whether multiple availability zones are used in the cluster.

arn

The unique Amazon resource name of the RDS clusters.

Examples

Ensure a specific cluster exists.

describe aws_rds_clusters do
  its('db_cluster_identifier') { should include ['cluster-12345678', 'cluster-456786786'] }
end

Request the IDs of all RDS clusters, then test in-depth using aws_rds_cluster to ensure all clusters are encrypted and have a sensible size.

aws_rds_clusters.cluster_identifier.each do |cluster_identifier|
    describe aws_rds_cluster(cluster_identifier) do
      it { should have_encrypted_storage }
  end
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

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_clusters do
  it { should exist }
end

describe aws_rds_clusters do
  it { should_not exist }
end

AWS Permissions

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

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