aws_mq_configurations Resource

[edit on GitHub]

Use the aws_mq_configurations InSpec audit resource to test the properties of multiple AWS MQ configuration.

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 that AWS MQ configuration exists.

describe aws_mq_configurations do
  it { should exist }
end

For additional information, see the AWS documentation on AWS MQ configuration.

Parameters

This resource does not require any parameters.

Properties

arns

The ARN of the configuration.

Field: arn

authentication_strategies

The authentication strategy associated with the configuration. The default is SIMPLE.

Field: authentication_strategy

Created

The date and time of the configuration revision.

Field: Created

description

The description of the configuration.

Field: description

engine_types

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

Field: engine_type

engine_versions

The broker engine’s version. For a list of supported engine versions.

Field: engine_version

ids

The unique ID that Amazon MQ generates for the configuration.

Field: id

names

The name of the configuration.

Field: name

tags

The list of all tags associated with this configuration.

Field: tags

Examples

Ensure a configuration ID is available.

describe aws_mq_configurations do
  its('ids') { should include 'configuration_id' }
end

Ensure a configuration name is available.

describe aws_mq_configurations do
    its('names') { should include 'configuration_name' }
end

Matchers

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

The controls will pass if the list method returns at least one result.

exist

Use should to test that the entity exists.

describe aws_mq_configurations do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_mq_configurations do
  it { should_not exist }
end

be_available

Use should to check if the mq configuration is available.

describe aws_mq_configurations do
  it { should be_available }
end

AWS Permissions

Your Principal will need the MQ:Client:ListConfigurationsResponsegit action with Effect set to Allow.