community.aws.ec2_vpc_peering_info – Retrieves AWS VPC Peering details using AWS methods.
Note
This plugin is part of the community.aws collection (version 1.5.0).
You might already have this collection installed if you are using the ansible
package. 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
.
To use it in a playbook, specify: community.aws.ec2_vpc_peering_info
.
New in version 1.0.0: of community.aws
Synopsis
- Gets various details related to AWS VPC Peers
- This module was called
ec2_vpc_peering_facts
before Ansible 2.9. The usage did not change.
Requirements
The below requirements are needed on the host that executes this module.
- boto
- boto3
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key string | 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 profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_access_key, access_key | |
aws_ca_bundle path | 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. | |
aws_config dictionary | A dictionary to modify the botocore configuration. Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. | |
aws_secret_key string | 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 profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_secret_key, secret_key | |
debug_botocore_endpoint_logs boolean |
| 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. |
ec2_url string | 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. aliases: aws_endpoint_url, endpoint_url | |
filters dictionary | 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_DescribeVpcPeeringConnections.html for possible filters. | |
peer_connection_ids list / elements=string | List of specific VPC peer IDs to get details for. | |
profile string | Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. aliases: aws_profile | |
region string | 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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region | |
security_token string | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: aws_security_token, access_token | |
validate_certs boolean |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Notes
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
Examples
# 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
result list / elements=string | success | The result of the describe. | |||
vpc_peering_connections list / elements=string | success | Details of the matching VPC peering connections. | |||
accepter_vpc_info complex | success | Information about the VPC which accepted the connection. | |||
cidr_block string | when connection is in the accepted state. | The primary CIDR for the VPC. Sample: 10.10.10.0/23 | |||
cidr_block_set complex | when connection is in the accepted state. | A list of all CIDRs for the VPC. | |||
cidr_block string | success | A CIDR block used by the VPC. Sample: 10.10.10.0/23 | |||
owner_id string | success | The AWS account that owns the VPC. Sample: 012345678901 | |||
peering_options dictionary | when connection is in the accepted state. | Additional peering configuration. | |||
allow_dns_resolution_from_remote_vpc boolean | success | Indicates whether a VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. | |||
allow_egress_from_local_classic_link_to_remote_vpc boolean | success | Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection. | |||
allow_egress_from_local_vpc_to_remote_classic_link boolean | success | Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection. | |||
region string | success | The AWS region that the VPC is in. Sample: us-east-1 | |||
vpc_id string | success | The ID of the VPC Sample: vpc-0123456789abcdef0 | |||
requester_vpc_info complex | success | Information about the VPC which requested the connection. | |||
cidr_block string | when connection is not in the deleted state. | The primary CIDR for the VPC. Sample: 10.10.10.0/23 | |||
cidr_block_set complex | when connection is not in the deleted state. | A list of all CIDRs for the VPC. | |||
cidr_block string | success | A CIDR block used by the VPC Sample: 10.10.10.0/23 | |||
owner_id string | success | The AWS account that owns the VPC. Sample: 012345678901 | |||
peering_options dictionary | when connection is not in the deleted state. | Additional peering configuration. | |||
allow_dns_resolution_from_remote_vpc boolean | success | Indicates whether a VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. | |||
allow_egress_from_local_classic_link_to_remote_vpc boolean | success | Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection. | |||
allow_egress_from_local_vpc_to_remote_classic_link boolean | success | Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection. | |||
region string | success | The AWS region that the VPC is in. Sample: us-east-1 | |||
vpc_id string | success | The ID of the VPC Sample: vpc-0123456789abcdef0 | |||
status complex | success | Details of the current status of the connection. | |||
code string | success | A short code describing the status of the connection. Sample: active | |||
message string | success | Additional information about the status of the connection. Sample: Pending Acceptance by 012345678901 | |||
tags dictionary | success | Tags applied to the connection. | |||
vpc_peering_connection_id string | success | The ID of the VPC peering connection. Sample: pcx-0123456789abcdef0 |
Authors
- Karen Cheng (@Etherdaemon)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/ec2_vpc_peering_info_module.html