Try SpotterGather information about ec2 transit gateways in AWS
| "added in version" 1.0.0 of community.aws"
Authors: Bob Boldin (@BobBoldin)
Install with ansible-galaxy collection install community.aws:==5.1.0
collections:
- name: community.aws
version: 5.1.0Gather information about ec2 transit gateways in AWS
# 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
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
filters:
default: {}
description:
- A dict of filters to apply. Each dict item consists of a filter key and a filter
value. See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html)
for filters.
type: dict
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
transit_gateway_ids:
aliases:
- transit_gateway_id
default: []
description:
- A list of transit gateway IDs to gather information for.
elements: str
type: list
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
transit_gateways:
contains:
creation_time:
description: The creation time.
returned: always
sample: '2019-02-05T16:19:58+00:00'
type: str
description:
description: The description of the transit gateway.
returned: always
sample: A transit gateway
type: str
options:
contains:
amazon_side_asn:
description:
- 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.
returned: always
sample: 64512
type: int
association_default_route_table_id:
description:
- The ID of the default association route table.
returned: when present
sample: rtb-11223344
type: str
auto_accept_shared_attachments:
description:
- Indicates whether attachment requests are automatically accepted.
returned: always
sample: enable
type: str
default_route_table_association:
description:
- Indicates whether resource attachments are automatically associated with
the default association route table.
returned: always
sample: disable
type: str
default_route_table_propagation:
description:
- Indicates whether resource attachments automatically propagate routes
to the default propagation route table.
returned: always
sample: disable
type: str
dns_support:
description:
- Indicates whether DNS support is enabled.
returned: always
sample: enable
type: str
propagation_default_route_table_id:
description:
- The ID of the default propagation route table.
returned: when present
sample: rtb-11223344
type: str
vpn_ecmp_support:
description:
- Indicates whether Equal Cost Multipath Protocol support is enabled.
returned: always
sample: enable
type: str
description: A dictionary of the transit gateway options.
returned: always
type: complex
owner_id:
description: The AWS account number ID which owns the transit gateway.
returned: always
sample: '123456789012'
type: str
state:
description: The state of the transit gateway.
returned: always
sample: available
type: str
tags:
description: A dict of tags associated with the transit gateway.
returned: always
sample: '{ "Name": "A sample TGW" }'
type: dict
transit_gateway_arn:
description: The Amazon Resource Name (ARN) of the transit gateway.
returned: always
sample: arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-02c42332e6b7da829
type: str
transit_gateway_id:
description: The ID of the transit gateway.
returned: always
sample: tgw-02c42332e6b7da829
type: str
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
type: complex