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

Note

This module is part of the amazon.aws collection (version 4.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws.

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

New in version 1.0.0: of amazon.aws

Synopsis

  • Manage route tables for AWS virtual private clouds

Requirements

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

  • python >= 3.6

  • boto3 >= 1.17.0

  • botocore >= 1.20.0

Parameters

Parameter

Comments

aws_access_key

aliases: ec2_access_key, 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.

The aws_access_key and profile options are mutually exclusive.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

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.

Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

aws_secret_key

aliases: ec2_secret_key, 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.

The aws_secret_key and profile options are mutually exclusive.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • no ← (default)

  • yes

ec2_url

aliases: aws_endpoint_url, endpoint_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.

gateway_id

string

added in 3.2.0 of amazon.aws

The ID of the gateway to associate with the route table.

If gateway_id is 'None' or '', gateway will be disassociated with the route table.

lookup

string

Look up route table by either tags or by route_table_id.

If lookup=tag and tags is not specified then no lookup for an existing route table is performed and a new route table will be created.

When using lookup=tag, multiple matches being found will result in a failure and no changes will be made.

To change the tags of a route table use lookup=id.

vpc_id must be specified when lookup=tag.

Choices:

  • tag ← (default)

  • id

profile

aliases: aws_profile

string

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

propagating_vgw_ids

list / elements=string

Enable route propagation from virtual gateways specified by ID.

purge_routes

boolean

Purge existing routes that are not found in routes.

Choices:

  • no

  • yes ← (default)

purge_subnets

boolean

Purge existing subnets that are not found in subnets. Ignored unless the subnets option is supplied.

Choices:

  • no

  • yes ← (default)

purge_tags

boolean

If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.

If the tags parameter is not set then tags will not be modified, even if purge_tags=True.

Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

The current default value of False has been deprecated. The default value will change to True in release 5.0.0.

Choices:

  • no

  • yes

region

aliases: aws_region, ec2_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

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.

The value of dest is used for the destination match. It may be a IPv4 CIDR block or a IPv6 CIDR block.

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

aliases: aws_session_token, session_token, aws_security_token, access_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.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token have been added in version 3.2.0.

state

string

Create or destroy the VPC route table.

Choices:

  • present ← (default)

  • absent

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’ or ‘fd00::/8’.

tags

aliases: resource_tags

dictionary

A dictionary representing the tags to be applied to the resource.

If the tags parameter is not set then tags will not be modified.

validate_certs

boolean

When set to “no”, SSL certificates will not be validated for communication with the AWS APIs.

Choices:

  • no

  • yes ← (default)

vpc_id

string

VPC ID of the VPC in which to create the route table.

Required when state=present or lookup=tag.

Notes

Note

  • Tags are used to uniquely identify route tables within a VPC when the route_table_id is not supplied.

  • 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

  • When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

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
  amazon.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 }}"
      - dest: ::/0
        gateway_id: "{{ igw.gateway_id }}"
  register: public_route_table

- name: Create vpc gateway
  amazon.aws.ec2_vpc_igw:
    vpc_id: vpc-1245678
  register: vpc_igw

- name: Create gateway route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    tags:
      Name: Gateway route table
    gateway_id: "{{ vpc_igw.gateway_id }}"
  register: gateway_route_table

- name: Disassociate gateway from route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    tags:
      Name: Gateway route table
    gateway_id: None
  register: gateway_route_table

- name: Set up NAT-protected route table
  amazon.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
  amazon.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

Description

route_table

complex

Route Table result.

Returned: always

associations

complex

List of associations between the route table and one or more subnets or a gateway.

Returned: always

association_state

complex

The state of the association.

Returned: always

state

string

The state of the association.

Returned: always

Sample: “associated”

state_message

string

Additional information about the state of the association.

Returned: when available

Sample: “Creating association”

gateway_id

string

ID of the internet gateway or virtual private gateway.

Returned: when route table is a gateway route table

Sample: “igw-03312309”

main

boolean

Whether this is the main route table.

Returned: always

Sample: false

route_table_association_id

string

ID of association between route table and subnet.

Returned: always

Sample: “rtbassoc-ab47cfc3”

route_table_id

string

ID of the route table.

Returned: always

Sample: “rtb-bf779ed7”

subnet_id

string

ID of the subnet.

Returned: when route table is a subnet route table

Sample: “subnet-82055af9”

id

string

ID of the route table (same as route_table_id for backwards compatibility).

Returned: always

Sample: “rtb-bf779ed7”

propagating_vgws

list / elements=string

List of Virtual Private Gateways propagating routes.

Returned: always

Sample: []

route_table_id

string

ID of the route table.

Returned: always

Sample: “rtb-bf779ed7”

routes

complex

List of routes in the route table.

Returned: always

destination_cidr_block

string

IPv4 CIDR block of destination

Returned: always

Sample: “10.228.228.0/22”

destination_ipv6_cidr_block

string

IPv6 CIDR block of destination

Returned: when the route includes an IPv6 destination

Sample: “2600:1f1c:1b3:8f00:8000::/65”

gateway_id

string

ID of the gateway.

Returned: when gateway is local or internet gateway

Sample: “local”

instance_id

string

ID of a NAT instance.

Returned: when the route is via an EC2 instance

Sample: “i-abcd123456789”

instance_owner_id

string

AWS account owning the NAT instance.

Returned: when the route is via an EC2 instance

Sample: 123456789012

nat_gateway_id

string

ID of the NAT gateway.

Returned: when the route is via a NAT gateway

Sample: “local”

origin

string

mechanism through which the route is in the table.

Returned: always

Sample: “CreateRouteTable”

state

string

state of the route.

Returned: always

Sample: “active”

tags

dictionary

Tags applied to the route table.

Returned: always

Sample: {“Name”: “Public route table”, “Public”: “true”}

vpc_id

string

ID for the VPC in which the route lives.

Returned: always

Sample: “vpc-6e2d2407”

Authors

  • Robert Estelle (@erydo)

  • Rob White (@wimnat)

  • Will Thames (@willthames)