aws_transit_gateway_multicast

Use the aws_transit_gateway_multicast_domains Chef InSpec audit resource to test properties of multiple AWS EC2 transit gateway multicast domains.

The AWS::EC2::TransitGatewayMulticastDomain resource creates a Connect attachment from a specified transit gateway attachment.

For additional information, including details on parameters and properties, see the AWS documentation on AWS EC2 TransitGatewayMulticastDomain.

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 transit gateway multicast domain exists.

describe aws_transit_gateway_multicast_domains do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

transit_gateway_multicast_domain_ids: The ID of the transit gateway multicast domain.
transit_gateway_ids: The ID of the transit gateway.
transit_gateway_multicast_domain_arns: The Amazon Resource Name (ARN) of the transit gateway multicast domain.
owner_ids: The ID of the AWS account that owns the transit gateway multicast domain.
options: The options for the transit gateway multicast domain.
states: The state of the transit gateway multicast domain.
creation_time: The time the transit gateway multicast domain was created.
tags: The tags for the transit gateway multicast domain.

Examples

Ensure a specific transit gateway attachment ID is available.

describe aws_transit_gateway_multicast_domains do
  its('transit_gateway_multicast_domain_ids') { should include 'TRANSIT_GATEWAY_MULTICAST_DOMAIN_ID' }
end

Ensure that the state is available.

describe aws_transit_gateway_multicast_domains do
  its('states') { should include '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.

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

exist

Use should to test that the entity exists.

describe aws_transit_gateway_multicast_domains do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_transit_gateway_multicast_domains do
  it { should_not exist }
end

be_available

Use should to check if the entity is available.

describe aws_transit_gateway_multicast_domains do
  it { should be_available }
end

AWS Permissions

Your Principal will need the EC2:Client:DescribeTransitGatewayMulticastDomainsResult action with Effect set to Allow.

aws_transit_gateway_multicast_domains Resource