aws-cdk-lib.aws_quicksight.CfnRefreshSchedule.RefreshScheduleMapProperty

interface RefreshScheduleMapProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnRefreshSchedule.RefreshScheduleMapProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnRefreshSchedule_RefreshScheduleMapProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnRefreshSchedule.RefreshScheduleMapProperty
Pythonaws_cdk.aws_quicksight.CfnRefreshSchedule.RefreshScheduleMapProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnRefreshSchedule » RefreshScheduleMapProperty

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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const refreshScheduleMapProperty: quicksight.CfnRefreshSchedule.RefreshScheduleMapProperty = {
  refreshType: 'refreshType',
  scheduleFrequency: {
    interval: 'interval',
    refreshOnDay: {
      dayOfMonth: 'dayOfMonth',
      dayOfWeek: 'dayOfWeek',
    },
    timeOfTheDay: 'timeOfTheDay',
    timeZone: 'timeZone',
  },
  scheduleId: 'scheduleId',
  startAfterDateTime: 'startAfterDateTime',
};

Properties

NameTypeDescription
refreshType?stringThe type of refresh that a dataset undergoes. Valid values are as follows:.
scheduleFrequency?IResolvable | ScheduleFrequencyPropertyThe frequency for the refresh schedule.
scheduleId?stringAn identifier for the refresh schedule.
startAfterDateTime?stringTime after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

refreshType?

Type: string (optional)

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 .


scheduleFrequency?

Type: IResolvable | ScheduleFrequencyProperty (optional)

The frequency for the refresh schedule.


scheduleId?

Type: string (optional)

An identifier for the refresh schedule.


startAfterDateTime?

Type: string (optional)

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