Class: MintPress::Aws::EC2::VolumesModification

Inherits:

Object

• Object
• MintPress::Aws::EC2::VolumesModification

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volumes_modification.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
  • describe_volumes_modifications_prop ⇒ 'dry_run'
  • source ⇒ "describe_volumes_modifications"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volumes_modification.rb', line 19
  
  property :dry_run, describe_volumes_modifications_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_volumes_modifications", 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.'

• #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
  'The filters. modification-state - The current modification state (modifying | optimizing | completed | failed). original-iops - The original IOPS rate of the volume. original-size - The original size of the volume, in GiB. original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1). originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false). start-time - The modification start time. target-iops - The target IOPS rate of the volume. target-size - The target size of the volume, in GiB. target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1). targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false). volume-id - The ID of the volume.'
  Property Attributes
  • describe_volumes_modifications_prop ⇒ 'filters'
  • source ⇒ "describe_volumes_modifications"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volumes_modification.rb', line 23
  
  property :filters, describe_volumes_modifications_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_volumes_modifications", description: 'The filters.
  
  
  modification-state - The current modification state (modifying |
  optimizing | completed | failed).
  original-iops - The original IOPS rate of the volume.
  original-size - The original size of the volume, in GiB.
  original-volume-type - The original volume type of the volume
  (standard | io1 | io2 | gp2 | sc1 | st1).
  originalMultiAttachEnabled - Indicates whether Multi-Attach
  support was enabled (true | false).
  start-time - The modification start time.
  target-iops - The target IOPS rate of the volume.
  target-size - The target size of the volume, in GiB.
  target-volume-type - The target volume type of the volume
  (standard | io1 | io2 | gp2 | sc1 | st1).
  targetMultiAttachEnabled - Indicates whether Multi-Attach support
  is to be enabled (true | false).
  volume-id - The ID of the volume.', hash: true

• #max_results ⇒ [Integer]
  'The maximum number of results (up to a limit of 500) to be returned in a paginated request.'
  Property Attributes
  • describe_volumes_modifications_prop ⇒ 'max_results'
  • source ⇒ "describe_volumes_modifications"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volumes_modification.rb', line 42
  
  property :max_results, describe_volumes_modifications_prop: 'max_results', type: [Integer], source: "describe_volumes_modifications", description: 'The maximum number of results (up to a limit of 500) to be returned in
  a paginated request.'

• #volumes ⇒ Hash of ⇒ [MintPress::Aws::EC2::Volume]
  'The IDs of the volumes.'
  Property Attributes
  • describe_volumes_modifications_prop ⇒ 'volume_ids'
  • source ⇒ "describe_volumes_modifications"
  • from ⇒ String

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volumes_modification.rb', line 44
  
  property :volumes, describe_volumes_modifications_prop: 'volume_ids', type: [MintPress::Aws::EC2::Volume], array: false, source: "describe_volumes_modifications", description: 'The IDs of the volumes.', from: String, hash: true

• #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

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volumes_modification.rb', line 48
  
  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

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/volumes_modification.rb', line 51
  
  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

• #describe ⇒ Object
• #initialize(opts = {}) ⇒ VolumesModification constructor
  A new instance of VolumesModification.

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

Returns a new instance of VolumesModification.

Instance Method Details

#describe ⇒ Object