Class: Aws::BCMDashboards::Types::ScheduleConfig

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

Overview

Defines the schedule for a scheduled report, including the cron expression, time zone, active period, and the schedule state.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#schedule_expression ⇒ String

The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year).

Returns:

  • (String) 


1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/types.rb', line 1025

class ScheduleConfig < Struct.new(
  :schedule_expression,
  :schedule_expression_time_zone,
  :schedule_period,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression_time_zone ⇒ String

The time zone for the schedule expression, for example, UTC.

Returns:

  • (String) 


1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/types.rb', line 1025

class ScheduleConfig < Struct.new(
  :schedule_expression,
  :schedule_expression_time_zone,
  :schedule_period,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_period ⇒ Types::SchedulePeriod

The time period during which the schedule is active.

Returns:



1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/types.rb', line 1025

class ScheduleConfig < Struct.new(
  :schedule_expression,
  :schedule_expression_time_zone,
  :schedule_period,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.

Returns:

  • (String) 


1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'gems/aws-sdk-bcmdashboards/lib/aws-sdk-bcmdashboards/types.rb', line 1025

class ScheduleConfig < Struct.new(
  :schedule_expression,
  :schedule_expression_time_zone,
  :schedule_period,
  :state)
  SENSITIVE = []
  include Aws::Structure
end