aws_rds_snapshots Resource

[edit on GitHub]

Use the aws_rds_snapshots InSpec audit resource to test the properties of a collection of AWS RDS snapshots.

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 three snapshots.

describe aws_rds_snapshots do
  its('db_snapshot_identifiers.count') { should cmp 3 }
end

Parameters

This resource does not require any parameters.

Properties

db_snapshot_identifiers

The unique IDs of the RDS snapshots returned.

entries

Provides access to the raw results of the query, which can be treated as an array of hashes.

Examples

Ensure a specific snapshot exists.

describe aws_rds_snapshots do
  its('db_snapshot_identifiers') { should include 'RDS-12345678' }
end

Requests the IDs of RDS snapshots and ensures the snapshots are encrypted with sensible size.

aws_rds_snapshots.db_snapshot_identifiers.each do |db_snapshot_identifier|
  describe aws_rds_snapshot(db_snapshot_identifier) do
    it { should be_encrypted }
  end
end

Tests the snapshot using cached resource_data.

aws_rds_snapshots.entries.each do |AWS_RDS_SNAPSHOT|
    describe aws_rds_snapshot(resource_data: AWS_RDS_SNAPSHOT) do
        its ('engine')         { should eq 'MYSQL' }
        its ('engine_version') { should eq '5.6.37' }
    end
end

Loop through all RDS snapshots and test each snapshot with singular resource.

This method uses local in-memory caching to test each snapshot for quicker execution of large sets of test cases.

aws_rds_snapshots.entries.each do |AWS_RDS_SNAPSHOT|
    describe aws_rds_snapshot(resource_data: AWS_RDS_SNAPSHOT) do
        it { should exist }
        it { should have_encrypted_snapshot }
    end
end

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

describe aws_rds_snapshots do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the RDS:Client:DBSnapshotMessage 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.