AWS::QuickSight::RefreshSchedule RefreshScheduleMap - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::QuickSight::RefreshSchedule RefreshScheduleMap

A summary of a configured refresh schedule for a dataset.

Syntax

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

JSON

{
  "RefreshType" : String,
  "ScheduleFrequency" : ScheduleFrequency,
  "ScheduleId" : String,
  "StartAfterDateTime" : String
}

Properties

RefreshType

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 Quick User Guide.

Required: No

Type: String

Allowed values: FULL_REFRESH | INCREMENTAL_REFRESH

Update requires: No interruption

ScheduleFrequency

The frequency for the refresh schedule.

Required: No

Type: ScheduleFrequency

Update requires: No interruption

ScheduleId

An identifier for the refresh schedule.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: Replacement

StartAfterDateTime

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

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption