Class: MintPress::Aws::EC2::ScheduledInstanceAvailability

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

Properties (Read/Write)

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

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

property :availability_zone, disposition: :attribute, description: 'The Availability Zone.', source: "MintPress::Aws::EC2::ScheduledInstanceAvailability", orig_name: 'availability_zone', type: [String]
  • #available_instance_count ⇒ [Integer]
    'The number of available instances.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstanceAvailability"
    • orig_name ⇒ 'available_instance_count'
    

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

property :available_instance_count, disposition: :attribute, description: 'The number of available instances.', source: "MintPress::Aws::EC2::ScheduledInstanceAvailability", orig_name: 'available_instance_count', type: [Integer]
  • #first_slot_start_time ⇒ [Time]
    'The time period for the first schedule to start.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstanceAvailability"
    • orig_name ⇒ 'first_slot_start_time'
    

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

property :first_slot_start_time, disposition: :attribute, description: 'The time period for the first schedule to start.', source: "MintPress::Aws::EC2::ScheduledInstanceAvailability", orig_name: 'first_slot_start_time', type: [Time]
  • #hourly_price ⇒ [String]
    'The hourly price for a single instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstanceAvailability"
    • orig_name ⇒ 'hourly_price'
    

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

property :hourly_price, disposition: :attribute, description: 'The hourly price for a single instance.', source: "MintPress::Aws::EC2::ScheduledInstanceAvailability", orig_name: 'hourly_price', type: [String]
  • #instance_type ⇒ [String]
    'The instance type.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstanceAvailability"
    • orig_name ⇒ 'instance_type'
    

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

property :instance_type, disposition: :attribute, description: 'The instance type.', source: "MintPress::Aws::EC2::ScheduledInstanceAvailability", orig_name: 'instance_type', type: [String]
  • #max_term_duration_in_days ⇒ [Integer]
    'The maximum term.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstanceAvailability"
    • orig_name ⇒ 'max_term_duration_in_days'
    

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

property :max_term_duration_in_days, disposition: :attribute, description: 'The maximum term.', source: "MintPress::Aws::EC2::ScheduledInstanceAvailability", orig_name: 'max_term_duration_in_days', type: [Integer]
  • #min_term_duration_in_days ⇒ [Integer]
    'The minimum term.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstanceAvailability"
    • orig_name ⇒ 'min_term_duration_in_days'
    

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

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

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

property :network_platform, disposition: :attribute, description: 'The network platform (EC2-Classic or EC2-VPC).', source: "MintPress::Aws::EC2::ScheduledInstanceAvailability", orig_name: 'network_platform', 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
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstanceAvailability"
    • orig_name ⇒ 'platform'
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

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

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new
  • #purchase_token ⇒ [String]
    'The purchase token.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ScheduledInstanceAvailability"
    • orig_name ⇒ 'purchase_token'
    

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

property :purchase_token, disposition: :attribute, description: 'The purchase token.', source: "MintPress::Aws::EC2::ScheduledInstanceAvailability", orig_name: 'purchase_token', type: [String]
  • #recurrence ⇒ [MintPress::Aws::EC2::ScheduledInstanceRecurrence] (Default Value: MintPress::Aws::EC2::ScheduledInstanceRecurrence.new)
    'The schedule recurrence.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_scheduled_instance_availability"
    • orig_name ⇒ 'recurrence'
    • default ⇒ MintPress::Aws::EC2::ScheduledInstanceRecurrence.new
    • describe_scheduled_instance_availability_prop ⇒ 'recurrence'
    

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

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

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

property :slot_duration_in_hours, disposition: :attribute, description: 'The number of hours in the schedule.', source: "MintPress::Aws::EC2::ScheduledInstanceAvailability", orig_name: 'slot_duration_in_hours', type: [Integer]
  • #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::ScheduledInstanceAvailability"
    • orig_name ⇒ 'total_scheduled_instance_hours'
    

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

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::ScheduledInstanceAvailability", 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_instance_availability_prop ⇒ 'dry_run'
    • source ⇒ "describe_scheduled_instance_availability"
    

33
34
35
36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/scheduled_instance_availability.rb', line 33

property :dry_run, describe_scheduled_instance_availability_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_scheduled_instance_availability", 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. 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_instance_availability_prop ⇒ 'filters'
    • source ⇒ "describe_scheduled_instance_availability"
    

37
38
39
40
41
42
43
44
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/scheduled_instance_availability.rb', line 37

property :filters, describe_scheduled_instance_availability_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_scheduled_instance_availability", 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
  • #first_slot_start_time_range ⇒ [MintPress::Aws::EC2::SlotDateTimeRange] (Default Value: MintPress::Aws::EC2::SlotDateTimeRange.new)
    'The time period for the first schedule to start.'
    Property Attributes
    • describe_scheduled_instance_availability_prop ⇒ 'first_slot_start_time_range'
    • default ⇒ MintPress::Aws::EC2::SlotDateTimeRange.new
    • source ⇒ "describe_scheduled_instance_availability"
    

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

property :first_slot_start_time_range, describe_scheduled_instance_availability_prop: 'first_slot_start_time_range', type: [MintPress::Aws::EC2::SlotDateTimeRange], default: MintPress::Aws::EC2::SlotDateTimeRange.new, source: "describe_scheduled_instance_availability", description: 'The time period for the first schedule to start.'
  • #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 300. To retrieve the remaining results, make another call with the returned NextToken value.'
    Property Attributes
    • describe_scheduled_instance_availability_prop ⇒ 'max_results'
    • source ⇒ "describe_scheduled_instance_availability"
    

47
48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/scheduled_instance_availability.rb', line 47

property :max_results, describe_scheduled_instance_availability_prop: 'max_results', type: [Integer], source: "describe_scheduled_instance_availability", description: 'The maximum number of results to return in a single call. This value
can be between 5 and 300. The default value is 300. To retrieve the
remaining results, make another call with the returned NextToken
value.'
  • #max_slot_duration_in_hours ⇒ [Integer]
    'The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.'
    Property Attributes
    • describe_scheduled_instance_availability_prop ⇒ 'max_slot_duration_in_hours'
    • source ⇒ "describe_scheduled_instance_availability"
    

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

property :max_slot_duration_in_hours, describe_scheduled_instance_availability_prop: 'max_slot_duration_in_hours', type: [Integer], source: "describe_scheduled_instance_availability", description: 'The maximum available duration, in hours. This value must be greater
than MinSlotDurationInHours and less than 1,720.'
  • #min_slot_duration_in_hours ⇒ [Integer]
    'The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.'
    Property Attributes
    • describe_scheduled_instance_availability_prop ⇒ 'min_slot_duration_in_hours'
    • source ⇒ "describe_scheduled_instance_availability"
    

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

property :min_slot_duration_in_hours, describe_scheduled_instance_availability_prop: 'min_slot_duration_in_hours', type: [Integer], source: "describe_scheduled_instance_availability", description: 'The minimum available duration, in hours. The minimum required
duration is 1,200 hours per year. For example, the minimum daily
schedule is 4 hours, the minimum weekly schedule is 24 hours, and the
minimum monthly schedule is 100 hours.'
  • #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 
    

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

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

Returns a new instance of ScheduledInstanceAvailability.

Instance Method Details

#describe ⇒ Object