Class: MintPress::Aws::EC2::ClassicLinkInstance

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

Properties (Read/Write)

  • #groups ⇒ Hash of ⇒ [MintPress::Aws::EC2::GroupIdentifier]
    'A list of security groups.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClassicLinkInstance"
    • orig_name ⇒ 'groups'
    

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

property :groups, disposition: :attribute, description: 'A list of security groups.', source: "MintPress::Aws::EC2::ClassicLinkInstance", orig_name: 'groups', type: [MintPress::Aws::EC2::GroupIdentifier], array: false, hash: true
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'Any tags assigned to the instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClassicLinkInstance"
    • orig_name ⇒ 'tags'
    

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

property :tags, disposition: :attribute, description: 'Any tags assigned to the instance.', source: "MintPress::Aws::EC2::ClassicLinkInstance", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. group-id - The ID of a VPC security group that"s associated with the instance. instance-id - The ID of the instance. 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. vpc-id - The ID of the VPC to which the instance is linked. vpc-id - The ID of the VPC that the instance is linked to.'
    Property Attributes
    • describe_classic_link_instances_prop ⇒ 'filters'
    • source ⇒ "describe_classic_link_instances"
    

23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/classic_link_instance.rb', line 23

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


group-id - The ID of a VPC security group that"s associated with
the instance.
instance-id - The ID of the instance.
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.
vpc-id - The ID of the VPC to which the instance is linked.

vpc-id - The ID of the VPC that the instance is linked to.', hash: 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
    • describe_classic_link_instances_prop ⇒ 'dry_run'
    • source ⇒ "describe_classic_link_instances"
    

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

property :dry_run, describe_classic_link_instances_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_classic_link_instances", 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.'
  • #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. Constraint: If the value is greater than 1000, we return only 1000 items.'
    Property Attributes
    • describe_classic_link_instances_prop ⇒ 'max_results'
    • source ⇒ "describe_classic_link_instances"
    

44
45
46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/classic_link_instance.rb', line 44

property :max_results, describe_classic_link_instances_prop: 'max_results', type: [Integer], source: "describe_classic_link_instances", 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.

Constraint: If the value is greater than 1000, we return only 1000
items.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'One or more instance IDs. Must be instances linked to a VPC through ClassicLink.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_classic_link_instances"
    • orig_name ⇒ 'instance_id'
    • describe_classic_link_instances_prop ⇒ 'instance_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, disposition: :attribute, description: 'One or more instance IDs. Must be instances linked to a VPC through
ClassicLink.', source: "describe_classic_link_instances", orig_name: 'instance_id', type: [String], array: false, hash: false, describe_classic_link_instances_prop: 'instance_ids', default: Proc.new { self.name }
  • #vpc ⇒ [MintPress::Aws::EC2::Vpc]
    'The ID of the VPC.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ClassicLinkInstance"
    • orig_name ⇒ 'vpc_id'
    • from ⇒ String
    

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

property :vpc, disposition: :attribute, description: 'The ID of the VPC.', source: "MintPress::Aws::EC2::ClassicLinkInstance", orig_name: 'vpc_id', type: [MintPress::Aws::EC2::Vpc], from: String
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of ClassicLinkInstance.

Instance Method Details

#describe ⇒ Object