ansible / ansible.builtin / v2.9.0 / module / ec2_vpc_route_table Manage route tables for AWS virtual private clouds | "added in version" 2.0 of ansible.builtin" Authors: Robert Estelle (@erydo), Rob White (@wimnat), Will Thames (@willthames) stableinterface | supported by communityansible.builtin.ec2_vpc_route_table (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Manage route tables for AWS virtual private clouds
# Note: These examples do not set authentication details, see the AWS Guide for details. # Basic creation example: - name: Set up public subnet route table 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 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 ec2_vpc_route_table: vpc_id: vpc-1245678 region: us-west-1 route_table_id: "{{ route_table.id }}" lookup: id state: absent
tags: aliases: - resource_tags description: '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. ' state: choices: - present - absent default: present description: Create or destroy the VPC route table lookup: choices: - tag - id default: tag description: 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. region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str routes: description: 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. vpc_id: description: VPC ID of the VPC in which to create the route table. required: true ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str subnets: description: 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'. aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict purge_tags: default: 'no' description: Purge existing tags that are not found in route table type: bool version_added: '2.5' version_added_collection: ansible.builtin purge_routes: default: 'yes' description: Purge existing routes that are not found in routes. type: bool version_added: '2.3' version_added_collection: ansible.builtin aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path purge_subnets: default: 'true' description: Purge existing subnets that are not found in subnets. Ignored unless the subnets option is supplied. type: bool version_added: '2.3' version_added_collection: ansible.builtin aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str route_table_id: description: The ID of the route table to update or delete. security_token: aliases: - aws_session_token - session_token - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool propagating_vgw_ids: description: Enable route propagation from virtual gateways specified by ID. debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
route_table: contains: associations: contains: main: description: Whether this is the main route table returned: always sample: false type: bool route_table_association_id: description: ID of association between route table and subnet returned: always sample: rtbassoc-ab47cfc3 type: str route_table_id: description: ID of the route table returned: always sample: rtb-bf779ed7 type: str subnet_id: description: ID of the subnet returned: always sample: subnet-82055af9 type: str description: List of subnets associated with the route table returned: always type: complex id: description: ID of the route table (same as route_table_id for backwards compatibility) returned: always sample: rtb-bf779ed7 type: str propagating_vgws: description: List of Virtual Private Gateways propagating routes returned: always sample: [] type: list route_table_id: description: ID of the route table returned: always sample: rtb-bf779ed7 type: str routes: contains: destination_cidr_block: description: CIDR block of destination returned: always sample: 10.228.228.0/22 type: str gateway_id: description: ID of the gateway returned: when gateway is local or internet gateway sample: local type: str instance_id: description: ID of a NAT instance returned: when the route is via an EC2 instance sample: i-abcd123456789 type: str instance_owner_id: description: AWS account owning the NAT instance returned: when the route is via an EC2 instance sample: 123456789012 type: str nat_gateway_id: description: ID of the NAT gateway returned: when the route is via a NAT gateway sample: local type: str origin: description: mechanism through which the route is in the table returned: always sample: CreateRouteTable type: str state: description: state of the route returned: always sample: active type: str description: List of routes in the route table returned: always type: complex tags: description: Tags applied to the route table returned: always sample: Name: Public route table Public: 'true' type: dict vpc_id: description: ID for the VPC in which the route lives returned: always sample: vpc-6e2d2407 type: str description: Route Table result returned: always type: complex