Class: MintPress::Aws::EC2::InternetGateway

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/internet_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_internet_gateway_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_internet_gateway"
    • create_internet_gateway_prop ⇒ 'dry_run'
    • delete_internet_gateway_prop ⇒ 'dry_run'
    • describe_internet_gateways_prop ⇒ 'dry_run'
    • detach_internet_gateway_prop ⇒ 'dry_run'
    

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

property :dry_run, attach_internet_gateway_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_internet_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_internet_gateway_prop: 'dry_run', delete_internet_gateway_prop: 'dry_run', describe_internet_gateways_prop: 'dry_run', detach_internet_gateway_prop: 'dry_run'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to assign to the internet gateway.'
    Property Attributes
    • source ⇒ "create_internet_gateway"
    • orig_name ⇒ 'tags'
    • create_internet_gateway_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, description: 'The tags to assign to the internet gateway.', source: "create_internet_gateway", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_internet_gateway_prop: 'tag_specifications', read_only: false, hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached. attachment.vpc-id - The ID of an attached VPC. internet-gateway-id - The ID of the Internet gateway. owner-id - The ID of the AWS account that owns the internet gateway. 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_internet_gateways_prop ⇒ 'filters'
    • source ⇒ "describe_internet_gateways"
    

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

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


attachment.state - The current state of the attachment between the
gateway and the VPC (available). Present only if a VPC is
attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the AWS account that owns the internet
gateway.
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
  • #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_internet_gateways_prop ⇒ 'max_results'
    • source ⇒ "describe_internet_gateways"
    

54
55
56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/internet_gateway.rb', line 54

property :max_results, describe_internet_gateways_prop: 'max_results', type: [Integer], source: "describe_internet_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.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'One or more internet gateway IDs. Default: Describes all your internet gateways.'
    Property Attributes
    • read_only ⇒ false
    • source ⇒ "describe_internet_gateways"
    • orig_name ⇒ 'internet_gateway_id'
    • attach_internet_gateway_prop ⇒ 'internet_gateway_id'
    • delete_internet_gateway_prop ⇒ 'internet_gateway_id'
    • detach_internet_gateway_prop ⇒ 'internet_gateway_id'
    • describe_internet_gateways_prop ⇒ 'internet_gateway_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, read_only: false, description: 'One or more internet gateway IDs.

Default: Describes all your internet gateways.', source: "describe_internet_gateways", orig_name: 'internet_gateway_id', type: [String], attach_internet_gateway_prop: 'internet_gateway_id', delete_internet_gateway_prop: 'internet_gateway_id', detach_internet_gateway_prop: 'internet_gateway_id', array: false, hash: false, describe_internet_gateways_prop: 'internet_gateway_ids', default: Proc.new { self.name }
  • #vpc ⇒ [MintPress::Aws::EC2::Vpc]
    'The ID of the VPC.'
    Property Attributes
    • attach_internet_gateway_prop ⇒ 'vpc_id'
    • read_only ⇒ false
    • source ⇒ "detach_internet_gateway"
    • detach_internet_gateway_prop ⇒ 'vpc_id'
    • from ⇒ String
    

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

property :vpc, attach_internet_gateway_prop: 'vpc_id', type: [MintPress::Aws::EC2::Vpc], read_only: false, source: "detach_internet_gateway", description: 'The ID of the VPC.', detach_internet_gateway_prop: 'vpc_id', from: String
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Properties (Read Only)

  • #attachments ⇒ Array of ⇒ [MintPress::Aws::EC2::InternetGatewayAttachment]
    'Any VPCs attached to the internet gateway.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "InternetGateway"
    • orig_name ⇒ 'attachments'
    • read_only ⇒ true
    

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

property :attachments, disposition: :read_only_attribute, description: 'Any VPCs attached to the internet gateway.', source: "InternetGateway", orig_name: 'attachments', type: [MintPress::Aws::EC2::InternetGatewayAttachment], array: true, read_only: true
  • #owner ⇒ [String]
    'The ID of the AWS account that owns the internet gateway.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "InternetGateway"
    • orig_name ⇒ 'owner_id'
    • read_only ⇒ true
    

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

property :owner, disposition: :read_only_attribute, description: 'The ID of the AWS account that owns the internet gateway.', source: "InternetGateway", orig_name: 'owner_id', type: [String], read_only: true

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

Returns a new instance of InternetGateway.

Instance Method Details

#attach ⇒ Object

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#detach ⇒ Object