Class: MintPress::Aws::EC2::HostReservation

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

Properties (Read/Write)

  • #count ⇒ [Integer]
    'The number of Dedicated Hosts the reservation is associated with.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'count'
    

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

property :count, disposition: :attribute, description: 'The number of Dedicated Hosts the reservation is associated with.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'count', type: [Integer]
  • #currency_code ⇒ [String]
    'The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
    Property Attributes
    • source ⇒ "purchase_host_reservation"
    • orig_name ⇒ 'currency_code'
    • purchase_host_reservation_prop ⇒ 'currency_code'
    • read_only ⇒ false
    

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

property :currency_code, description: 'The currency in which the totalUpfrontPrice, LimitPrice, and
totalHourlyPrice amounts are specified. At this time, the only
supported currency is USD.', source: "purchase_host_reservation", orig_name: 'currency_code', type: [String], purchase_host_reservation_prop: 'currency_code', read_only: false
  • #duration ⇒ [Integer]
    'The length of the reservation"s term, specified in seconds.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'duration'
    

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

property :duration, disposition: :attribute, description: 'The length of the reservation"s term, specified in seconds.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'duration', type: [Integer]
  • #end ⇒ [Time]
    'The date and time that the reservation ends.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'end'
    

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

property :end, disposition: :attribute, description: 'The date and time that the reservation ends.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'end', type: [Time]
  • #host_id_set ⇒ Array of ⇒ [String]
    'The IDs of the Dedicated Hosts with which the reservation will be associated.'
    Property Attributes
    • source ⇒ "purchase_host_reservation"
    • orig_name ⇒ 'host_id_set'
    • purchase_host_reservation_prop ⇒ 'host_id_set'
    • read_only ⇒ false
    

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

property :host_id_set, description: 'The IDs of the Dedicated Hosts with which the reservation will be
associated.', source: "purchase_host_reservation", orig_name: 'host_id_set', type: [String], array: true, purchase_host_reservation_prop: 'host_id_set', read_only: false
  • #hourly_price ⇒ [String]
    'The hourly price of the reservation.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'hourly_price'
    

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

property :hourly_price, disposition: :attribute, description: 'The hourly price of the reservation.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'hourly_price', type: [String]
  • #instance_family ⇒ [String]
    'The instance family of the Dedicated Host Reservation.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'instance_family'
    

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

property :instance_family, disposition: :attribute, description: 'The instance family of the Dedicated Host Reservation.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'instance_family', type: [String]
  • #payment_option ⇒ [String]
    'The payment option selected for this reservation.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'payment_option'
    

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

property :payment_option, disposition: :attribute, description: 'The payment option selected for this reservation.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'payment_option', type: [String]
  • #start ⇒ [Time]
    'The date and time that the reservation started.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'start'
    

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

property :start, disposition: :attribute, description: 'The date and time that the reservation started.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'start', type: [Time]
  • #state ⇒ [String]
    'The state of the reservation.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the reservation.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to apply to the Dedicated Host Reservation during purchase.'
    Property Attributes
    • source ⇒ "purchase_host_reservation"
    • orig_name ⇒ 'tags'
    • purchase_host_reservation_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, description: 'The tags to apply to the Dedicated Host Reservation during purchase.', source: "purchase_host_reservation", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, purchase_host_reservation_prop: 'tag_specifications', read_only: false, hash: true
  • #upfront_price ⇒ [String]
    'The upfront price of the reservation.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'upfront_price'
    

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

property :upfront_price, disposition: :attribute, description: 'The upfront price of the reservation.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'upfront_price', type: [String]
  • #filter ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. instance-family - The instance family (for example, m4). payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront). state - The state of the reservation (payment-pending | payment-failed | active | retired). 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.'
    Property Attributes
    • describe_host_reservations_prop ⇒ 'filter'
    • source ⇒ "describe_host_reservations"
    

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/host_reservation.rb', line 36

property :filter, describe_host_reservations_prop: 'filter', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_host_reservations", description: 'The filters.


instance-family - The instance family (for example, m4).
payment-option - The payment option (NoUpfront |
PartialUpfront | AllUpfront).
state - The state of the reservation (payment-pending |
payment-failed | active | retired).
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.', hash: true
  • #host_reservation_id_set ⇒ Array of ⇒ [String]
    'The host reservation IDs.'
    Property Attributes
    • describe_host_reservations_prop ⇒ 'host_reservation_id_set'
    • source ⇒ "describe_host_reservations"
    

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

property :host_reservation_id_set, describe_host_reservations_prop: 'host_reservation_id_set', type: [String], array: true, source: "describe_host_reservations", description: 'The host reservation IDs.'
  • #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_reservations_prop ⇒ 'max_results'
    • source ⇒ "describe_host_reservations"
    

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

property :max_results, describe_host_reservations_prop: 'max_results', type: [Integer], source: "describe_host_reservations", 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.'
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
    Property Attributes
    • purchase_host_reservation_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "purchase_host_reservation"
    

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

property :client_token, purchase_host_reservation_prop: 'client_token', type: [String], read_only: false, source: "purchase_host_reservation", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to Ensure
Idempotency.'
  • #limit_price ⇒ [String]
    'The specified limit is checked against the total upfront cost of the reservation (calculated as the offering"s upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.'
    Property Attributes
    • purchase_host_reservation_prop ⇒ 'limit_price'
    • read_only ⇒ false
    • source ⇒ "purchase_host_reservation"
    

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

property :limit_price, purchase_host_reservation_prop: 'limit_price', type: [String], read_only: false, source: "purchase_host_reservation", description: 'The specified limit is checked against the total upfront cost of the
reservation (calculated as the offering"s upfront cost multiplied by
the host count). If the total upfront cost is greater than the
specified price limit, the request fails. This is used to ensure that
the purchase does not exceed the expected upfront cost of the
purchase. At this time, the only supported currency is USD. For
example, to indicate a limit price of USD 100, specify 100.00.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The ID of the reservation that specifies the associated Dedicated Hosts.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::HostReservation"
    • orig_name ⇒ 'host_reservation_id'
    • default ⇒ Proc.new { self.name }
    

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

property :id, disposition: :attribute, description: 'The ID of the reservation that specifies the associated Dedicated Hosts.', source: "MintPress::Aws::EC2::HostReservation", orig_name: 'host_reservation_id', type: [String], array: false, hash: false, default: Proc.new { self.name }
  • #offering ⇒ [String]
    'The ID of the offering.'
    Property Attributes
    • source ⇒ "purchase_host_reservation"
    • orig_name ⇒ 'offering_id'
    • purchase_host_reservation_prop ⇒ 'offering_id'
    • read_only ⇒ false
    

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

property :offering, description: 'The ID of the offering.', source: "purchase_host_reservation", orig_name: 'offering_id', type: [String], purchase_host_reservation_prop: 'offering_id', read_only: false
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of HostReservation.

Instance Method Details

#describe ⇒ Object

#purchase ⇒ Object