You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::EC2::VPNConnection

Inherits:
Resource
  • Object
show all
Includes:
TaggedItem
Defined in:
lib/aws/ec2/vpn_connection.rb,
lib/aws/ec2/vpn_connection/telemetry.rb

Defined Under Namespace

Classes: Telemetry

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from TaggedItem

#add_tag, #clear_tags, #tags

Instance Attribute Details

#customer_gateway_configuration ⇒ String (readonly)

Configuration XML for the VPN connection's customer gateway This attribute is always present after creating a vpn connection while the connection state is :pending or :available.

Returns:

  • (String) —

    the current value of customer_gateway_configuration



32
33
34
 
# File 'lib/aws/ec2/vpn_connection.rb', line 32

def customer_gateway_configuration
  @customer_gateway_configuration
end

#customer_gateway_id ⇒ String (readonly)

Returns the current value of customer_gateway_id

Returns:

  • (String) —

    the current value of customer_gateway_id



32
33
34
 
# File 'lib/aws/ec2/vpn_connection.rb', line 32

def customer_gateway_id
  @customer_gateway_id
end

#state ⇒ Symbol (readonly)

Returns the current value of state

Returns:

  • (Symbol) —

    the current value of state



32
33
34
 
# File 'lib/aws/ec2/vpn_connection.rb', line 32

def state
  @state
end

#vpn_connection_id ⇒ String (readonly) Also known as: id

Returns:

  • (String) 


43
44
45
 
# File 'lib/aws/ec2/vpn_connection.rb', line 43

def vpn_connection_id
  @vpn_connection_id
end

#vpn_gateway_id ⇒ String (readonly)

Returns the current value of vpn_gateway_id

Returns:

  • (String) —

    the current value of vpn_gateway_id



32
33
34
 
# File 'lib/aws/ec2/vpn_connection.rb', line 32

def vpn_gateway_id
  @vpn_gateway_id
end

#vpn_type ⇒ String (readonly)

Returns the current value of vpn_type

Returns:

  • (String) —

    the current value of vpn_type



32
33
34
 
# File 'lib/aws/ec2/vpn_connection.rb', line 32

def vpn_type
  @vpn_type
end

Instance Method Details

#customer_gateway ⇒ CustomerGateway

Returns:



77
78
79
 
# File 'lib/aws/ec2/vpn_connection.rb', line 77

def customer_gateway
  CustomerGateway.new(customer_gateway_id, :config => config)
end

#delete ⇒ nil

Deletes this vpn connection.

Returns:

  • (nil) 


90
91
92
93
94
95
 
# File 'lib/aws/ec2/vpn_connection.rb', line 90

def delete
  client_opts = {}
  client_opts[:vpn_connection_id] = vpn_connection_id
  client.delete_vpn_connection(client_opts)
  nil
end

#vgw_telemetry ⇒ Array<Telemetry>

Returns:



82
83
84
85
86
 
# File 'lib/aws/ec2/vpn_connection.rb', line 82

def vgw_telemetry
  vgw_telemetry_details.collect do |details|
    Telemetry.new(self, details)
  end
end

#vpn_gateway ⇒ VPNGateway

Returns:



72
73
74
 
# File 'lib/aws/ec2/vpn_connection.rb', line 72

def vpn_gateway
  VPNGateway.new(vpn_gateway_id, :config => config)
end