AWS::QuickSight::RefreshSchedule ScheduleFrequency - AWS CloudFormation
SyntaxProperties

AWS::QuickSight::RefreshSchedule ScheduleFrequency

The frequency for the refresh schedule.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Interval" : String,
  "RefreshOnDay" : RefreshOnDay,
  "TimeOfTheDay" : String,
  "TimeZone" : String
}

YAML

  Interval: String
  RefreshOnDay: 
    RefreshOnDay
  TimeOfTheDay: String
  TimeZone: String

Properties

Interval

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.

Required: No

Type: String

Allowed values: MINUTE15 | MINUTE30 | HOURLY | DAILY | WEEKLY | MONTHLY

Update requires: No interruption

RefreshOnDay

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

Required: No

Type: RefreshOnDay

Update requires: No interruption

TimeOfTheDay

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.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

TimeZone

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption