Class: Ansible::Ruby::Modules::Ec2_vpc_vpn

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb

Overview

This module creates, modifies, and deletes VPN connections. Idempotence is achieved by using the filters option or specifying the VPN connection identifier.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#connection_type ⇒ :"ipsec.1"?

Returns The type of VPN connection.

Returns:

  • (:"ipsec.1", nil) —

    The type of VPN connection.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 20

attribute :connection_type

#customer_gateway_id ⇒ String?

Returns The ID of the customer gateway.

Returns:

  • (String, nil) —

    The ID of the customer gateway.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 16

attribute :customer_gateway_id

#filters ⇒ Hash?

Returns 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 ‘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 ‘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. See examples.

Returns:

  • (Hash, nil) —

    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 ‘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 ‘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. See examples.



48
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 48

attribute :filters

#purge_routes ⇒ Boolean?

Returns Whether or not to delete VPN connections routes that are not specified in the task.

Returns:

  • (Boolean, nil) —

    Whether or not to delete VPN connections routes that are not specified in the task.



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 56

attribute :purge_routes

#purge_tags ⇒ Symbol?

Returns Whether or not to delete VPN connections tags that are associated with the connection but not specified in the task.

Returns:

  • (Symbol, nil) —

    Whether or not to delete VPN connections tags that are associated with the connection but not specified in the task.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 36

attribute :purge_tags

#routes ⇒ Array<String>, ...

Returns Routes to add to the connection.

Returns:

  • (Array<String>, String, nil) —

    Routes to add to the connection.



52
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 52

attribute :routes

#state ⇒ :present, ...

Returns The desired state of the VPN connection.

Returns:

  • (:present, :absent, nil) —

    The desired state of the VPN connection.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 12

attribute :state

#static_only ⇒ Boolean?

Returns Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don’t support BGP.

Returns:

  • (Boolean, nil) —

    Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don’t support BGP.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 40

attribute :static_only

#tags ⇒ Hash?

Returns Tags to attach to the VPN connection.

Returns:

  • (Hash, nil) —

    Tags to attach to the VPN connection.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 32

attribute :tags

#tunnel_options ⇒ Array<Hash>, ...

Returns An optional list object containing no more than two dict members, each of which may contain ‘TunnelInsideCidr’ and/or ‘PreSharedKey’ keys with appropriate string values. AWS defaults will apply in absence of either of the aforementioned keys.

Returns:

  • (Array<Hash>, Hash, nil) —

    An optional list object containing no more than two dict members, each of which may contain ‘TunnelInsideCidr’ and/or ‘PreSharedKey’ keys with appropriate string values. AWS defaults will apply in absence of either of the aforementioned keys.



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 44

attribute :tunnel_options

#vpn_connection_id ⇒ String?

Returns The ID of the VPN connection. Required to modify or delete a connection if the filters option does not provide a unique match.

Returns:

  • (String, nil) —

    The ID of the VPN connection. Required to modify or delete a connection if the filters option does not provide a unique match.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 28

attribute :vpn_connection_id

#vpn_gateway_id ⇒ String?

Returns The ID of the virtual private gateway.

Returns:

  • (String, nil) —

    The ID of the virtual private gateway.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_vpn.rb', line 24

attribute :vpn_gateway_id