Class: MintPress::Aws::EC2::LocalGateway

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

Properties (Read/Write)

  • #outpost_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the Outpost.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::LocalGateway"
    • orig_name ⇒ 'outpost_arn'
    

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

property :outpost_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the Outpost.', source: "MintPress::Aws::EC2::LocalGateway", orig_name: 'outpost_arn', type: [String]
  • #state ⇒ [String]
    'The state of the local gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::LocalGateway"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the local gateway.', source: "MintPress::Aws::EC2::LocalGateway", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags assigned to the local gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::LocalGateway"
    • orig_name ⇒ 'tags'
    

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

property :tags, disposition: :attribute, description: 'The tags assigned to the local gateway.', source: "MintPress::Aws::EC2::LocalGateway", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters.'
    Property Attributes
    • describe_local_gateways_prop ⇒ 'filters'
    • source ⇒ "describe_local_gateways"
    

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

property :filters, describe_local_gateways_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_local_gateways", description: 'One or more filters.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
    Property Attributes
    • describe_local_gateways_prop ⇒ 'max_results'
    • source ⇒ "describe_local_gateways"
    

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

property :max_results, describe_local_gateways_prop: 'max_results', type: [Integer], source: "describe_local_gateways", description: 'The maximum number of results to return with a single call. To
retrieve the remaining results, make another call with the returned
nextToken value.'
  • #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
    • describe_local_gateways_prop ⇒ 'dry_run'
    • source ⇒ "describe_local_gateways"
    

26
27
28
29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/local_gateway.rb', line 26

property :dry_run, describe_local_gateways_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_local_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.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'One or more filters. local-gateway-id - The ID of a local gateway. local-gateway-route-table-id - The ID of the local gateway route table. local-gateway-route-table-virtual-interface-group-association-id - The ID of the association. local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group. outpost-arn - The Amazon Resource Name (ARN) of the Outpost. state - The state of the association.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_local_gateways"
    • orig_name ⇒ 'local_gateway_id'
    • describe_local_gateways_prop ⇒ 'local_gateway_ids'
    • default ⇒ Proc.new { self.name }
    

30
31
32
33
34
35
36
37
38
39
40
41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/local_gateway.rb', line 30

property :id, disposition: :attribute, description: 'One or more filters.


local-gateway-id - The ID of a local gateway.
local-gateway-route-table-id - The ID of the local gateway route
table.
local-gateway-route-table-virtual-interface-group-association-id -
The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of
the virtual interface group.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
state - The state of the association.', source: "describe_local_gateways", orig_name: 'local_gateway_id', type: [String], array: false, hash: false, describe_local_gateways_prop: 'local_gateway_ids', default: Proc.new { self.name }
  • #owner ⇒ [String]
    'The AWS account ID that owns the local gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::LocalGateway"
    • orig_name ⇒ 'owner_id'
    

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

property :owner, disposition: :attribute, description: 'The AWS account ID that owns the local gateway.', source: "MintPress::Aws::EC2::LocalGateway", orig_name: 'owner_id', type: [String]
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of LocalGateway.

Instance Method Details

#describe ⇒ Object