Class: AWSCDK::QuickSight::CfnRefreshSchedule::ScheduleFrequencyProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_refresh_schedule.rb

Overview

The frequency for the refresh schedule.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(interval: nil, refresh_on_day: nil, time_of_the_day: nil, time_zone: nil) ⇒ ScheduleFrequencyProperty

Returns a new instance of ScheduleFrequencyProperty.

Parameters:

  • interval (String, nil) (defaults to: nil) —

    The interval between scheduled refreshes. Valid values are as follows:.

  • refresh_on_day (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnRefreshSchedule::RefreshOnDayProperty, nil) (defaults to: nil) —

    The day of the week that you want to schedule the refresh on.

  • time_of_the_day (String, nil) (defaults to: nil) —

    The time of day that you want the dataset to refresh.

  • time_zone (String, nil) (defaults to: nil) —

    The timezone that you want the refresh schedule to use.



652
653
654
655
656
657
658
659
660
661
 
# File 'quick_sight/cfn_refresh_schedule.rb', line 652

def initialize(interval: nil, refresh_on_day: nil, time_of_the_day: nil, time_zone: nil)
  @interval = interval
  Jsii::Type.check_type(@interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "interval") unless @interval.nil?
  @refresh_on_day = refresh_on_day.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnRefreshSchedule::RefreshOnDayProperty.new(**refresh_on_day.transform_keys(&:to_sym)) : refresh_on_day
  Jsii::Type.check_type(@refresh_on_day, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblJlZnJlc2hTY2hlZHVsZS5SZWZyZXNoT25EYXlQcm9wZXJ0eSJ9XX19")), "refreshOnDay") unless @refresh_on_day.nil?
  @time_of_the_day = time_of_the_day
  Jsii::Type.check_type(@time_of_the_day, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeOfTheDay") unless @time_of_the_day.nil?
  @time_zone = time_zone
  Jsii::Type.check_type(@time_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeZone") unless @time_zone.nil?
end

Instance Attribute Details

#interval ⇒ String? (readonly)

The interval between scheduled refreshes. Valid values are as follows:.

  • MINUTE15 : The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
  • MINUTE30 : The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
  • HOURLY : The dataset refreshes every hour. This interval can only be used for one schedule per dataset.
  • DAILY : The dataset refreshes every day.
  • WEEKLY : The dataset refreshes every week.
  • MONTHLY : The dataset refreshes every month.

Returns:

  • (String, nil)

See Also:



674
675
676
 
# File 'quick_sight/cfn_refresh_schedule.rb', line 674

def interval
  @interval
end

#refresh_on_day ⇒ AWSCDK::IResolvable, ... (readonly)

The day of the week that you want to schedule the refresh on.

This value is required for weekly and monthly refresh intervals.

Returns:

See Also:



681
682
683
 
# File 'quick_sight/cfn_refresh_schedule.rb', line 681

def refresh_on_day
  @refresh_on_day
end

#time_of_the_day ⇒ String? (readonly)

The time of day that you want the dataset to refresh.

This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

Returns:

  • (String, nil)

See Also:



688
689
690
 
# File 'quick_sight/cfn_refresh_schedule.rb', line 688

def time_of_the_day
  @time_of_the_day
end

#time_zone ⇒ String? (readonly)

The timezone that you want the refresh schedule to use.

The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs() .

Returns:

  • (String, nil)

See Also:



695
696
697
 
# File 'quick_sight/cfn_refresh_schedule.rb', line 695

def time_zone
  @time_zone
end

Class Method Details

.jsii_properties ⇒ Object 



697
698
699
700
701
702
703
704
 
# File 'quick_sight/cfn_refresh_schedule.rb', line 697

def self.jsii_properties
  {
    :interval => "interval",
    :refresh_on_day => "refreshOnDay",
    :time_of_the_day => "timeOfTheDay",
    :time_zone => "timeZone",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



706
707
708
709
710
711
712
713
714
715
 
# File 'quick_sight/cfn_refresh_schedule.rb', line 706

def to_jsii
  result = {}
  result.merge!({
    "interval" => @interval,
    "refreshOnDay" => @refresh_on_day,
    "timeOfTheDay" => @time_of_the_day,
    "timeZone" => @time_zone,
  })
  result.compact
end