aws_dms_replication_instances Resource

[edit on GitHub]

Use the aws_dms_replication_instances InSpec audit resource to test properties of multiple AWS DMS replication instances.

The AWS::DMS::ReplicationInstance resource creates an AWS DMS replication instance.

For additional information, including details on parameters and properties, see the AWS documentation on DMS Replication Instance.

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 a replication instance exists.

describe aws_dms_replication_instances do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

engine_versions

The engine versions of the replication instance.

replication_instance_classes

The compute and memory capacity of the replication instance as defined for the specified replication instance class.

storage_types

The storage types of the replication instance.

min_allocated_storages

The min allocated storages of the replication instance.

max_allocated_storages

The max allocated storages of the replication instance.

default_allocated_storages

The default allocated storages of the replication instance in gigabytes.

included_allocated_storages

The included allocated storages of the replication instance in gigabytes.

availability_zones

The availability zones of the replication instance.

release_statuses

The release statuses of the replication instance.

Examples

Ensure an engine version is available.

describe aws_dms_replication_instances do
  its('engine_versions') { should include '3.4.4' }
end

Ensure that the classes are available.

describe aws_dms_replication_instances do
    its('replication_instance_classes') { should include 'dms.c4.2xlarge' }
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 describe method returns at least one result.

exist

Use should to test that the entity exists.

describe aws_dms_replication_instances do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_dms_replication_instances do
  it { should_not exist }
end

be_available

Use should to check if the work group name is available.

describe aws_dms_replication_instances do
  it { should be_available }
end

AWS Permissions

Your Principal will need the DatabaseMigrationService:Client:DescribeOrderableReplicationInstancesResponse action with Effect set to Allow.