Package software.amazon.awscdk.services.quicksight

Interface CfnRefreshSchedule.ScheduleFrequencyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRefreshSchedule.ScheduleFrequencyProperty.Jsii$Proxy

Enclosing class:

CfnRefreshSchedule

@Stability(Stable)
public static interface CfnRefreshSchedule.ScheduleFrequencyProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.quicksight.*;
 ScheduleFrequencyProperty scheduleFrequencyProperty = ScheduleFrequencyProperty.builder()
         .interval("interval")
         .refreshOnDay(RefreshOnDayProperty.builder()
                 .dayOfMonth("dayOfMonth")
                 .dayOfWeek("dayOfWeek")
                 .build())
         .timeOfTheDay("timeOfTheDay")
         .timeZone("timeZone")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRefreshSchedule.ScheduleFrequencyProperty.Builder	A builder for CfnRefreshSchedule.ScheduleFrequencyProperty
static final class	CfnRefreshSchedule.ScheduleFrequencyProperty.Jsii$Proxy	An implementation for CfnRefreshSchedule.ScheduleFrequencyProperty

Method Summary

Modifier and Type	Method	Description
static CfnRefreshSchedule.ScheduleFrequencyProperty.Builder	builder()
default String	getInterval()	The interval between scheduled refreshes.
default Object	getRefreshOnDay()	The day of the week that you want to schedule the refresh on.
default String	getTimeOfTheDay()	The time of day that you want the dataset to refresh.
default String	getTimeZone()	The timezone that you want the refresh schedule to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInterval

@Stability(Stable)
@Nullable
default String getInterval()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-interval

getRefreshOnDay

@Stability(Stable)
@Nullable
default Object getRefreshOnDay()

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

This value is required for weekly and monthly refresh intervals.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-refreshonday

getTimeOfTheDay

@Stability(Stable)
@Nullable
default String getTimeOfTheDay()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-timeoftheday

getTimeZone

@Stability(Stable)
@Nullable
default String getTimeZone()

The timezone that you want the refresh schedule to use.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-timezone

builder

@Stability(Stable)
static CfnRefreshSchedule.ScheduleFrequencyProperty.Builder builder()

Returns:

a CfnRefreshSchedule.ScheduleFrequencyProperty.Builder of CfnRefreshSchedule.ScheduleFrequencyProperty