Skip to main content

aws_redshift_cluster Resource

[edit on GitHub]

Use the aws_redshift_cluster InSpec audit resource to test detailed properties of an individual AWS Redshift cluster.

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

An aws_redshift_cluster resource block uses resource parameters to search for a Redshift cluster, and then tests that Redshift cluster. If no Redshift clusters match, no error is raised, but the exists matcher will return false and all properties will be nil. If more than one Redshift cluster matches (due to vague search parameters), an error is raised.

describe aws_redshift_cluster('test-cluster-id') do
  it { should exist }
end

# Can also use hash syntax

describe aws_redshift_cluster(cluster_identifier: 'test-cluster-id') do
  it { should exist }
end

Parameters

cluster_identifier (required)

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

Also see the AWS Redshift cluster documentation.

Properties

cluster_identifier
The unique IDs of the redshift clusters returned.
db_names
The name of the database associated with each redshift cluster.
node_type
The redshift instance type.
cluster_create_time
The create time of redshift clusters.
cluster_subnet_group_name
The cluster name of redshift clusters.
cluster_status
The current status of each cluster .
cluster_availability_status
The current status of cluster.
modify_status
The current status of cluster.
availability_zones
A list of availability zones of the redshift clusters returned.
allow_version_upgrade
Returns T/F depending on whether version upgrade is allowed or not.
encrypted
Returns T/F depending on whether Redshift clusters are encrypted or not.
cluster_subnet_group_name
Cluster subnet group name for redshift clusters returned.
iam_roles
iam_roles that are used in the cluster.
vpc_id
vpc_id of the redshift clusters.

Examples

For a comprehensive list of properties available to test on an Redshift cluster see the AWS Response Object.

Examples

Test the engine used with a Redshift cluster

describe aws_redshift_cluster(cluster_identifier: 'awsRedshift123') do
  its('engine')         { should eq 'mysql' }
  its('engine_version') { should eq '5.6.37' }
end

Test the encryption and version_upgrade attribute of the Redshift cluster

describe aws_redshift_cluster(cluster_identifier: 'awsRedshift123') do
  its('encrypted') { should eq true }
  its('allow_version_upgrade') { should eq true }
end

Test the cluster status and master username

describe aws_redshift_cluster(cluster_identifier: 'awsRedshift123') do
  its('master_username') { should eq 'db-maintain' }
  its('cluster_status') { should eq 'available' }
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_redshift_cluster(cluster_identifier: 'AnExistingRedshift') do
  it { should exist }
end

describe aws_redshift_cluster(cluster_identifier: 'ANonExistentRedshift') do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the Redshift:Client:ClustersMessage action with Effect set to Allow.

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

Was this page helpful?

×









Search Results