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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ScheduledInstanceRecurrenceRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Describes the recurring schedule for a Scheduled Instance.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#frequency ⇒ String

The frequency (Daily, Weekly, or Monthly).

Returns:

  • (String) —

    The frequency (Daily, Weekly, or Monthly).

#interval ⇒ Integer

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

Returns:

  • (Integer) —

    The interval quantity.

#occurrence_days ⇒ Array<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>) —

    The days.

#occurrence_relative_to_end ⇒ Boolean

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) —

    Indicates whether the occurrence is relative to the end of the specified week or month.

#occurrence_unit ⇒ String

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) —

    The unit for OccurrenceDays (DayOfWeek or DayOfMonth).