community / community.aws / 3.4.0 / module / ec2_vpc_peering_info Retrieves AWS VPC Peering details using AWS methods. | "added in version" 1.0.0 of community.aws" Authors: Karen Cheng (@Etherdaemon)community.aws.ec2_vpc_peering_info (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Gets various details related to AWS VPC Peers
# Simple example of listing all VPC Peers - name: List all vpc peers community.aws.ec2_vpc_peering_info: region: ap-southeast-2 register: all_vpc_peers
- name: Debugging the result ansible.builtin.debug: msg: "{{ all_vpc_peers.result }}"
- name: Get details on specific VPC peer community.aws.ec2_vpc_peering_info: peer_connection_ids: - pcx-12345678 - pcx-87654321 region: ap-southeast-2 register: all_vpc_peers
- name: Get all vpc peers with specific filters community.aws.ec2_vpc_peering_info: region: ap-southeast-2 filters: status-code: ['pending-acceptance'] register: pending_vpc_peers
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_DescribeVpcPeeringConnections.html) for possible filters. type: dict profile: aliases: - aws_profile description: - 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. - Not used by boto 2 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: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(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: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(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: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(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 communication with the AWS APIs. type: bool peer_connection_ids: description: - List of specific VPC peer IDs to get details for. 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
result: description: The result of the describe. returned: success type: list vpc_peering_connections: contains: accepter_vpc_info: contains: cidr_block: description: The primary CIDR for the VPC. example: 10.10.10.0/23 returned: when connection is in the accepted state. type: str cidr_block_set: contains: cidr_block: description: A CIDR block used by the VPC. example: 10.10.10.0/23 returned: success type: str description: A list of all CIDRs for the VPC. returned: when connection is in the accepted state. type: complex owner_id: description: The AWS account that owns the VPC. example: 012345678901 returned: success type: str peering_options: contains: allow_dns_resolution_from_remote_vpc: description: Indicates whether a VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. returned: success type: bool allow_egress_from_local_classic_link_to_remote_vpc: description: Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection. returned: success type: bool allow_egress_from_local_vpc_to_remote_classic_link: description: Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection. returned: success type: bool description: Additional peering configuration. returned: when connection is in the accepted state. type: dict region: description: The AWS region that the VPC is in. example: us-east-1 returned: success type: str vpc_id: description: The ID of the VPC example: vpc-0123456789abcdef0 returned: success type: str description: Information about the VPC which accepted the connection. returned: success type: complex requester_vpc_info: contains: cidr_block: description: The primary CIDR for the VPC. example: 10.10.10.0/23 returned: when connection is not in the deleted state. type: str cidr_block_set: contains: cidr_block: description: A CIDR block used by the VPC example: 10.10.10.0/23 returned: success type: str description: A list of all CIDRs for the VPC. returned: when connection is not in the deleted state. type: complex owner_id: description: The AWS account that owns the VPC. example: 012345678901 returned: success type: str peering_options: contains: allow_dns_resolution_from_remote_vpc: description: Indicates whether a VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. returned: success type: bool allow_egress_from_local_classic_link_to_remote_vpc: description: Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection. returned: success type: bool allow_egress_from_local_vpc_to_remote_classic_link: description: Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection. returned: success type: bool description: Additional peering configuration. returned: when connection is not in the deleted state. type: dict region: description: The AWS region that the VPC is in. example: us-east-1 returned: success type: str vpc_id: description: The ID of the VPC example: vpc-0123456789abcdef0 returned: success type: str description: Information about the VPC which requested the connection. returned: success type: complex status: contains: code: description: A short code describing the status of the connection. example: active returned: success type: str message: description: Additional information about the status of the connection. example: Pending Acceptance by 012345678901 returned: success type: str description: Details of the current status of the connection. returned: success type: complex tags: description: Tags applied to the connection. returned: success type: dict vpc_peering_connection_id: description: The ID of the VPC peering connection. example: pcx-0123456789abcdef0 returned: success type: str description: Details of the matching VPC peering connections. returned: success type: list