Class: MintPress::Aws::EC2::VolumeStatus

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

Properties (Read/Write)

  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. action.code - The action code for the event (for example, enable-volume-io). action.description - A description of the action. action.event-id - The event ID associated with the action. availability-zone - The Availability Zone of the instance. event.description - A description of the event. event.event-id - The event ID. event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled). event.not-after - The latest end time for the event. event.not-before - The earliest start time for the event. volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance). volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled). volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).'
    Property Attributes
    • describe_volume_status_prop ⇒ 'filters'
    • source ⇒ "describe_volume_status"
    

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

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


action.code - The action code for the event (for example,
enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed |
failed; for io-performance: io-performance:degraded |
io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status
(io-enabled | io-performance).
volume-status.details-status - The status of
volume-status.details-name (for io-enabled: passed |
failed; for io-performance: normal | degraded |
severely-degraded | stalled).
volume-status.status - The status of the volume (ok |
impaired | warning | insufficient-data).', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.'
    Property Attributes
    • describe_volume_status_prop ⇒ 'max_results'
    • source ⇒ "describe_volume_status"
    

41
42
43
44
45
46
47
48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume_status.rb', line 41

property :max_results, describe_volume_status_prop: 'max_results', type: [Integer], source: "describe_volume_status", description: 'The maximum number of volume results returned by
DescribeVolumeStatus in paginated output. When this parameter is
used, the request only returns MaxResults results in a single page
along with a NextToken response element. The remaining results of
the initial request can be seen by sending another request with the
returned NextToken value. This value can be between 5 and 1,000; if
MaxResults is given a value larger than 1,000, only 1,000 results
are returned. If this parameter is not used, then
DescribeVolumeStatus returns all results. You cannot specify this
parameter and the volume IDs parameter in the same request.'
  • #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_volume_status_prop ⇒ 'dry_run'
    • source ⇒ "describe_volume_status"
    

51
52
53
54
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volume_status.rb', line 51

property :dry_run, describe_volume_status_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_volume_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.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The IDs of the volumes. Default: Describes all your volumes.'
    Property Attributes
    • describe_volume_status_prop ⇒ 'volume_ids'
    • source ⇒ "describe_volume_status"
    • default ⇒ Proc.new { self.name }
    

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

property :id, describe_volume_status_prop: 'volume_ids', type: [String], array: false, source: "describe_volume_status", description: 'The IDs of the volumes.

Default: Describes all your volumes.', hash: false, default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of VolumeStatus.

Instance Method Details

#describe ⇒ Object