Class: MintPress::Aws::EC2::ReservedInstance

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

Properties (Read/Write)

  • #availability_zone ⇒ [String]
    'The Availability Zone in which the Reserved Instance can be used.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'availability_zone'
    

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

property :availability_zone, disposition: :attribute, description: 'The Availability Zone in which the Reserved Instance can be used.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'availability_zone', type: [String]
  • #currency_code ⇒ [String]
    'The currency of the Reserved Instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'currency_code'
    

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

property :currency_code, disposition: :attribute, description: 'The currency of the Reserved Instance.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'currency_code', type: [String]
  • #duration ⇒ [Integer]
    'The duration of the Reserved Instance, in seconds.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'duration'
    

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

property :duration, disposition: :attribute, description: 'The duration of the Reserved Instance, in seconds.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'duration', type: [Integer]
  • #end ⇒ [Time]
    'The time when the Reserved Instance expires.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'end'
    

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

property :end, disposition: :attribute, description: 'The time when the Reserved Instance expires.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'end', type: [Time]
  • #fixed_price ⇒ [Float]
    'The purchase price of the Reserved Instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'fixed_price'
    

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

property :fixed_price, disposition: :attribute, description: 'The purchase price of the Reserved Instance.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'fixed_price', type: [Float]
  • #instance_count ⇒ [Integer]
    'The number of reservations purchased.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'instance_count'
    

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

property :instance_count, disposition: :attribute, description: 'The number of reservations purchased.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'instance_count', type: [Integer]
  • #instance_tenancy ⇒ [String]
    'The tenancy of the instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'instance_tenancy'
    

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

property :instance_tenancy, disposition: :attribute, description: 'The tenancy of the instance.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'instance_tenancy', type: [String]
  • #instance_type ⇒ [String]
    'The instance type on which the Reserved Instance can be used.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'instance_type'
    

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

property :instance_type, disposition: :attribute, description: 'The instance type on which the Reserved Instance can be used.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'instance_type', type: [String]
  • #offering_class ⇒ [String]
    'Describes whether the Reserved Instance is Standard or Convertible.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_reserved_instances"
    • orig_name ⇒ 'offering_class'
    • describe_reserved_instances_prop ⇒ 'offering_class'
    

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

property :offering_class, disposition: :attribute, description: 'Describes whether the Reserved Instance is Standard or Convertible.', source: "describe_reserved_instances", orig_name: 'offering_class', type: [String], describe_reserved_instances_prop: 'offering_class'
  • #offering_type ⇒ [String]
    'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_reserved_instances"
    • orig_name ⇒ 'offering_type'
    • describe_reserved_instances_prop ⇒ 'offering_type'
    

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

property :offering_type, disposition: :attribute, description: 'The Reserved Instance offering type. If you are using tools that
predate the 2011-11-01 API version, you only have access to the
Medium Utilization Reserved Instance offering type.', source: "describe_reserved_instances", orig_name: 'offering_type', type: [String], describe_reserved_instances_prop: 'offering_type'
  • #product_description ⇒ [String]
    'The Reserved Instance product platform description.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'product_description'
    

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

property :product_description, disposition: :attribute, description: 'The Reserved Instance product platform description.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'product_description', type: [String]
  • #recurring_charges ⇒ Array of ⇒ [MintPress::Aws::EC2::RecurringCharge]
    'The recurring charge tag assigned to the resource.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'recurring_charges'
    

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

property :recurring_charges, disposition: :attribute, description: 'The recurring charge tag assigned to the resource.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'recurring_charges', type: [MintPress::Aws::EC2::RecurringCharge], array: true
  • #scope ⇒ [String]
    'The scope of the Reserved Instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'scope'
    

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

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

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

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

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

property :state, disposition: :attribute, description: 'The state of the Reserved Instance purchase.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'Any tags assigned to the resource.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'tags'
    

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

property :tags, disposition: :attribute, description: 'Any tags assigned to the resource.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, hash: true
  • #usage_price ⇒ [Float]
    'The usage price of the Reserved Instance, per hour.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ReservedInstance"
    • orig_name ⇒ 'usage_price'
    

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

property :usage_price, disposition: :attribute, description: 'The usage price of the Reserved Instance, per hour.', source: "MintPress::Aws::EC2::ReservedInstance", orig_name: 'usage_price', type: [Float]
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000). end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z). fixed-price - The purchase price of the Reserved Instance (for example, 9800.0). instance-type - The instance type that is covered by the reservation. scope - The scope of the Reserved Instance (Region or Availability Zone). product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)). reserved-instances-id - The ID of the Reserved Instance. start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). state - The state of the Reserved Instance (payment-pending | active | payment-failed | 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. usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).'
    Property Attributes
    • describe_reserved_instances_prop ⇒ 'filters'
    • source ⇒ "describe_reserved_instances"
    

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/reserved_instance.rb', line 42

property :filters, describe_reserved_instances_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_reserved_instances", description: 'One or more filters.


availability-zone - The Availability Zone where the Reserved
Instance can be used.
duration - The duration of the Reserved Instance (one year or
three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example,
2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for
example, 9800.0).
instance-type - The instance type that is covered by the
reservation.
scope - The scope of the Reserved Instance (Region or
Availability Zone).
product-description - The Reserved Instance product platform
description. Instances that include (Amazon VPC) in the product
platform description will only be displayed to EC2-Classic account
holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX
(Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red
Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) |
Windows | Windows (Amazon VPC) | Windows with SQL Server
Standard | Windows with SQL Server Standard (Amazon VPC) |
Windows with SQL Server Web | Windows with SQL Server Web
(Amazon VPC) | Windows with SQL Server Enterprise | Windows
with SQL Server Enterprise (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request
was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending |
active | payment-failed | 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.
usage-price - The usage price of the Reserved Instance, per hour
(for example, 0.84).', hash: true
  • #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_reserved_instances_prop ⇒ 'dry_run'
    • source ⇒ "describe_reserved_instances"
    

83
84
85
86
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/reserved_instance.rb', line 83

property :dry_run, describe_reserved_instances_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_reserved_instances", 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.'
  • #client_token ⇒ [String]
    'A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
    Property Attributes
    • modify_reserved_instances_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "modify_reserved_instances"
    

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

property :client_token, modify_reserved_instances_prop: 'client_token', type: [String], read_only: false, source: "modify_reserved_instances", description: 'A unique, case-sensitive token you provide to ensure idempotency of
your modification request. For more information, see Ensuring
Idempotency.'
  • #target_configurations ⇒ Array of ⇒ [MintPress::Aws::EC2::ReservedInstancesConfiguration]
    'The configuration settings for the Reserved Instances to modify.'
    Property Attributes
    • modify_reserved_instances_prop ⇒ 'target_configurations'
    • read_only ⇒ false
    • source ⇒ "modify_reserved_instances"
    

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

property :target_configurations, modify_reserved_instances_prop: 'target_configurations', type: [MintPress::Aws::EC2::ReservedInstancesConfiguration], array: true, read_only: false, source: "modify_reserved_instances", description: 'The configuration settings for the Reserved Instances to modify.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The IDs of the Reserved Instances to modify.'
    Property Attributes
    • source ⇒ "modify_reserved_instances"
    • orig_name ⇒ 'reserved_instances_id'
    • describe_reserved_instances_prop ⇒ 'reserved_instances_ids'
    • modify_reserved_instances_prop ⇒ 'reserved_instances_ids'
    • read_only ⇒ false
    • default ⇒ Proc.new { self.name }
    

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

property :id, description: 'The IDs of the Reserved Instances to modify.', source: "modify_reserved_instances", orig_name: 'reserved_instances_id', type: [String], array: false, hash: false, describe_reserved_instances_prop: 'reserved_instances_ids', modify_reserved_instances_prop: 'reserved_instances_ids', read_only: false, default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of ReservedInstance.

Instance Method Details

#describe ⇒ Object

#modify ⇒ Object