mirror of
https://github.com/inspec/inspec
synced 2024-12-18 09:03:12 +00:00
63 lines
1.8 KiB
Text
63 lines
1.8 KiB
Text
---
|
|
title: About the aws_route_table Resource
|
|
platform: aws
|
|
---
|
|
|
|
# aws\_route\_table
|
|
|
|
Use the `aws_route_table` InSpec audit resource to test properties of a single Route Table. A route table contains a set of rules, called routes, that are used to determine where network traffic is directed.
|
|
|
|
<br>
|
|
|
|
## Availability
|
|
|
|
### Installation
|
|
|
|
This resource is distributed along with InSpec itself. You can use it automatically.
|
|
|
|
### Version
|
|
|
|
This resource first became available in v2.0.16 of InSpec.
|
|
|
|
## Syntax
|
|
|
|
# Ensure that a certain route table exists by name
|
|
describe aws_route_table('rtb-123abcde') do
|
|
it { should exist }
|
|
end
|
|
|
|
## Resource Parameters
|
|
|
|
### route\_table\_id
|
|
|
|
This resource expects a single parameter that uniquely identifies the Route Table. You may pass it as a string, or as the value in a hash:
|
|
|
|
describe aws_route_table('rtb-123abcde') do
|
|
it { should exist }
|
|
end
|
|
# Same
|
|
describe aws_route_table(route_table_id: 'rtb-123abcde') do
|
|
it { should exist }
|
|
end
|
|
|
|
## Matchers
|
|
|
|
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
|
|
|
|
### exist
|
|
|
|
Indicates that the Route Table provided was found. Use `should_not` to test for Route Tables that should not exist.
|
|
|
|
describe aws_route_table('should-be-there') do
|
|
it { should exist }
|
|
end
|
|
|
|
describe aws_route_table('should-not-be-there') do
|
|
it { should_not exist }
|
|
end
|
|
|
|
## AWS Permissions
|
|
|
|
Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `ec2:DescribeRouteTables` action with Effect set to Allow.
|
|
|
|
You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html).
|