community.aws.ec2_vpc_route_table – Manage route tables for AWS virtual private clouds

Note

This plugin is part of the community.aws collection.

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.ec2_vpc_route_table.

New in version 1.0.0: of community.aws

Synopsis

  • Manage route tables for AWS virtual private clouds

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • boto

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
ec2_url
string
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
lookup
string
    Choices:
  • tag ←
  • id
Look up route table by either tags or by route table ID. Non-unique tag lookup will fail. If no tags are specified then no lookup for an existing route table is performed and a new route table will be created. To change tags of a route table you must look up by id.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
propagating_vgw_ids
list / elements=string
Enable route propagation from virtual gateways specified by ID.
purge_routes
boolean
    Choices:
  • no
  • yes ←
Purge existing routes that are not found in routes.
purge_subnets
boolean
    Choices:
  • no
  • yes
Default:
"true"
Purge existing subnets that are not found in subnets. Ignored unless the subnets option is supplied.
purge_tags
boolean
    Choices:
  • no ←
  • yes
Purge existing tags that are not found in route table.
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
route_table_id
string
The ID of the route table to update or delete.
Required when lookup=id.
routes
list / elements=dictionary
List of routes in the route table. Routes are specified as dicts containing the keys 'dest' and one of 'gateway_id', 'instance_id', 'network_interface_id', or 'vpc_peering_connection_id'. If 'gateway_id' is specified, you can refer to the VPC's IGW by using the value 'igw'. Routes are required for present states.
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
state
string
    Choices:
  • present ←
  • absent
Create or destroy the VPC route table.
subnets
list / elements=string
An array of subnets to add to this route table. Subnets may be specified by either subnet ID, Name tag, or by a CIDR such as '10.0.0.0/24'.
tags
dictionary
A dictionary of resource tags of the form: { tag1: value1, tag2: value2 }. Tags are used to uniquely identify route tables within a VPC when the route_table_id is not supplied.

aliases: resource_tags
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpc_id
string
VPC ID of the VPC in which to create the route table.
Required when state=present or lookup=tag.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE

  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Basic creation example:
- name: Set up public subnet route table
  community.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    region: us-west-1
    tags:
      Name: Public
    subnets:
      - "{{ jumpbox_subnet.subnet.id }}"
      - "{{ frontend_subnet.subnet.id }}"
      - "{{ vpn_subnet.subnet_id }}"
    routes:
      - dest: 0.0.0.0/0
        gateway_id: "{{ igw.gateway_id }}"
  register: public_route_table

- name: Set up NAT-protected route table
  community.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    region: us-west-1
    tags:
      Name: Internal
    subnets:
      - "{{ application_subnet.subnet.id }}"
      - 'Database Subnet'
      - '10.0.0.0/8'
    routes:
      - dest: 0.0.0.0/0
        instance_id: "{{ nat.instance_id }}"
  register: nat_route_table

- name: delete route table
  community.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    region: us-west-1
    route_table_id: "{{ route_table.id }}"
    lookup: id
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
route_table
complex
always
Route Table result

 
associations
complex
always
List of subnets associated with the route table

   
main
boolean
always
Whether this is the main route table

   
route_table_association_id
string
always
ID of association between route table and subnet

Sample:
rtbassoc-ab47cfc3
   
route_table_id
string
always
ID of the route table

Sample:
rtb-bf779ed7
   
subnet_id
string
always
ID of the subnet

Sample:
subnet-82055af9
 
id
string
always
ID of the route table (same as route_table_id for backwards compatibility)

Sample:
rtb-bf779ed7
 
propagating_vgws
list / elements=string
always
List of Virtual Private Gateways propagating routes

 
route_table_id
string
always
ID of the route table

Sample:
rtb-bf779ed7
 
routes
complex
always
List of routes in the route table

   
destination_cidr_block
string
always
CIDR block of destination

Sample:
10.228.228.0/22
   
gateway_id
string
when gateway is local or internet gateway
ID of the gateway

Sample:
local
   
instance_id
string
when the route is via an EC2 instance
ID of a NAT instance

Sample:
i-abcd123456789
   
instance_owner_id
string
when the route is via an EC2 instance
AWS account owning the NAT instance

Sample:
123456789012
   
nat_gateway_id
string
when the route is via a NAT gateway
ID of the NAT gateway

Sample:
local
   
origin
string
always
mechanism through which the route is in the table

Sample:
CreateRouteTable
   
state
string
always
state of the route

Sample:
active
 
tags
dictionary
always
Tags applied to the route table

Sample:
{'Name': 'Public route table', 'Public': 'true'}
 
vpc_id
string
always
ID for the VPC in which the route lives

Sample:
vpc-6e2d2407


Authors

  • Robert Estelle (@erydo)

  • Rob White (@wimnat)

  • Will Thames (@willthames)