Documentation

ec2_vpc_vgw - Create and delete AWS VPN Virtual Gateways.

New in version 2.2.

Synopsis

  • Creates AWS VPN Virtual Gateways
  • Deletes AWS VPN Virtual Gateways
  • Attaches Virtual Gateways to VPCs
  • Detaches Virtual Gateways from VPCs

Requirements

The below requirements are needed on the host that executes this module.

  • boto3

Parameters

Parameter Choices/Defaults Comments
asn
(added in 2.6)
the BGP ASN of the amazon side
name
name of the vgw to be created or deleted
region
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
state
    Choices:
  • present ←
  • absent
present to ensure resource is created.
absent to remove resource
tags
dictionary of resource tags

aliases: resource_tags
type
    Choices:
  • ipsec.1
type of the virtual gateway to be created
vpc_id
the vpc-id of a vpc to attach or detach
vpn_gateway_id
vpn gateway id of an existing virtual gateway
wait_timeout Default:
320
number of seconds to wait for status during vpc attach and detach

Examples

- name: Create a new vgw attached to a specific VPC
  ec2_vpc_vgw:
    state: present
    region: ap-southeast-2
    profile: personal
    vpc_id: vpc-12345678
    name: personal-testing
    type: ipsec.1
  register: created_vgw

- name: Create a new unattached vgw
  ec2_vpc_vgw:
    state: present
    region: ap-southeast-2
    profile: personal
    name: personal-testing
    type: ipsec.1
    tags:
      environment: production
      owner: ABC
  register: created_vgw

- name: Remove a new vgw using the name
  ec2_vpc_vgw:
    state: absent
    region: ap-southeast-2
    profile: personal
    name: personal-testing
    type: ipsec.1
  register: deleted_vgw

- name: Remove a new vgw using the vpn_gateway_id
  ec2_vpc_vgw:
    state: absent
    region: ap-southeast-2
    profile: personal
    vpn_gateway_id: vgw-3a9aa123
  register: deleted_vgw

Return Values

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

Key Returned Description
result
dictionary
success
The result of the create, or delete action.



Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance

This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by an Ansible Partner, see here.

Author

  • Nick Aslanidis (@naslanidis)

Hint

If you notice any issues in this documentation you can edit this document to improve it.