community.aws.ec2_vpc_peer module – create, delete, accept, and reject VPC peering connections between two VPCs.
+community.aws.ec2_vpc_peer 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_peer.
New in community.aws 1.0.0
- -Synopsis
--
-
Read the AWS documentation for VPC Peering Connections https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-peering.html.
-
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 |
-
| - | The AWS account number for cross account peering. - |
-
| - | Region of the accepting VPC. - |
-
| - | VPC id of the accepting VPC. - |
-
| - | Peering connection id. - |
-
| - | 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. - |
-
| - | If If the Tag keys beginning with Choices: -
|
-
| - | 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 |
-
| - | Create, delete, accept, reject a peering connection. -Choices: -
|
-
| - | A dictionary representing the tags to be applied to the resource. -If the |
-
| - | When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. -Choices: -
|
-
| - | VPC id of the requesting VPC. - |
-
| - | Wait for peering state changes to complete. -Choices: -
|
-
Notes
-Note
--
-
Support for
purge_tagswas added in release 2.0.0.
-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
-# Complete example to create and accept a local peering connection.
-- name: Create local account EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- vpc_id: "vpc-12345678"
- peer_vpc_id: "vpc-87654321"
- state: "present"
- tags:
- Name: "Peering connection for VPC 21 to VPC 22"
- CostCode: "CC1234"
- Project: "phoenix"
- register: vpc_peer
-
-- name: Accept local EC2 VPC Peering request
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- peering_id: "{{ vpc_peer.peering_id }}"
- state: "accept"
- register: action_peer
-
-# Complete example to delete a local peering connection.
-- name: Create local account EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- vpc_id: "vpc-12345678"
- peer_vpc_id: "vpc-87654321"
- state: "present"
- tags:
- Name: "Peering connection for VPC 21 to VPC 22"
- CostCode: "CC1234"
- Project: "phoenix"
- register: vpc_peer
-
-- name: Delete a local EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- peering_id: "{{ vpc_peer.peering_id }}"
- state: "absent"
- register: vpc_peer
-
- # Complete example to create and accept a cross account peering connection.
-- name: Create cross account EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- vpc_id: "vpc-12345678"
- peer_vpc_id: "vpc-12345678"
- peer_owner_id: "123456789012"
- state: "present"
- tags:
- Name: "Peering connection for VPC 21 to VPC 22"
- CostCode: "CC1234"
- Project: "phoenix"
- register: vpc_peer
-
-- name: Accept EC2 VPC Peering Connection from remote account
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- peering_id: "{{ vpc_peer.peering_id }}"
- profile: "bot03_profile_for_cross_account"
- state: "accept"
- register: vpc_peer
-
-# Complete example to create and accept an intra-region peering connection.
-- name: Create intra-region EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "us-east-1"
- vpc_id: "vpc-12345678"
- peer_vpc_id: "vpc-87654321"
- peer_region: "us-west-2"
- state: "present"
- tags:
- Name: "Peering connection for us-east-1 VPC to us-west-2 VPC"
- CostCode: "CC1234"
- Project: "phoenix"
- register: vpc_peer
-
-- name: Accept EC2 VPC Peering Connection from peer region
- community.aws.ec2_vpc_peer:
- region: "us-west-2"
- peering_id: "{{ vpc_peer.peering_id }}"
- state: "accept"
- register: vpc_peer
-
-# Complete example to create and reject a local peering connection.
-- name: Create local account EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- vpc_id: "vpc-12345678"
- peer_vpc_id: "vpc-87654321"
- state: "present"
- tags:
- Name: "Peering connection for VPC 21 to VPC 22"
- CostCode: "CC1234"
- Project: "phoenix"
- register: vpc_peer
-
-- name: Reject a local EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- peering_id: "{{ vpc_peer.peering_id }}"
- state: "reject"
-
-# Complete example to create and accept a cross account peering connection.
-- name: Create cross account EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- vpc_id: "vpc-12345678"
- peer_vpc_id: "vpc-12345678"
- peer_owner_id: "123456789012"
- state: "present"
- tags:
- Name: "Peering connection for VPC 21 to VPC 22"
- CostCode: "CC1234"
- Project: "phoenix"
- register: vpc_peer
-
-- name: Accept a cross account EC2 VPC Peering Connection request
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- peering_id: "{{ vpc_peer.peering_id }}"
- profile: "bot03_profile_for_cross_account"
- state: "accept"
- tags:
- Name: "Peering connection for VPC 21 to VPC 22"
- CostCode: "CC1234"
- Project: "phoenix"
-
-# Complete example to create and reject a cross account peering connection.
-- name: Create cross account EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- vpc_id: "vpc-12345678"
- peer_vpc_id: "vpc-12345678"
- peer_owner_id: "123456789012"
- state: "present"
- tags:
- Name: "Peering connection for VPC 21 to VPC 22"
- CostCode: "CC1234"
- Project: "phoenix"
- register: vpc_peer
-
-- name: Reject a cross account EC2 VPC Peering Connection
- community.aws.ec2_vpc_peer:
- region: "ap-southeast-2"
- peering_id: "{{ vpc_peer.peering_id }}"
- profile: "bot03_profile_for_cross_account"
- state: "reject"
-Return Values
-Common return values are documented here, the following are the fields unique to this module:
-Key |
-Description |
-
|---|---|
| - | The id of the VPC peering connection created/deleted. -Returned: always -Sample: |
-
| - | The details of the VPC peering connection. -Returned: success - |
-
| - | Information about the VPC which accepted the connection. -Returned: success - |
-
| - | The primary CIDR for the VPC. -Returned: when connection is in the accepted state. -Sample: |
-
| - | A list of all CIDRs for the VPC. -Returned: when connection is in the accepted state. - |
-
| - | A CIDR block used by the VPC. -Returned: success -Sample: |
-
| - | The AWS account that owns the VPC. -Returned: success -Sample: |
-
| - | Additional peering configuration. -Returned: when connection is in the accepted state. - |
-
| - | Indicates whether a VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. -Returned: success - |
-
| - | Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection. -Returned: success - |
-
| - | Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection. -Returned: success - |
-
| - | The AWS region that the VPC is in. -Returned: success -Sample: |
-
| - | The ID of the VPC -Returned: success -Sample: |
-
| - | The time that an unaccepted VPC peering connection will expire. -Returned: success -Sample: |
-
| - | Information about the VPC which requested the connection. -Returned: success - |
-
| - | The primary CIDR for the VPC. -Returned: when connection is not in the deleted state. -Sample: |
-
| - | A list of all CIDRs for the VPC. -Returned: when connection is not in the deleted state. - |
-
| - | A CIDR block used by the VPC -Returned: success -Sample: |
-
| - | The AWS account that owns the VPC. -Returned: success -Sample: |
-
| - | Additional peering configuration. -Returned: when connection is not in the deleted state. - |
-
| - | Indicates whether a VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. -Returned: success - |
-
| - | Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection. -Returned: success - |
-
| - | Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection. -Returned: success - |
-
| - | The AWS region that the VPC is in. -Returned: success -Sample: |
-
| - | The ID of the VPC -Returned: success -Sample: |
-
| - | Details of the current status of the connection. -Returned: success - |
-
| - | A short code describing the status of the connection. -Returned: success -Sample: |
-
| - | Additional information about the status of the connection. -Returned: success -Sample: |
-
| - | Tags applied to the connection. -Returned: success - |
-
| - | The ID of the VPC peering connection. -Returned: success -Sample: |
-
Collection links
--
-
- Issue Tracker -
- Repository (Sources) -
- Communication +
This is a redirect to the amazon.aws.ec2_vpc_peer module.
+This redirect does not work with Ansible 2.9.