amazon.aws.ec2_vpc_vpn module – Create, modify, and delete EC2 VPN connections

Note

This module is part of the amazon.aws collection (version 9.0.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 amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.ec2_vpc_vpn.

New in community.aws 1.0.0

Synopsis

• This module creates, modifies, and deletes VPN connections.

• Idempotence is achieved by using the filters option or specifying the VPN connection identifier.

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
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	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 AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference. 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 EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. The AWS_CA_BUNDLE environment variable may also be used.
aws_config dictionary	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.
connection_type string	The type of VPN connection. At this time only ipsec.1 is supported. Default: "ipsec.1"
customer_gateway_id string	The ID of the customer gateway.
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. Choices: false ← (default) true
delay integer	The time, in seconds, to wait before checking operation again. Default: 15
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference. The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.
filters dictionary	An alternative to using vpn_connection_id. If multiple matches are found, vpn_connection_id is required. If one of the following suboptions is a list of items to filter by, only one item needs to match to find the VPN that correlates. e.g. if the filter filters.cidr is ["194.168.2.0/24", "192.168.2.0/24"] and the VPN route only has the destination cidr block of 192.168.2.0/24 it will be found with this filter (assuming there are not multiple VPNs that are matched). Another example, if the filter filters.vpn is equal to ["vpn-ccf7e7ad", "vpn-cb0ae2a2"] and one of of the VPNs has the state deleted (exists but is unmodifiable) and the other exists and is not deleted, it will be found via this filter. Default: {}
bgp string	The BGP ASN number associated with a BGP device. Only works if the connection is attached. This filtering option is currently not working.
cgw string	The customer gateway id as a string or a list of those strings.
cgw-config string	The customer gateway configuration of the VPN as a string (in the format of the return value) or a list of those strings.
cidr string	The destination cidr of the VPN’s route as a string or a list of those strings.
static-routes-only boolean	The type of routing; true or false. Choices: false true
tag-keys string	The key of a tag as a string or a list of those strings.
tag-values string	The value of a tag as a string or a list of those strings.
tags dictionary	A dict of key value pairs.
vgw string	The virtual private gateway as a string or a list of those strings.
vpn string	The VPN connection id as a string or a list of those strings.
local_ipv4_network_cidr string added in amazon.aws 9.0.0	The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. Default: "0.0.0.0/0"
profile aliases: aws_profile string	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 AWS_PROFILE environment variable may also be used. The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
purge_routes boolean	Whether or not to delete VPN connections routes that are not specified in the task. Choices: false ← (default) true
purge_tags boolean	If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Choices: false true ← (default)
region aliases: aws_region, ec2_region string	The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The AWS_REGION or EC2_REGION environment variables may also be used. See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01 Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.
routes list / elements=string	Routes to add to the connection. Default: []
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	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 AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference. 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 EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	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 AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference. 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 EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.
state string	The desired state of the VPN connection. Choices: "present" ← (default) "absent"
static_only boolean	Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don’t support BGP. Choices: false ← (default) true
tags aliases: resource_tags dictionary	A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified.
transit_gateway_id string added in amazon.aws 6.2.0	The ID of the transit gateway. Mutually exclusive with vpn_gateway_id.
tunnel_options list / elements=dictionary	An optional list object containing no more than two dict members, each of which may contain tunnel_options.TunnelInsideCidr and/or tunnel_options.PreSharedKey keys with appropriate string values. AWS defaults will apply in absence of either of the aforementioned keys. Default: []
PreSharedKey string	The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
TunnelInsideCidr string	The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr string added in amazon.aws 9.0.0	The range of inside IPv6 addresses for the tunnel.
validate_certs boolean	When set to false, SSL certificates will not be validated for communication with the AWS APIs. Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices: false true ← (default)
vpn_connection_id string	The ID of the VPN connection. Required to modify or delete a connection if the filters option does not provide a unique match.
vpn_gateway_id string	The ID of the virtual private gateway. Mutually exclusive with transit_gateway_id.
wait_timeout integer	How long, in seconds, before wait gives up. Default: 600

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: Create a VPN connection with vpn_gateway_id
  amazon.aws.ec2_vpc_vpn:
    state: "present"
    vpn_gateway_id: "vgw-XXXXXXXX"
    customer_gateway_id: "cgw-XXXXXXXX"

- name: Attach a vpn connection to transit gateway
  amazon.aws.ec2_vpc_vpn:
    state: "present"
    transit_gateway_id: "tgw-XXXXXXXX"
    customer_gateway_id: "cgw-XXXXXXXX"

- name: Modify VPN connection tags
  amazon.aws.ec2_vpc_vpn:
    state: "present"
    vpn_connection_id: "vpn-XXXXXXXX"
    tags:
      Name: "ansible-tag-1"
      Other: "ansible-tag-2"

- name: Delete a connection
  amazon.aws.ec2_vpc_vpn:
    vpn_connection_id: "vpn-XXXXXXXX"
    state: "absent"

- name: Modify VPN tags (identifying VPN by filters)
  amazon.aws.ec2_vpc_vpn:
    state: "present"
    filters:
      cidr: "194.168.1.0/24"
      tag-keys:
        - "Ansible"
        - "Other"
    tags:
      New: "Tag"
    purge_tags: true
    static_only: true

- name: Set up VPN with tunnel options utilizing 'TunnelInsideCidr' only
  amazon.aws.ec2_vpc_vpn:
    state: "present"
    filters:
      vpn: "vpn-XXXXXXXX"
    static_only: true
    tunnel_options:
      - TunnelInsideCidr: "169.254.100.1/30"
      - TunnelInsideCidr: "169.254.100.5/30"

- name: Add routes and remove any preexisting ones
  amazon.aws.ec2_vpc_vpn:
    state: "present"
    filters:
      vpn: "vpn-XXXXXXXX"
    routes:
      - "195.168.2.0/24"
      - "196.168.2.0/24"
    purge_routes: true

- name: Remove all routes
  amazon.aws.ec2_vpc_vpn:
    state: "present"
    vpn_connection_id: "vpn-XXXXXXXX"
    routes: []
    purge_routes: true

- name: Delete a VPN identified by filters
  amazon.aws.ec2_vpc_vpn:
    state: "absent"
    filters:
      tags:
        Ansible: "Tag"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
changed boolean	If the VPN connection has changed. Returned: always Sample: true
customer_gateway_configuration string	The configuration of the VPN connection. Returned: state=present
customer_gateway_id string	The customer gateway connected via the connection. Returned: state=present Sample: "cgw-1220c87b"
gateway_association_state string	The current state of the gateway association. Returned: state=present Sample: "associated"
options list / elements=dictionary	The VPN connection options. Returned: state=present
enable_acceleration boolean	Indicates whether acceleration is enabled for the VPN connection. Returned: state=present Sample: false
local_ipv4_network_cidr string	The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. Returned: state=present Sample: "0.0.0.0/0"
outside_ip_address_type string	The external IP address of the VPN tunnel. Returned: state=present Sample: "PublicIpv4"
remote_ipv4_network_cidr string	The IPv4 CIDR on the Amazon Web Services side of the VPN connection. Returned: state=present Sample: "0.0.0.0/0"
static_routes_only boolean	If the VPN connection only allows static routes. Returned: state=present Sample: true
tunnel_inside_ip_version string	Indicates whether the VPN tunnels process IPv4 or IPv6 traffic. Returned: state=present Sample: "ipv4"
tunnel_options list / elements=dictionary	Indicates the VPN tunnel options. Returned: state=present Sample: [{"log_options": {"cloud_watch_log_options": {"log_enabled": false}}, "outside_ip_address": "34.225.101.10", "pre_shared_key": "8n7hnjNE8zhIt4VpMOIfcrw6XnUTHLW9", "tunnel_inside_cidr": "169.254.31.8/30"}]
log_options dictionary	Options for logging VPN tunnel activity. Returned: state=present
cloud_watch_log_options dictionary	Options for sending VPN tunnel logs to CloudWatch. Returned: state=present
outside_ip_address string	The external IP address of the VPN tunnel. Returned: state=present
pre_shared_key string	The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway. Returned: state=present
tunnel_inside_cidr string	The range of inside IPv4 addresses for the tunnel. Returned: state=present
routes list / elements=string	The routes of the VPN connection. Returned: state=present Sample: [{"destination_cidr_block": "192.168.1.0/24", "state": "available"}]
destination_cidr_block string	The CIDR block associated with the local subnet of the customer data center. Returned: state=present
source string	Indicates how the routes were provided. Returned: state=present
state string	The current state of the static route. Returned: state=present
state string	The status of the VPN connection. Returned: state=present Sample: "available"
tags dictionary	The tags associated with the connection. Returned: state=present Sample: {"name": "ansible-test", "other": "tag"}
transit_gateway_id string	The transit gateway id to which the vpn connection can be attached. Returned: state=present Sample: "tgw-cb0ae2a2"
type string	The type of VPN connection (currently only ipsec.1 is available). Returned: state=present Sample: "ipsec.1"
vgw_telemetry list / elements=string	The telemetry for the VPN tunnel. Returned: state=present Sample: [{"accepted_route_count": 0, "last_status_change": "2024-09-30T13:12:33+00:00", "outside_ip_address": "34.225.101.10", "status": "DOWN", "status_message": "IPSEC IS DOWN"}]
accepted_route_count integer	The number of accepted routes. Returned: state=present
certificate_arn string	The Amazon Resource Name of the virtual private gateway tunnel endpoint certificate. Returned: when a private certificate is used for authentication Sample: "arn:aws:acm:us-east-1:123456789012:certificate/c544d8ce-20b8-4fff-98b0-example"
last_status_change string	The date and time of the last change in status. Returned: state=present
outside_ip_address string	The Internet-routable IP address of the virtual private gateway’s outside interface. Returned: state=present
status string	The status of the VPN tunnel. Returned: state=present
status_message string	If an error occurs, a description of the error. Returned: state=present
vpn_connection_id string	The identifier for the VPN connection. Returned: state=present Sample: "vpn-781e0e19"
vpn_gateway_id string	The virtual private gateway connected via the connection. Returned: state=present Sample: "vgw-cb0ae2a2"

Authors

• Sloane Hertel (@s-hertel)

Collection links

• Issue Tracker
• Repository (Sources)
• Communication