aws_transit_gateway_connect Resource

[edit on GitHub]

Use the aws_transit_gateway_connect InSpec audit resource to test properties of a single AWS EC2 Transit Gateway Connect.

The AWS::EC2::TransitGatewayConnect 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 TransitGatewayConnect.

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 Connect attachment exists.

describe aws_transit_gateway_connect(transit_gateway_attachment_id: 'TRANSIT_GATEWAY_CONNECT_ATTACHMENT_ID') do
  it { should exits }
end

Parameters

transit_gateway_attachment_id (required)

The ID of the transit gateway Connect attachment.

Properties

transit_gateway_attachment_id

The ID of the Connect attachment.

transport_transit_gateway_attachment_id

The ID of the attachment from which the Connect attachment was created.

transit_gateway_id

The ID of the transit gateway.

state

The state of the attachment.

creation_time

The creation time.

options (protocol)

The Connect attachment options. The tunnel protocol.

tags

The tags for the attachment.

Examples

Ensure a transit gateway attachment ID is available.

describe aws_transit_gateway_connect(transit_gateway_attachment_id: 'TRANSIT_GATEWAY_CONNECT_ATTACHMENT_ID') do
  its('transit_gateway_attachment_id') { should eq 'tgw-attach-1234567890' }
end

Ensure that the state is available.

describe aws_transit_gateway_connect(transit_gateway_attachment_id: 'TRANSIT_GATEWAY_CONNECT_ATTACHMENT_ID') do
    its('state') { 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.

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_connect(transit_gateway_attachment_id: 'TRANSIT_GATEWAY_CONNECT_ATTACHMENT_ID') do
  it { should exits }
end

Use should_not to test the entity does not exist.

describe aws_transit_gateway_connect(transit_gateway_attachment_id: 'TRANSIT_GATEWAY_CONNECT_ATTACHMENT_ID') do
  it { should_not exits }
end

be_available

Use should to check if the entity is available.

describe aws_transit_gateway_connect(transit_gateway_attachment_id: 'dummy') do
  it { should be_available }
end

AWS Permissions

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