aws_ec2_transit_gateway_attachments Resource

[edit on GitHub]

Use the aws_ec2_transit_gateway_attachments InSpec audit resource to test properties of some or all AWS Transit Gateway attachments.

This resource does not expect any parameters.

For additional information, including details on parameters and properties, see the AWS documentation on Transit Gateway attachment.

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

Verify that a Transit Gateway attachment ID exists.

describe aws_ec2_transit_gateway_attachment(transit_gateway_attachment_id:'tgw-attach-006f2fd0a03d51323') do
  it { should exist }
end

An aws_ec2_transit_gateway_attachments resource block uses an optional filter to select a group of Elastic IPs and then test that group.

Parameters

This resource does not require any parameters.

Properties

transit_gateway_attachment_ids

The IDs of the attachments.

transit_gateway_ids

The ID of the Transit Gateway.

transit_gateway_owner_ids

The ID of the AWS account that owns the Transit Gateway.

resource_owner_ids

The ID of the AWS account that owns the resource.

resource_types

The resource type. Valid values are: vpc, vpn, direct-connect-gateway, peering, and connect.

resource_ids

The ID of the resource.

states

The state of the attachment. Valid values are: available, deleted, deleting, failed, failing, initiatingRequest, modifying, pendingAcceptance, pending, rollingBack, rejected, and rejecting.

associations (transit_gateway_route_table_id)

The ID of the route table for the Transit Gateway.

associations (state)

The state of the attachment. Valid values are associating, associated, disassociating, and disassociated.

creation_times

The creation time of the Transit Gateway.

tags

The tags of the attachments.

Examples

Ensure a Transit Gateway attachment has transit_gateway_attachment_ids.

describe aws_ec2_transit_gateway_attachments do
  it { should exist }
end

Match count of Transit Gateway attachment.

describe aws_ec2_transit_gateway_attachments do
    its('count') { should eq 5 }
end

Check State whether it is correct or not.

describe aws_ec2_transit_gateway_attachments 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.

exist

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

Use should to test the entity exist.

describe aws_ec2_transit_gateway_attachments do
  it { should exist }
end

Use should_not to test the entity should not exist.

describe aws_ec2_transit_gateway_attachments do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the ec2:DescribeVpcEndpoints action with Effect set to Allow.

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