Class: MintPress::Aws::EC2::ScheduledInstance

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

Properties (Read/Write)

  • #availability_zone ⇒ [String]
    'The Availability Zone.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'availability_zone'
    

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

property :availability_zone, disposition: :attribute, description: 'The Availability Zone.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'availability_zone', type: [String]
  • #create_date ⇒ [Time]
    'The date when the Scheduled Instance was purchased.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'create_date'
    

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

property :create_date, disposition: :attribute, description: 'The date when the Scheduled Instance was purchased.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'create_date', type: [Time]
  • #hourly_price ⇒ [String]
    'The hourly price for a single instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'hourly_price'
    

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

property :hourly_price, disposition: :attribute, description: 'The hourly price for a single instance.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'hourly_price', type: [String]
  • #instance_count ⇒ [Integer]
    'The number of instances.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'instance_count'
    

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

property :instance_count, disposition: :attribute, description: 'The number of instances.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'instance_count', type: [Integer]
  • #instance_type ⇒ [String]
    'The instance type.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'instance_type'
    

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

property :instance_type, disposition: :attribute, description: 'The instance type.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'instance_type', type: [String]
  • #network_platform ⇒ [String]
    'The network platform (EC2-Classic or EC2-VPC).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'network_platform'
    

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

property :network_platform, disposition: :attribute, description: 'The network platform (EC2-Classic or EC2-VPC).', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'network_platform', type: [String]
  • #next_slot_start_time ⇒ [Time]
    'The time for the next schedule to start.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'next_slot_start_time'
    

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

property :next_slot_start_time, disposition: :attribute, description: 'The time for the next schedule to start.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'next_slot_start_time', type: [Time]
  • #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
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'platform'
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

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

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new
  • #previous_slot_end_time ⇒ [Time]
    'The time that the previous schedule ended or will end.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'previous_slot_end_time'
    

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

property :previous_slot_end_time, disposition: :attribute, description: 'The time that the previous schedule ended or will end.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'previous_slot_end_time', type: [Time]
  • #recurrence ⇒ [MintPress::Aws::EC2::ScheduledInstanceRecurrence] (Default Value: MintPress::Aws::EC2::ScheduledInstanceRecurrence.new)
    'The schedule recurrence.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'recurrence'
    • default ⇒ MintPress::Aws::EC2::ScheduledInstanceRecurrence.new
    

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

property :recurrence, disposition: :attribute, description: 'The schedule recurrence.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'recurrence', type: [MintPress::Aws::EC2::ScheduledInstanceRecurrence], default: MintPress::Aws::EC2::ScheduledInstanceRecurrence.new
  • #slot_duration_in_hours ⇒ [Integer]
    'The number of hours in the schedule.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'slot_duration_in_hours'
    

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

property :slot_duration_in_hours, disposition: :attribute, description: 'The number of hours in the schedule.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'slot_duration_in_hours', type: [Integer]
  • #term_end_date ⇒ [Time]
    'The end date for the Scheduled Instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'term_end_date'
    

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

property :term_end_date, disposition: :attribute, description: 'The end date for the Scheduled Instance.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'term_end_date', type: [Time]
  • #term_start_date ⇒ [Time]
    'The start date for the Scheduled Instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'term_start_date'
    

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

property :term_start_date, disposition: :attribute, description: 'The start date for the Scheduled Instance.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'term_start_date', type: [Time]
  • #total_scheduled_instance_hours ⇒ [Integer]
    'The total number of hours for a single instance for the entire term.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstance"
    • orig_name ⇒ 'total_scheduled_instance_hours'
    

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

property :total_scheduled_instance_hours, disposition: :attribute, description: 'The total number of hours for a single instance for the entire term.', source: "MintPress::Aws::EC2::ScheduledInstance", orig_name: 'total_scheduled_instance_hours', type: [Integer]
  • #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_scheduled_instances_prop ⇒ 'dry_run'
    • source ⇒ "purchase_scheduled_instances"
    • purchase_scheduled_instances_prop ⇒ 'dry_run'
    • read_only ⇒ false
    

37
38
39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/scheduled_instance.rb', line 37

property :dry_run, describe_scheduled_instances_prop: 'dry_run', type: [TrueClass,FalseClass], source: "purchase_scheduled_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.', purchase_scheduled_instances_prop: 'dry_run', read_only: false
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. availability-zone - The Availability Zone (for example, us-west-2a). instance-type - The instance type (for example, c4.large). network-platform - The network platform (EC2-Classic or EC2-VPC). platform - The platform (Linux/UNIX or Windows).'
    Property Attributes
    • describe_scheduled_instances_prop ⇒ 'filters'
    • source ⇒ "describe_scheduled_instances"
    

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

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


availability-zone - The Availability Zone (for example,
us-west-2a).
instance-type - The instance type (for example, c4.large).
network-platform - The network platform (EC2-Classic or
EC2-VPC).
platform - The platform (Linux/UNIX or Windows).', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.'
    Property Attributes
    • describe_scheduled_instances_prop ⇒ 'max_results'
    • source ⇒ "describe_scheduled_instances"
    

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

property :max_results, describe_scheduled_instances_prop: 'max_results', type: [Integer], source: "describe_scheduled_instances", description: 'The maximum number of results to return in a single call. This value
can be between 5 and 300. The default value is 100. To retrieve the
remaining results, make another call with the returned NextToken
value.'
  • #slot_start_time_range ⇒ [MintPress::Aws::EC2::SlotStartTimeRange] (Default Value: MintPress::Aws::EC2::SlotStartTimeRange.new)
    'The time period for the first schedule to start.'
    Property Attributes
    • describe_scheduled_instances_prop ⇒ 'slot_start_time_range'
    • default ⇒ MintPress::Aws::EC2::SlotStartTimeRange.new
    • source ⇒ "describe_scheduled_instances"
    

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

property :slot_start_time_range, describe_scheduled_instances_prop: 'slot_start_time_range', type: [MintPress::Aws::EC2::SlotStartTimeRange], default: MintPress::Aws::EC2::SlotStartTimeRange.new, source: "describe_scheduled_instances", description: 'The time period for the first schedule to start.'
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency. A suitable default value is auto-generated. You should normally not need to pass this option.**'
    Property Attributes
    • purchase_scheduled_instances_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "purchase_scheduled_instances"
    

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

property :client_token, purchase_scheduled_instances_prop: 'client_token', type: [String], read_only: false, source: "purchase_scheduled_instances", description: 'Unique, case-sensitive identifier that ensures the idempotency of the
request. For more information, see Ensuring Idempotency.

A suitable default value is auto-generated. You should normally
not need to pass this option.**'
  • #purchase_requests ⇒ Array of ⇒ [MintPress::Aws::EC2::Purchase]
    'The purchase requests.'
    Property Attributes
    • purchase_scheduled_instances_prop ⇒ 'purchase_requests'
    • read_only ⇒ false
    • source ⇒ "purchase_scheduled_instances"
    

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

property :purchase_requests, purchase_scheduled_instances_prop: 'purchase_requests', type: [MintPress::Aws::EC2::Purchase], array: true, read_only: false, source: "purchase_scheduled_instances", description: 'The purchase requests.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The Scheduled Instance IDs.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_scheduled_instances"
    • orig_name ⇒ 'scheduled_instance_id'
    • describe_scheduled_instances_prop ⇒ 'scheduled_instance_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, disposition: :attribute, description: 'The Scheduled Instance IDs.', source: "describe_scheduled_instances", orig_name: 'scheduled_instance_id', type: [String], array: false, hash: false, describe_scheduled_instances_prop: 'scheduled_instance_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

property :region, type: String

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

Returns a new instance of ScheduledInstance.

Instance Method Details

#describe ⇒ Object

#purchase ⇒ Object