community.aws.ec2_transit_gateway_info module – Retrieve information about EC2 Transit Gateways in AWS
+community.aws.ec2_transit_gateway_info module
Note
-This module is part of the community.aws collection (version 9.0.0-dev0).
-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.
-You need further requirements to be able to use this module,
-see Requirements for details.
This redirect is part of the community.aws collection (version 9.0.0-dev0).
To use it in a playbook, specify: community.aws.ec2_transit_gateway_info.
New in community.aws 1.0.0
- -Synopsis
--
-
Gather information about EC2 Transit Gateways in AWS.
-
Requirements
-The below requirements are needed on the host that executes this module.
-
-
python >= 3.6
-boto3 >= 1.28.0
-botocore >= 1.31.0
+This is a redirect to the amazon.aws.ec2_transit_gateway_info module.
+This redirect does not work with Ansible 2.9.
Parameters
-Parameter |
-Comments |
-
|---|---|
| - | AWS access key ID. -See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. -The The aws_access_key and profile options are mutually exclusive. -The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. -The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. -Support for the |
-
| - | The location of a CA Bundle to use when validating SSL certificates. -The |
-
| - | A dictionary to modify the botocore configuration. -Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. - |
-
| - | Use a The Choices: -
|
-
| - | URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. -The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. -Support for the |
-
| - | A dictionary of filters to apply to the query. Each key-value pair represents a filter key and its corresponding value. -For a complete list of available filters, refer to the AWS documentation https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html. -Default: |
-
| - | A named AWS profile to use for authentication. -See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. -The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. - |
-
| - | The AWS region to use. -For global services such as IAM, Route53 and CloudFront, region is ignored. -The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. -The Support for the |
-
| - | AWS secret access key. -See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. -The The secret_key and profile options are mutually exclusive. -The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. -The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. -Support for the |
-
| - | AWS STS session token for use with temporary credentials. -See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. -The The security_token and profile options are mutually exclusive. -Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. -The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. -Support for the |
-
| - | A list of Transit Gateway IDs for which to gather information. -Default: |
-
| - | When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. -Choices: -
|
-
Notes
-Note
--
-
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
-The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
-
Examples
-# Note: These examples do not set authentication details, see the AWS Guide for details.
-
-- name: Gather info about all transit gateways
- community.aws.ec2_transit_gateway_info:
-
-- name: Gather info about a particular transit gateway using filter transit gateway ID
- community.aws.ec2_transit_gateway_info:
- filters:
- transit-gateway-id: tgw-02c42332e6b7da829
-
-- name: Gather info about a particular transit gateway using multiple option filters
- community.aws.ec2_transit_gateway_info:
- filters:
- options.dns-support: enable
- options.vpn-ecmp-support: enable
-
-- name: Gather info about multiple transit gateways using module param
- community.aws.ec2_transit_gateway_info:
- transit_gateway_ids:
- - tgw-02c42332e6b7da829
- - tgw-03c53443d5a8cb716
-Return Values
-Common return values are documented here, the following are the fields unique to this module:
-Key |
-Description |
-
|---|---|
| - | Transit gateways that match the provided filters. -Each element consists of a dict with all the information related to that transit gateway. -Returned: on success - |
-
| - | The creation time. -Returned: always -Sample: |
-
| - | The description of the transit gateway. -Returned: always -Sample: |
-
| - | A dictionary of the transit gateway options. -Returned: always - |
-
| - | A private Autonomous System Number (ASN) for the Amazon ide of a BGP session. -The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. -Returned: always -Sample: |
-
| - | The ID of the default association route table. -Returned: when present -Sample: |
-
| - | Indicates whether attachment requests are automatically accepted. -Returned: always -Sample: |
-
| - | Indicates whether resource attachments are automatically associated with the default association route table. -Returned: always -Sample: |
-
| - | Indicates whether resource attachments automatically propagate routes to the default propagation route table. -Returned: always -Sample: |
-
| - | Indicates whether DNS support is enabled. -Returned: always -Sample: |
-
| - | Indicates whether Multicast support is enabled. -Returned: always -Sample: |
-
| - | The ID of the default propagation route table. -Returned: when present -Sample: |
-
| - | Indicates whether Equal Cost Multipath Protocol support is enabled. -Returned: always -Sample: |
-
| - | The AWS account number ID which owns the transit gateway. -Returned: always -Sample: |
-
| - | The state of the transit gateway. -Returned: always -Sample: |
-
| - | A dict of tags associated with the transit gateway. -Returned: always -Sample: |
-
| - | The Amazon Resource Name (ARN) of the transit gateway. -Returned: always -Sample: |
-
| - | The ID of the transit gateway. -Returned: always -Sample: |
-