community.aws.ec2_vpc_vgw_info module – Gather information about virtual gateways in AWS
+community.aws.ec2_vpc_vgw_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_vpc_vgw_info.
New in community.aws 1.0.0
- -Synopsis
--
-
Gather information about virtual gateways (VGWs) 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
-
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 dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnGateways.html for possible filters. -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 |
-
| - | When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. -Choices: -
|
-
| - | One or more virtual private gateway IDs. - |
-
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 information about all virtual gateways for an account or profile
- community.aws.ec2_vpc_vgw_info:
- region: ap-southeast-2
-
-- name: Gather information about a filtered list of Virtual Gateways
- community.aws.ec2_vpc_vgw_info:
- region: ap-southeast-2
- profile: production
- filters:
- "tag:Name": "main-virt-gateway"
-
-- name: Gather information about a specific virtual gateway by VpnGatewayIds
- community.aws.ec2_vpc_vgw_info:
- region: ap-southeast-2
- profile: production
- vpn_gateway_ids: vgw-c432f6a7
-Return Values
-Common return values are documented here, the following are the fields unique to this module:
-Key |
-Description |
-
|---|---|
| - | Information about one or more virtual private gateways. -Returned: always - |
-
| - | A dictionary representing the tags attached to the VGW. -Represents the same details as Returned: success -Sample: |
-
| - | Informtion about the current state of the virtual private gateway. -Returned: success -Sample: |
-
| - | A list of dictionaries representing the tags attached to the virtual private gateway. -Represents the same details as Returned: success - |
-
| - | The key of the tag. -Returned: success -Sample: |
-
| - | The value of the tag. -Returned: success -Sample: |
-
| - | Information about type of VPN connection the virtual private gateway supports. -Returned: success -Sample: |
-
| - | Information about the VPCs attached to the virtual private gateway. -Returned: success - |
-
| - | The current state of the attachment. -Returned: success -Sample: |
-
| - | The ID of the VPC. -Returned: success -Sample: |
-
| - | The ID of the virtual private gateway. -Returned: success -Sample: |
-