Package software.amazon.awscdk.services.quicksight

Interface CfnRefreshSchedule.RefreshScheduleMapProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRefreshSchedule.RefreshScheduleMapProperty.Jsii$Proxy

Enclosing class:

CfnRefreshSchedule

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

A summary of a configured refresh schedule for a dataset.

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.*;
 RefreshScheduleMapProperty refreshScheduleMapProperty = RefreshScheduleMapProperty.builder()
         .refreshType("refreshType")
         .scheduleFrequency(ScheduleFrequencyProperty.builder()
                 .interval("interval")
                 .refreshOnDay(RefreshOnDayProperty.builder()
                         .dayOfMonth("dayOfMonth")
                         .dayOfWeek("dayOfWeek")
                         .build())
                 .timeOfTheDay("timeOfTheDay")
                 .timeZone("timeZone")
                 .build())
         .scheduleId("scheduleId")
         .startAfterDateTime("startAfterDateTime")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRefreshSchedule.RefreshScheduleMapProperty.Builder	builder()
default String	getRefreshType()	The type of refresh that a dataset undergoes.
default Object	getScheduleFrequency()	The frequency for the refresh schedule.
default String	getScheduleId()	An identifier for the refresh schedule.
default String	getStartAfterDateTime()	Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRefreshType

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

The type of refresh that a dataset undergoes. Valid values are as follows:.

• FULL_REFRESH : A complete refresh of a dataset.
• INCREMENTAL_REFRESH : A partial refresh of some rows of a dataset, based on the time window specified.

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide .

See Also:

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

getScheduleFrequency

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

The frequency for the refresh schedule.

See Also:

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

getScheduleId

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

An identifier for the refresh schedule.

See Also:

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

getStartAfterDateTime

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

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

See Also:

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

builder

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

Returns:

a CfnRefreshSchedule.RefreshScheduleMapProperty.Builder of CfnRefreshSchedule.RefreshScheduleMapProperty