Class: MintPress::Aws::EC2::CustomerGateway

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

Properties (Read/Write)

  • #bgp_asn ⇒ [String]
    'The customer gateway"s Border Gateway Protocol (BGP) Autonomous System Number (ASN).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CustomerGateway"
    • orig_name ⇒ 'bgp_asn'
    • create_customer_gateway_prop ⇒ 'bgp_asn'
    • read_only ⇒ false
    

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

property :bgp_asn, disposition: :attribute, description: 'The customer gateway"s Border Gateway Protocol (BGP) Autonomous System Number (ASN).', source: "MintPress::Aws::EC2::CustomerGateway", orig_name: 'bgp_asn', type: [String], create_customer_gateway_prop: 'bgp_asn', read_only: false
  • #certificate_arn ⇒ [String]
    'The Amazon Resource Name (ARN) for the customer gateway certificate.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CustomerGateway"
    • orig_name ⇒ 'certificate_arn'
    • create_customer_gateway_prop ⇒ 'certificate_arn'
    • read_only ⇒ false
    

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

property :certificate_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) for the customer gateway certificate.', source: "MintPress::Aws::EC2::CustomerGateway", orig_name: 'certificate_arn', type: [String], create_customer_gateway_prop: 'certificate_arn', read_only: false
  • #device_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of customer gateway device.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CustomerGateway"
    • orig_name ⇒ 'device_name'
    • create_customer_gateway_prop ⇒ 'device_name'
    • read_only ⇒ false
    • default ⇒ Proc.new { self.name }
    

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

property :device_name, disposition: :attribute, description: 'The name of customer gateway device.', source: "MintPress::Aws::EC2::CustomerGateway", orig_name: 'device_name', type: [String], create_customer_gateway_prop: 'device_name', read_only: false, default: Proc.new { self.name }
  • #ip_address ⇒ [String]
    'The Internet-routable IP address of the customer gateway"s outside interface.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CustomerGateway"
    • orig_name ⇒ 'ip_address'
    

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

property :ip_address, disposition: :attribute, description: 'The Internet-routable IP address of the customer gateway"s outside interface.', source: "MintPress::Aws::EC2::CustomerGateway", orig_name: 'ip_address', type: [String]
  • #state ⇒ [String]
    'The current state of the customer gateway (pending | available | deleting | deleted).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CustomerGateway"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The current state of the customer gateway (pending | available | deleting | deleted).', source: "MintPress::Aws::EC2::CustomerGateway", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'Any tags assigned to the customer gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CustomerGateway"
    • orig_name ⇒ 'tags'
    • create_customer_gateway_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'Any tags assigned to the customer gateway.', source: "MintPress::Aws::EC2::CustomerGateway", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_customer_gateway_prop: 'tag_specifications', read_only: false, hash: true
  • #type ⇒ [String]
    'The type of VPN connection the customer gateway supports (ipsec.1).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CustomerGateway"
    • orig_name ⇒ 'type'
    • create_customer_gateway_prop ⇒ 'type'
    • read_only ⇒ false
    

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

property :type, disposition: :attribute, description: 'The type of VPN connection the customer gateway supports (ipsec.1).', source: "MintPress::Aws::EC2::CustomerGateway", orig_name: 'type', type: [String], create_customer_gateway_prop: 'type', read_only: false
  • #public_ip ⇒ [String]
    'The Internet-routable IP address for the customer gateway"s outside interface. The address must be static.'
    Property Attributes
    • create_customer_gateway_prop ⇒ 'public_ip'
    • read_only ⇒ false
    • source ⇒ "create_customer_gateway"
    

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

property :public_ip, create_customer_gateway_prop: 'public_ip', type: [String], read_only: false, source: "create_customer_gateway", description: 'The Internet-routable IP address for the customer gateway"s outside
interface. The address must be static.'
  • #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_customer_gateway_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "describe_customer_gateways"
    • delete_customer_gateway_prop ⇒ 'dry_run'
    • describe_customer_gateways_prop ⇒ 'dry_run'
    

32
33
34
35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/customer_gateway.rb', line 32

property :dry_run, create_customer_gateway_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "describe_customer_gateways", 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_customer_gateway_prop: 'dry_run', describe_customer_gateways_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. bgp-asn - The customer gateway"s Border Gateway Protocol (BGP) Autonomous System Number (ASN). customer-gateway-id - The ID of the customer gateway. ip-address - The IP address of the customer gateway"s Internet-routable external interface. state - The state of the customer gateway (pending | available | deleting | deleted). type - The type of customer gateway. Currently, the only supported type is ipsec.1. 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.'
    Property Attributes
    • describe_customer_gateways_prop ⇒ 'filters'
    • source ⇒ "describe_customer_gateways"
    

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/customer_gateway.rb', line 36

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


bgp-asn - The customer gateway"s Border Gateway Protocol (BGP)
Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway"s
Internet-routable external interface.
state - The state of the customer gateway (pending |
available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported
type is ipsec.1.
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.', hash: true
  • #id ⇒ [String]
    'One or more customer gateway IDs. Default: Describes all your customer gateways.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_customer_gateways"
    • orig_name ⇒ 'customer_gateway_id'
    • delete_customer_gateway_prop ⇒ 'customer_gateway_id'
    • read_only ⇒ false
    • describe_customer_gateways_prop ⇒ 'customer_gateway_ids'
    

56
57
58
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/customer_gateway.rb', line 56

property :id, disposition: :attribute, description: 'One or more customer gateway IDs.

Default: Describes all your customer gateways.', source: "describe_customer_gateways", orig_name: 'customer_gateway_id', type: [String], delete_customer_gateway_prop: 'customer_gateway_id', read_only: false, array: false, hash: false, describe_customer_gateways_prop: 'customer_gateway_ids'
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of CustomerGateway.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object