Class: MintPress::Aws::EC2::InstanceStatus

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

Properties (Read/Write)

  • #availability_zone ⇒ [String]
    'The Availability Zone of the instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::InstanceStatus"
    • orig_name ⇒ 'availability_zone'
    

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

property :availability_zone, disposition: :attribute, description: 'The Availability Zone of the instance.', source: "MintPress::Aws::EC2::InstanceStatus", orig_name: 'availability_zone', type: [String]
  • #events ⇒ Array of ⇒ [MintPress::Aws::EC2::InstanceStatusEvent]
    'Any scheduled events associated with the instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::InstanceStatus"
    • orig_name ⇒ 'events'
    

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

property :events, disposition: :attribute, description: 'Any scheduled events associated with the instance.', source: "MintPress::Aws::EC2::InstanceStatus", orig_name: 'events', type: [MintPress::Aws::EC2::InstanceStatusEvent], array: true
  • #instance_state ⇒ [MintPress::Aws::EC2::InstanceState] (Default Value: MintPress::Aws::EC2::InstanceState.new)
    'The intended state of the instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::InstanceStatus"
    • orig_name ⇒ 'instance_state'
    • default ⇒ MintPress::Aws::EC2::InstanceState.new
    

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

property :instance_state, disposition: :attribute, description: 'The intended state of the instance.', source: "MintPress::Aws::EC2::InstanceStatus", orig_name: 'instance_state', type: [MintPress::Aws::EC2::InstanceState], default: MintPress::Aws::EC2::InstanceState.new
  • #instance_status ⇒ [MintPress::Aws::EC2::InstanceStatusSummary] (Default Value: MintPress::Aws::EC2::InstanceStatusSummary.new)
    'Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::InstanceStatus"
    • orig_name ⇒ 'instance_status'
    • default ⇒ MintPress::Aws::EC2::InstanceStatusSummary.new
    

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

property :instance_status, disposition: :attribute, description: 'Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.', source: "MintPress::Aws::EC2::InstanceStatus", orig_name: 'instance_status', type: [MintPress::Aws::EC2::InstanceStatusSummary], default: MintPress::Aws::EC2::InstanceStatusSummary.new
  • #outpost_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the Outpost.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::InstanceStatus"
    • orig_name ⇒ 'outpost_arn'
    

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

property :outpost_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the Outpost.', source: "MintPress::Aws::EC2::InstanceStatus", orig_name: 'outpost_arn', type: [String]
  • #system_status ⇒ [MintPress::Aws::EC2::InstanceStatusSummary] (Default Value: MintPress::Aws::EC2::InstanceStatusSummary.new)
    'Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::InstanceStatus"
    • orig_name ⇒ 'system_status'
    • default ⇒ MintPress::Aws::EC2::InstanceStatusSummary.new
    

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

property :system_status, disposition: :attribute, description: 'Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.', source: "MintPress::Aws::EC2::InstanceStatus", orig_name: 'system_status', type: [MintPress::Aws::EC2::InstanceStatusSummary], default: MintPress::Aws::EC2::InstanceStatusSummary.new
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. availability-zone - The Availability Zone of the instance. event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop). event.description - A description of the event. event.instance-event-id - The ID of the event whose date and time you are modifying. event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z). instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data). instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data). system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).'
    Property Attributes
    • describe_instance_status_prop ⇒ 'filters'
    • source ⇒ "describe_instance_status"
    

28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_status.rb', line 28

property :filters, describe_instance_status_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_instance_status", description: 'The filters.


availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot
| system-reboot | system-maintenance | instance-retirement
| instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time
you are modifying.
event.not-after - The latest end time for the scheduled event (for
example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event
(for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event
(for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit
unsigned integer. The high byte is used for internal purposes and
should be ignored. The low byte is set based on the state
represented. The valid values are 0 (pending), 16 (running), 32
(shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending |
running | shutting-down | terminated | stopping |
stopped).
instance-status.reachability - Filters on instance status where
the name is reachability (passed | failed | initializing
| insufficient-data).
instance-status.status - The status of the instance (ok |
impaired | initializing | insufficient-data |
not-applicable).
system-status.reachability - Filters on system status where the
name is reachability (passed | failed | initializing |
insufficient-data).
system-status.status - The system status of the instance (ok |
impaired | initializing | insufficient-data |
not-applicable).', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
    Property Attributes
    • describe_instance_status_prop ⇒ 'max_results'
    • source ⇒ "describe_instance_status"
    

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

property :max_results, describe_instance_status_prop: 'max_results', type: [Integer], source: "describe_instance_status", description: 'The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.'
  • #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_instance_status_prop ⇒ 'dry_run'
    • source ⇒ "describe_instance_status"
    

68
69
70
71
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_status.rb', line 68

property :dry_run, describe_instance_status_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_instance_status", 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.'
  • #include_all_instances ⇒ [TrueClass,FalseClass]
    'When true, includes the health status for all instances. When false, includes the health status for running instances only. Default: false'
    Property Attributes
    • describe_instance_status_prop ⇒ 'include_all_instances'
    • source ⇒ "describe_instance_status"
    

72
73
74
75
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_status.rb', line 72

property :include_all_instances, describe_instance_status_prop: 'include_all_instances', type: [TrueClass,FalseClass], source: "describe_instance_status", description: 'When true, includes the health status for all instances. When
false, includes the health status for running instances only.

Default: false'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_instance_status"
    • orig_name ⇒ 'instance_id'
    • describe_instance_status_prop ⇒ 'instance_ids'
    • default ⇒ Proc.new { self.name }
    

76
77
78
79
80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_status.rb', line 76

property :id, disposition: :attribute, description: 'The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.', source: "describe_instance_status", orig_name: 'instance_id', type: [String], array: false, hash: false, describe_instance_status_prop: 'instance_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of InstanceStatus.

Instance Method Details

#describe ⇒ Object