Class: MintPress::Aws::EC2::VpnConnection

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb

Properties (Read/Write)

  • #category ⇒ [String]
    'The category of the VPN connection.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnConnection"
    • orig_name ⇒ 'category'
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 31

property :category, disposition: :attribute, description: 'The category of the VPN connection.', source: "MintPress::Aws::EC2::VpnConnection", orig_name: 'category', type: [String]
  • #customer_gateway_configuration ⇒ [String]
    'The configuration information for the VPN connection"s customer gateway (in the native XML format).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnConnection"
    • orig_name ⇒ 'customer_gateway_configuration'
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 32

property :customer_gateway_configuration, disposition: :attribute, description: 'The configuration information for the VPN connection"s customer gateway (in the native XML format).', source: "MintPress::Aws::EC2::VpnConnection", orig_name: 'customer_gateway_configuration', type: [String]
  • #options ⇒ [MintPress::Aws::EC2::VpnConnectionOption] (Default Value: MintPress::Aws::EC2::VpnConnectionOption.new)
    'The VPN connection options.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnConnection"
    • orig_name ⇒ 'options'
    • default ⇒ MintPress::Aws::EC2::VpnConnectionOption.new
    • create_vpn_connection_prop ⇒ 'options'
    • read_only ⇒ false
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 33

property :options, disposition: :attribute, description: 'The VPN connection options.', source: "MintPress::Aws::EC2::VpnConnection", orig_name: 'options', type: [MintPress::Aws::EC2::VpnConnectionOption], default: MintPress::Aws::EC2::VpnConnectionOption.new, create_vpn_connection_prop: 'options', read_only: false
  • #routes ⇒ Array of ⇒ [MintPress::Aws::EC2::VpnStaticRoute]
    'The static routes associated with the VPN connection.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnConnection"
    • orig_name ⇒ 'routes'
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 34

property :routes, disposition: :attribute, description: 'The static routes associated with the VPN connection.', source: "MintPress::Aws::EC2::VpnConnection", orig_name: 'routes', type: [MintPress::Aws::EC2::VpnStaticRoute], array: true
  • #state ⇒ [String]
    'The current state of the VPN connection.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnConnection"
    • orig_name ⇒ 'state'
    

35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 35

property :state, disposition: :attribute, description: 'The current state of the VPN connection.', source: "MintPress::Aws::EC2::VpnConnection", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'Any tags assigned to the VPN connection.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnConnection"
    • orig_name ⇒ 'tags'
    • create_vpn_connection_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 36

property :tags, disposition: :attribute, description: 'Any tags assigned to the VPN connection.', source: "MintPress::Aws::EC2::VpnConnection", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_vpn_connection_prop: 'tag_specifications', read_only: false, hash: true
  • #type ⇒ [String]
    'The type of VPN connection.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnConnection"
    • orig_name ⇒ 'type'
    • create_vpn_connection_prop ⇒ 'type'
    • read_only ⇒ false
    

37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 37

property :type, disposition: :attribute, description: 'The type of VPN connection.', source: "MintPress::Aws::EC2::VpnConnection", orig_name: 'type', type: [String], create_vpn_connection_prop: 'type', read_only: false
  • #vgw_telemetry ⇒ Array of ⇒ [MintPress::Aws::EC2::VgwTelemetry]
    'Information about the VPN tunnel.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnConnection"
    • orig_name ⇒ 'vgw_telemetry'
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 38

property :vgw_telemetry, disposition: :attribute, description: 'Information about the VPN tunnel.', source: "MintPress::Aws::EC2::VpnConnection", orig_name: 'vgw_telemetry', type: [MintPress::Aws::EC2::VgwTelemetry], array: true
  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
    Property Attributes
    • create_vpn_connection_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "modify_vpn_connection"
    • delete_vpn_connection_prop ⇒ 'dry_run'
    • describe_vpn_connections_prop ⇒ 'dry_run'
    • modify_vpn_connection_prop ⇒ 'dry_run'
    

39
40
41
42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 39

property :dry_run, create_vpn_connection_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "modify_vpn_connection", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.', delete_vpn_connection_prop: 'dry_run', describe_vpn_connections_prop: 'dry_run', modify_vpn_connection_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. customer-gateway-configuration - The configuration information for the customer gateway. customer-gateway-id - The ID of a customer gateway associated with the VPN connection. state - The state of the VPN connection (pending | available | deleting | deleted). option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP). route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center. bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. type - The type of VPN connection. Currently the only supported type is ipsec.1. vpn-connection-id - The ID of the VPN connection. vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection. transit-gateway-id - The ID of a transit gateway associated with the VPN connection.'
    Property Attributes
    • describe_vpn_connections_prop ⇒ 'filters'
    • source ⇒ "describe_vpn_connections"
    

43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 43

property :filters, describe_vpn_connections_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_vpn_connections", description: 'One or more filters.


customer-gateway-configuration - The configuration information for
the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with
the VPN connection.
state - The state of the VPN connection (pending | available
| deleting | deleted).
option.static-routes-only - Indicates whether the connection has
static routes only. Used for devices that do not support Border
Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This
corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a
BGP device.
tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value
as the filter value. For example, to find all resources that have a
tag with the key Owner and the value TeamA, specify tag:Owner
for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
type - The type of VPN connection. Currently the only supported
type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated
with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with
the VPN connection.', hash: true
  • #customer_gateway ⇒ [MintPress::Aws::EC2::CustomerGateway]
    'The ID of the customer gateway at your end of the VPN connection.'
    Property Attributes
    • source ⇒ "modify_vpn_connection"
    • orig_name ⇒ 'customer_gateway_id'
    • create_vpn_connection_prop ⇒ 'customer_gateway_id'
    • read_only ⇒ false
    • modify_vpn_connection_prop ⇒ 'customer_gateway_id'
    • from ⇒ String
    

74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 74

property :customer_gateway, description: 'The ID of the customer gateway at your end of the VPN connection.', source: "modify_vpn_connection", orig_name: 'customer_gateway_id', type: [MintPress::Aws::EC2::CustomerGateway], create_vpn_connection_prop: 'customer_gateway_id', read_only: false, modify_vpn_connection_prop: 'customer_gateway_id', from: String
  • #transit_gateway ⇒ [MintPress::Aws::EC2::TransitGateway]
    'The ID of the transit gateway.'
    Property Attributes
    • source ⇒ "modify_vpn_connection"
    • orig_name ⇒ 'transit_gateway_id'
    • create_vpn_connection_prop ⇒ 'transit_gateway_id'
    • read_only ⇒ false
    • modify_vpn_connection_prop ⇒ 'transit_gateway_id'
    • from ⇒ String
    

75
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 75

property :transit_gateway, description: 'The ID of the transit gateway.', source: "modify_vpn_connection", orig_name: 'transit_gateway_id', type: [MintPress::Aws::EC2::TransitGateway], create_vpn_connection_prop: 'transit_gateway_id', read_only: false, modify_vpn_connection_prop: 'transit_gateway_id', from: String
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'One or more VPN connection IDs. Default: Describes your VPN connections.'
    Property Attributes
    • source ⇒ "describe_vpn_connections"
    • orig_name ⇒ 'vpn_connection_id'
    • delete_vpn_connection_prop ⇒ 'vpn_connection_id'
    • read_only ⇒ false
    • modify_vpn_connection_prop ⇒ 'vpn_connection_id'
    • describe_vpn_connections_prop ⇒ 'vpn_connection_ids'
    • default ⇒ Proc.new { self.name }
    

76
77
78
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 76

property :id, description: 'One or more VPN connection IDs.

Default: Describes your VPN connections.', source: "describe_vpn_connections", orig_name: 'vpn_connection_id', type: [String], delete_vpn_connection_prop: 'vpn_connection_id', read_only: false, modify_vpn_connection_prop: 'vpn_connection_id', array: false, hash: false, describe_vpn_connections_prop: 'vpn_connection_ids', default: Proc.new { self.name }
  • #vpn_gateway ⇒ [MintPress::Aws::EC2::VpnGateway]
    'The ID of the virtual private gateway at the AWS side of the VPN connection.'
    Property Attributes
    • source ⇒ "modify_vpn_connection"
    • orig_name ⇒ 'vpn_gateway_id'
    • create_vpn_connection_prop ⇒ 'vpn_gateway_id'
    • read_only ⇒ false
    • modify_vpn_connection_prop ⇒ 'vpn_gateway_id'
    • from ⇒ String
    

79
80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 79

property :vpn_gateway, description: 'The ID of the virtual private gateway at the AWS side of the VPN
connection.', source: "modify_vpn_connection", orig_name: 'vpn_gateway_id', type: [MintPress::Aws::EC2::VpnGateway], create_vpn_connection_prop: 'vpn_gateway_id', read_only: false, modify_vpn_connection_prop: 'vpn_gateway_id', from: String
  • #name ⇒ String

    Property Attributes 
    

81
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 81

property :name, type: String
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

85
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 85

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

88
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_connection.rb', line 88

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ VpnConnection

Returns a new instance of VpnConnection.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object