Class: MintPress::Aws::EC2::HostReservationOffering

Inherits:

Object

• Object
• MintPress::Aws::EC2::HostReservationOffering

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host_reservation_offering.rb

Properties (Read/Write)

• #filter ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
  'The filters. instance-family - The instance family of the offering (for example, m4). payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).'
  Property Attributes
  • describe_host_reservation_offerings_prop ⇒ 'filter'
  • source ⇒ "describe_host_reservation_offerings"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host_reservation_offering.rb', line 18
  
  property :filter, describe_host_reservation_offerings_prop: 'filter', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_host_reservation_offerings", description: 'The filters.
  
  
  instance-family - The instance family of the offering (for
  example, m4).
  payment-option - The payment option (NoUpfront |
  PartialUpfront | AllUpfront).', hash: true

• #max_duration ⇒ [Integer]
  'This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.'
  Property Attributes
  • describe_host_reservation_offerings_prop ⇒ 'max_duration'
  • source ⇒ "describe_host_reservation_offerings"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host_reservation_offering.rb', line 25
  
  property :max_duration, describe_host_reservation_offerings_prop: 'max_duration', type: [Integer], source: "describe_host_reservation_offerings", description: 'This is the maximum duration of the reservation to purchase, specified
  in seconds. Reservations are available in one-year and three-year
  terms. The number of seconds specified must be the number of seconds
  in a year (365x24x60x60) times one of the supported durations (1 or
  3). For example, specify 94608000 for three years.'

• #max_results ⇒ [Integer]
  'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
  Property Attributes
  • describe_host_reservation_offerings_prop ⇒ 'max_results'
  • source ⇒ "describe_host_reservation_offerings"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host_reservation_offering.rb', line 30
  
  property :max_results, describe_host_reservation_offerings_prop: 'max_results', type: [Integer], source: "describe_host_reservation_offerings", description: 'The maximum number of results to return for the request in a single
  page. The remaining results can be seen by sending another request
  with the returned nextToken value. This value can be between 5 and
  500. If maxResults is given a larger value than 500, you receive an
  error.'

• #min_duration ⇒ [Integer]
  'This is the minimum duration of the reservation you"d like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.'
  Property Attributes
  • describe_host_reservation_offerings_prop ⇒ 'min_duration'
  • source ⇒ "describe_host_reservation_offerings"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host_reservation_offering.rb', line 35
  
  property :min_duration, describe_host_reservation_offerings_prop: 'min_duration', type: [Integer], source: "describe_host_reservation_offerings", description: 'This is the minimum duration of the reservation you"d like to
  purchase, specified in seconds. Reservations are available in one-year
  and three-year terms. The number of seconds specified must be the
  number of seconds in a year (365x24x60x60) times one of the supported
  durations (1 or 3). For example, specify 31536000 for one year.'

• #id ⇒ [String] (Default Value: Proc.new { self.name })
  'The ID of the reservation offering.'
  Property Attributes
  • describe_host_reservation_offerings_prop ⇒ 'offering_id'
  • source ⇒ "describe_host_reservation_offerings"
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host_reservation_offering.rb', line 40
  
  property :id, describe_host_reservation_offerings_prop: 'offering_id', type: [String], source: "describe_host_reservation_offerings", description: 'The ID of the reservation offering.', array: false, hash: false, default: Proc.new { self.name }

• #name ⇒ String
  
  Property Attributes

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

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host_reservation_offering.rb', line 45
  
  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/host_reservation_offering.rb', line 48
  
  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 = {}) ⇒ HostReservationOffering constructor
  A new instance of HostReservationOffering.

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

Returns a new instance of HostReservationOffering.

Instance Method Details

#describe ⇒ Object