You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::ScheduledInstanceRecurrenceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ScheduledInstanceRecurrenceRequest data as a hash:

{
  frequency: "String",
  interval: 1,
  occurrence_days: [1],
  occurrence_relative_to_end: false,
  occurrence_unit: "String",
}

Describes the recurring schedule for a Scheduled Instance.

Instance Attribute Summary collapse

Instance Attribute Details

#frequencyString

The frequency (Daily, Weekly, or Monthly).

Returns:

  • (String)


26004
26005
26006
26007
26008
26009
26010
26011
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26004

class ScheduledInstanceRecurrenceRequest < Struct.new(
  :frequency,
  :interval,
  :occurrence_days,
  :occurrence_relative_to_end,
  :occurrence_unit)
  include Aws::Structure
end

#intervalInteger

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

Returns:

  • (Integer)


26004
26005
26006
26007
26008
26009
26010
26011
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26004

class ScheduledInstanceRecurrenceRequest < Struct.new(
  :frequency,
  :interval,
  :occurrence_days,
  :occurrence_relative_to_end,
  :occurrence_unit)
  include Aws::Structure
end

#occurrence_daysArray<Integer>

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

Returns:

  • (Array<Integer>)


26004
26005
26006
26007
26008
26009
26010
26011
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26004

class ScheduledInstanceRecurrenceRequest < Struct.new(
  :frequency,
  :interval,
  :occurrence_days,
  :occurrence_relative_to_end,
  :occurrence_unit)
  include Aws::Structure
end

#occurrence_relative_to_endBoolean

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

Returns:

  • (Boolean)


26004
26005
26006
26007
26008
26009
26010
26011
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26004

class ScheduledInstanceRecurrenceRequest < Struct.new(
  :frequency,
  :interval,
  :occurrence_days,
  :occurrence_relative_to_end,
  :occurrence_unit)
  include Aws::Structure
end

#occurrence_unitString

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

Returns:

  • (String)


26004
26005
26006
26007
26008
26009
26010
26011
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26004

class ScheduledInstanceRecurrenceRequest < Struct.new(
  :frequency,
  :interval,
  :occurrence_days,
  :occurrence_relative_to_end,
  :occurrence_unit)
  include Aws::Structure
end