Metadata-Version: 2.1
Name: aws_tgw_details
Version: 1.0.3
Summary: Get AWS Transit Gateway details.
Home-page: https://gitlab.com/fer1035_python/modules/pypi-aws_tgw_details
License: GPL-2.0-only
Keywords: aws,transit,gateway,vpc,network
Author: Ahmad Ferdaus Abd Razak
Author-email: fer1035@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: aws_authenticator (>=2.0.2,<3.0.0)
Project-URL: Repository, https://gitlab.com/fer1035_python/modules/pypi-aws_tgw_details
Description-Content-Type: text/x-rst

===================
**aws_tgw_details**
===================

Overview
--------

Get AWS Transit Gateway details.

This module helps to retrieve AWS Transit Gateway details, including the following:

- Transit Gateways
- Transit Gateway Route Tables
- Transit Gateway Routes
- Transit Gateway Attachments
- Customer Gateways
- VPN Connections

The *aws_authenticator* module is installed with this module, and is used to login to AWS using IAM access key credentials from the following environment variables:

- TGW_AWS_ACCESS_KEY_ID
- TGW_AWS_SECRET_ACCESS_KEY
- TGW_AWS_SESSION_TOKEN (Optional. Default: *None*.)

If the environment variables are not set, the module will try to use the default AWS credentials from the AWS CLI configuration file.

Usage
------

- Installation:

.. code-block:: BASH

   pip3 install aws_tgw_details
   # or
   python3 -m pip install aws_tgw_details

- Set environment variables:

.. code-block:: BASH

   export TGW_AWS_ACCESS_KEY_ID=your_access_key_id
   export TGW_AWS_SECRET_ACCESS_KEY=your_secret_access_key
   export TGW_AWS_SESSION_TOKEN=your_session_token

- Examples:

.. code-block:: BASH

   # Overview.
   aws_tgws

   # Help.
   aws_tgws -h

   # Get all Transit Gateways.
   aws_tgws -t ALL

   # Get a specific Transit Gateway.
   aws_tgws -t tgw-1234567890abcdef0

   # Get all Customer Gateways.
   aws_tgws -c ALL

You can also use the available functions independently to create your own workflow instead of using the installed *aws_tgws* command line tool.

Boto3 Functions
---------------

- Main Documentation
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/export_transit_gateway_routes.html
- Transit Gateway
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/paginator/DescribeTransitGateways.html
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/paginator/DescribeTransitGatewayAttachments.html
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/paginator/DescribeTransitGatewayVpcAttachments.html
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/paginator/GetTransitGatewayRouteTableAssociations.html
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/paginator/DescribeTransitGatewayRouteTables.html
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/search_transit_gateway_routes.html
- Customer Gateway
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/describe_customer_gateways.html
- VPN
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/describe_vpn_connections.html
   - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/describe_vpn_gateways.html

