aws_ec2_transit_gateway_route_table_associations Resource
Use the aws_ec2_transit_gateway_route_table_associations
InSpec audit resource to test properties of some or all AWS transit gateway route table associations.
An AWS transit gateway route table association associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
Install
This resource is available in the Chef InSpec AWS resource pack.
For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the Chef InSpec documentation on the AWS cloud platform.
Syntax
Verify whether a transit gateway route table ID exists.
describe aws_ec2_transit_gateway_route_table_associations(transit_gateway_route_table_id: 'TRANSIT_GATEWAY_ROUTE_TABLE_ID') do
it { should exist }
end
Parameters
transit_gateway_route_table_id
(required)For addition information, check out the AWS documentation on transit gateway route table.
Properties
transit_gateway_route_table_ids
- The ID of the transit gateway route table.
resource_types
- The resource type. Valid values are:
vpc
,vpn
,direct-connect-gateway
,peering
, andconnect
. resource_ids
- The ID of the resource.
states
- The possible states of the route table are:
available
,deleting
,deleted
, andpending
.
Examples
Ensure a transit gateway route table exists.
describe aws_ec2_transit_gateway_route_table_associations(transit_gateway_route_table_id: 'TRANSIT_GATEWAY_ROUTE_TABLE_ID') do
it { should exist }
end
Match count of transit gateway route table.
describe aws_ec2_transit_gateway_route_table_associations(transit_gateway_route_table_id: 'TRANSIT_GATEWAY_ROUTE_TABLE_ID') do
its('count') { should eq 5 }
end
Check the state of the route table.
describe aws_ec2_transit_gateway_route_table_associations(transit_gateway_route_table_id: 'TRANSIT_GATEWAY_ROUTE_TABLE_ID') do
its('states') { should include "available" }
end
Matchers
This InSpec audit resource has the following special matchers. For the complete list of available matchers, visit Universal Matchers page.
exist
The control will pass if the describe
returns at least one result.
Use should
to test whether the entity exists.
describe aws_ec2_transit_gateway_route_table_associations(transit_gateway_route_table_id: 'TRANSIT_GATEWAY_ROUTE_TABLE_ID') do
it { should exist }
end
Use should_not
to test an entity that should not exist.
describe aws_ec2_transit_gateway_route_table_associations(transit_gateway_route_table_id: 'TRANSIT_GATEWAY_ROUTE_TABLE_ID') do
it { should_not exist }
end
AWS Permissions
Your Principal will need the EC2:Client:GetTransitGatewayRouteTableAssociationsResult
action with Effect
set to Allow
.
For addition information, check out the Actions, Resources, and Condition Keys for Amazon EC2 documentation.