community / community.aws / 4.3.0 / module / ec2_vpc_vgw_info Gather information about virtual gateways in AWS | "added in version" 1.0.0 of community.aws" Authors: Nick Aslanidis (@naslanidis)community.aws.ec2_vpc_vgw_info (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
Gather information about virtual gateways (VGWs) in AWS.
# # 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 profile: production register: vgw_info
- 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" register: vgw_info
- 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 register: vgw_info
region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str filters: 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_DescribeVpnGateways.html) for possible filters. type: dict profile: aliases: - aws_profile description: - Uses a boto profile. Only works with boto >= 2.24.0. - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_ca_bundle: description: - 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.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - 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 I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - 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 I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. type: bool vpn_gateway_ids: description: - Get details of a specific Virtual Gateway ID. elements: str type: list debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
virtual_gateways: contains: resource_tags: description: - A dictionary representing the tags attached to the VGW. - Represents the same details as I(tags). example: MyKey: MyValue returned: success type: dict state: description: The current state of the VGW. example: available returned: success type: str tags: contains: key: description: The key of the tag. example: MyKey returned: success type: str value: description: The value of the tag. example: MyValue returned: success type: str description: - A list of dictionaries representing the tags attached to the VGW. - Represents the same details as I(resource_tags). elements: dict returned: success type: list type: description: The type of VPN connection the VGW supports. example: ipsec.1 returned: success type: str vpc_attachments: contains: state: description: The current state of the attachment. example: available returned: success type: str vpc_id: description: The ID of the VPC. example: vpc-12345678901234567 returned: success type: str description: A description of the attachment of VPCs to the VGW. elements: dict returned: success type: list vpn_gateway_id: description: The ID of the VGW. example: vgw-0123456789abcdef0 returned: success type: str description: The virtual gateways for the account. elements: dict returned: always type: list