Class: Aws::IoT::Types::SchedulingConfig

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::SchedulingConfig

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end behavior for each job execution when it reaches the scheduled end time.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_behavior ⇒ String

  Specifies the end behavior for all job executions after a job reaches the selected ‘endTime`.

• #end_time ⇒ String

  The time a job will stop rollout of the job document to all devices in the target group for a job.

• #maintenance_windows ⇒ Array<Types::MaintenanceWindow>

  An optional configuration within the ‘SchedulingConfig` to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.

• #start_time ⇒ String

  The time a job will begin rollout of the job document to all devices in the target group for a job.

Instance Attribute Details

#end_behavior ⇒ String

Specifies the end behavior for all job executions after a job reaches the selected ‘endTime`. If `endTime` is not selected when creating the job, then `endBehavior` does not apply.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 14171

class SchedulingConfig < Struct.new(
  :start_time,
  :end_time,
  :end_behavior,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ String

The time a job will stop rollout of the job document to all devices in the target group for a job. The ‘endTime` must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between `startTime` and `endTime` is thirty minutes. The maximum duration between `startTime` and `endTime` is two years. The date and time format for the `endTime` is YYYY-MM-DD for the date and HH:MM for the time.

For more information on the syntax for ‘endTime` when using an API command or the Command Line Interface, see [Timestamp].

[1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 14171

class SchedulingConfig < Struct.new(
  :start_time,
  :end_time,
  :end_behavior,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_windows ⇒ Array<Types::MaintenanceWindow>

An optional configuration within the ‘SchedulingConfig` to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.

Returns:

• (Array<Types::MaintenanceWindow>)

# File 'lib/aws-sdk-iot/types.rb', line 14171

class SchedulingConfig < Struct.new(
  :start_time,
  :end_time,
  :end_behavior,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ String

The time a job will begin rollout of the job document to all devices in the target group for a job. The ‘startTime` can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the `startTime` is YYYY-MM-DD for the date and HH:MM for the time.

For more information on the syntax for ‘startTime` when using an API command or the Command Line Interface, see [Timestamp].

[1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 14171

class SchedulingConfig < Struct.new(
  :start_time,
  :end_time,
  :end_behavior,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end