1.204.0

interface ScheduleFrequencyProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnRefreshSchedule.ScheduleFrequencyProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnRefreshSchedule.ScheduleFrequencyProperty
Pythonaws_cdk.aws_quicksight.CfnRefreshSchedule.ScheduleFrequencyProperty
TypeScript @aws-cdk/aws-quicksight » CfnRefreshSchedule » ScheduleFrequencyProperty

The frequency for the refresh schedule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const scheduleFrequencyProperty: quicksight.CfnRefreshSchedule.ScheduleFrequencyProperty = {
  interval: 'interval',
  refreshOnDay: {
    dayOfMonth: 'dayOfMonth',
    dayOfWeek: 'dayOfWeek',
  },
  timeOfTheDay: 'timeOfTheDay',
  timeZone: 'timeZone',
};

Properties

NameTypeDescription
interval?stringThe interval between scheduled refreshes. Valid values are as follows:.
refreshOnDay?IResolvable | RefreshOnDayPropertyThe day of the week that you want to schedule the refresh on.
timeOfTheDay?stringThe time of day that you want the dataset to refresh.
timeZone?stringThe timezone that you want the refresh schedule to use.

interval?

Type: string (optional)

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.

refreshOnDay?

Type: IResolvable | RefreshOnDayProperty (optional)

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

This value is required for weekly and monthly refresh intervals.

timeOfTheDay?

Type: string (optional)

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.

timeZone?

Type: string (optional)

The timezone that you want the refresh schedule to use.

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

← PreviousNext →