Class: MintPress::Aws::EC2::VpnGateway

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

Properties (Read/Write)

  • #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
    • attach_vpn_gateway_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "detach_vpn_gateway"
    • create_vpn_gateway_prop ⇒ 'dry_run'
    • delete_vpn_gateway_prop ⇒ 'dry_run'
    • describe_vpn_gateways_prop ⇒ 'dry_run'
    • detach_vpn_gateway_prop ⇒ 'dry_run'
    

29
30
31
32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_gateway.rb', line 29

property :dry_run, attach_vpn_gateway_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "detach_vpn_gateway", 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.', create_vpn_gateway_prop: 'dry_run', delete_vpn_gateway_prop: 'dry_run', describe_vpn_gateways_prop: 'dry_run', detach_vpn_gateway_prop: 'dry_run'
  • #amazon_side_asn ⇒ [Integer]
    'The private Autonomous System Number (ASN) for the Amazon side of a BGP session.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnGateway"
    • orig_name ⇒ 'amazon_side_asn'
    • create_vpn_gateway_prop ⇒ 'amazon_side_asn'
    • read_only ⇒ false
    

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

property :amazon_side_asn, disposition: :attribute, description: 'The private Autonomous System Number (ASN) for the Amazon side of a BGP session.', source: "MintPress::Aws::EC2::VpnGateway", orig_name: 'amazon_side_asn', type: [Integer], create_vpn_gateway_prop: 'amazon_side_asn', read_only: false
  • #availability_zone ⇒ [String]
    'The Availability Zone where the virtual private gateway was created, if applicable.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnGateway"
    • orig_name ⇒ 'availability_zone'
    • create_vpn_gateway_prop ⇒ 'availability_zone'
    • read_only ⇒ false
    

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

property :availability_zone, disposition: :attribute, description: 'The Availability Zone where the virtual private gateway was created, if applicable.', source: "MintPress::Aws::EC2::VpnGateway", orig_name: 'availability_zone', type: [String], create_vpn_gateway_prop: 'availability_zone', read_only: false
  • #state ⇒ [String]
    'The current state of the virtual private gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnGateway"
    • orig_name ⇒ 'state'
    

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

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

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

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

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

property :type, disposition: :attribute, description: 'The type of VPN connection the virtual private gateway supports.', source: "MintPress::Aws::EC2::VpnGateway", orig_name: 'type', type: [String], create_vpn_gateway_prop: 'type', read_only: false
  • #vpc_attachments ⇒ Hash of ⇒ [MintPress::Aws::EC2::VpcAttachment]
    'Any VPCs attached to the virtual private gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::VpnGateway"
    • orig_name ⇒ 'vpc_attachments'
    

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

property :vpc_attachments, disposition: :attribute, description: 'Any VPCs attached to the virtual private gateway.', source: "MintPress::Aws::EC2::VpnGateway", orig_name: 'vpc_attachments', type: [MintPress::Aws::EC2::VpcAttachment], array: false, hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway. attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached). attachment.vpc-id - The ID of an attached VPC. availability-zone - The Availability Zone for the virtual private gateway (if applicable). state - The state of the virtual private gateway (pending | available | deleting | deleted). 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 virtual private gateway. Currently the only supported type is ipsec.1. vpn-gateway-id - The ID of the virtual private gateway.'
    Property Attributes
    • describe_vpn_gateways_prop ⇒ 'filters'
    • source ⇒ "describe_vpn_gateways"
    

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_gateway.rb', line 39

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


amazon-side-asn - The Autonomous System Number (ASN) for the
Amazon side of the gateway.
attachment.state - The current state of the attachment between the
gateway and the VPC (attaching | attached | detaching |
detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private
gateway (if applicable).
state - The state of the virtual private gateway (pending |
available | deleting | deleted).
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 virtual private gateway. Currently the only
supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.', hash: true
  • #vpc ⇒ [MintPress::Aws::EC2::Vpc]
    'The ID of the VPC.'
    Property Attributes
    • attach_vpn_gateway_prop ⇒ 'vpc_id'
    • read_only ⇒ false
    • source ⇒ "detach_vpn_gateway"
    • detach_vpn_gateway_prop ⇒ 'vpc_id'
    • from ⇒ String
    

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

property :vpc, attach_vpn_gateway_prop: 'vpc_id', type: [MintPress::Aws::EC2::Vpc], read_only: false, source: "detach_vpn_gateway", description: 'The ID of the VPC.', detach_vpn_gateway_prop: 'vpc_id', from: String
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'One or more virtual private gateway IDs. Default: Describes all your virtual private gateways.'
    Property Attributes
    • attach_vpn_gateway_prop ⇒ 'vpn_gateway_id'
    • read_only ⇒ false
    • source ⇒ "describe_vpn_gateways"
    • orig_name ⇒ 'vpn_gateway_id'
    • delete_vpn_gateway_prop ⇒ 'vpn_gateway_id'
    • detach_vpn_gateway_prop ⇒ 'vpn_gateway_id'
    • describe_vpn_gateways_prop ⇒ 'vpn_gateway_ids'
    • default ⇒ Proc.new { self.name }
    

64
65
66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpn_gateway.rb', line 64

property :id, attach_vpn_gateway_prop: 'vpn_gateway_id', type: [String], read_only: false, source: "describe_vpn_gateways", description: 'One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.', orig_name: 'vpn_gateway_id', delete_vpn_gateway_prop: 'vpn_gateway_id', detach_vpn_gateway_prop: 'vpn_gateway_id', array: false, hash: false, describe_vpn_gateways_prop: 'vpn_gateway_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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 = {}) ⇒ VpnGateway

Returns a new instance of VpnGateway.

Instance Method Details

#attach ⇒ Object

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#detach ⇒ Object