ec2_transit_gateway – Create and delete AWS Transit Gateways¶

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Creates AWS Transit Gateways
Deletes AWS Transit Gateways
Updates tags on existing transit gateways

Requirements ¶

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

boto
boto3
botocore
python >= 2.6

Parameters ¶

Parameter	Choices/Defaults	Comments
asn -		A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
auto_associate boolean	Choices: no yes ←	Enable or disable automatic association with the default association route table.
auto_attach boolean	Choices: no ← yes	Enable or disable automatic acceptance of attachment requests.
auto_propagate boolean	Choices: no yes ←	Enable or disable automatic propagation of routes to the default propagation route table.
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. aliases: ec2_access_key, access_key
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. aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs boolean added in 2.8	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.
description string		The description of the transit gateway.
dns_support boolean	Choices: no yes ←	Whether to enable AWS DNS support.
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.
profile string		Uses a boto profile. Only works with boto >= 2.24.0.
purge_tags boolean	Choices: no yes ←	Whether to purge existing tags not included with tags argument.
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 aliases: aws_region, ec2_region
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. aliases: access_token
state -	Choices: present ← absent	present to ensure resource is created. absent to remove resource.
tags -		A dictionary of resource tags
transit_gateway_id string		The ID of the transit gateway.
validate_certs boolean	Choices: no yes ←	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpn_ecmp_support boolean	Choices: no yes ←	Enable or disable Equal Cost Multipath Protocol support.
wait -	Default: "yes"	Whether to wait for status
wait_timeout -	Default: 300	number of seconds to wait for status

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_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
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 ¶

- name: Create a new transit gateway using defaults
  ec2_transit_gateway:
    state: present
    region: us-east-1
    description: personal-testing
  register: created_tgw

- name: Create a new transit gateway with options
  ec2_transit_gateway:
    asn: 64514
    auto_associate: no
    auto_propagate: no
    dns_support: True
    description: "nonprod transit gateway"
    purge_tags: False
    state: present
    region: us-east-1
    tags:
      Name: nonprod transit gateway
      status: testing

- name: Remove a transit gateway by description
  ec2_transit_gateway:
    state: absent
    region: us-east-1
    description: personal-testing

- name: Remove a transit gateway by id
  ec2_transit_gateway:
    state: absent
    region: ap-southeast-2
    transit_gateway_id: tgw-3a9aa123
  register: deleted_tgw

Return Values ¶

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

Key			Returned	Description
transit_gateway complex			state=present	The attributes of the transit gateway.
	creation_time string		always	The creation time of the transit gateway. Sample: 2019-03-06T17:13:51+00:00
	description string		always	The description of the transit gateway. Sample: my test tgw
	options complex		always	The options attributes of the transit gateway
		amazon_side_asn string	always	A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Sample: 64512
		association_default_route_table_id string	Iwhen exists	The ID of the default association route table. Sample: tgw-rtb-abc123444
		auto_accept_shared_attachements string	always	Indicates whether attachment requests are automatically accepted. Sample: disable
		default_route_table_association string	always	Indicates whether resource attachments are automatically associated with the default association route table. Sample: enable
		default_route_table_propagation string	always	Indicates whether resource attachments automatically propagate routes to the default propagation route table. Sample: disable
		dns_support string	always	Indicates whether DNS support is enabled. Sample: enable
		propagation_default_route_table_id string	when exists	The ID of the default propagation route table. Sample: tgw-rtb-def456777
		vpn_ecmp_support string	always	Indicates whether Equal Cost Multipath Protocol support is enabled. Sample: enable
	owner_id string		always	The account that owns the transit gateway. Sample: 123456789012
	state string		always	The state of the transit gateway. Sample: pending
	tags dictionary		always	A dictionary of resource tags Sample: {'tags': {'Name': 'nonprod_tgw'}}
	transit_gateway_arn string		always	The ID of the transit_gateway. Sample: tgw-3a9aa123
	transit_gateway_id string		always	The ID of the transit_gateway. Sample: tgw-3a9aa123

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Bob Boldin (@BobBoldin)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

ec2_transit_gateway – Create and delete AWS Transit Gateways¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶