community.aws.ec2_transit_gateway – Create and delete AWS Transit Gateways

Note

This plugin is part of the community.aws collection (version 1.5.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 community.aws.

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

New in version 1.0.0: of community.aws

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
integer
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.
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.
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.

aliases: aws_endpoint_url, endpoint_url
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
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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

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.
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
present to ensure resource is created.
absent to remove resource.
tags
dictionary
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
boolean
    Choices:
  • no
  • yes
Whether to wait for status
wait_timeout
integer
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_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

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

- name: Create a new transit gateway with options
  community.aws.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
  community.aws.ec2_transit_gateway:
    state: absent
    region: us-east-1
    description: personal-testing

- name: Remove a transit gateway by id
  community.aws.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


Authors

  • Bob Boldin (@BobBoldin)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/ec2_transit_gateway_module.html