Resource for managing a QuickSight Refresh Schedule.
resource "aws_quicksight_refresh_schedule" "example" {
data_set_id = "dataset-id"
schedule_id = "schedule-id"
schedule {
refresh_type = "FULL_REFRESH"
schedule_frequency {
interval = "HOURLY"
}
}
}
resource "aws_quicksight_refresh_schedule" "example" {
data_set_id = "dataset-id"
schedule_id = "schedule-id"
schedule {
refresh_type = "INCREMENTAL_REFRESH"
schedule_frequency {
interval = "WEEKLY"
time_of_the_day = "01:00"
timezone = "Europe/London"
refresh_on_day {
day_of_week = "MONDAY"
}
}
}
}
resource "aws_quicksight_refresh_schedule" "example" {
data_set_id = "dataset-id"
schedule_id = "schedule-id"
schedule {
refresh_type = "INCREMENTAL_REFRESH"
schedule_frequency {
interval = "MONTHLY"
time_of_the_day = "01:00"
timezone = "Europe/London"
refresh_on_day {
day_of_month = "1"
}
}
}
}
The following arguments are required:
data_set_id
- (Required, Forces new resource) The ID of the dataset.schedule_id
- (Required, Forces new resource) The ID of the refresh schedule.schedule
- (Required) The refresh schedule. See scheduleThe following arguments are optional:
aws_account_id
- (Optional, Forces new resource) AWS account ID.refresh_type
- (Required) The type of refresh that the dataset undergoes. Valid values are INCREMENTAL_REFRESH
and FULL_REFRESH
.start_after_date_time
(Optional) Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS
format.schedule_frequency
- (Optional) The configuration of the schedule frequency. See schedule_frequency.interval
- (Required) The interval between scheduled refreshes. Valid values are MINUTE15
, MINUTE30
, HOURLY
, DAILY
, WEEKLY
and MONTHLY
.time_of_the_day
- (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
- (Optional) The timezone that you want the refresh schedule to use.refresh_on_day
- (Optional) The refresh on entity configuration for weekly or monthly schedules. See refresh_on_day.day_of_month
- (Optional) The day of the month that you want to schedule refresh on.day_of_week
- (Optional) The day of the week that you want to schedule a refresh on. Valid values are SUNDAY
, MONDAY
, TUESDAY
, WEDNESDAY
, THURSDAY
, FRIDAY
and SATURDAY
.This resource exports the following attributes in addition to the arguments above:
arn
- Amazon Resource Name (ARN) of the refresh schedule.id
- A comma-delimited string joining AWS account ID, data set ID & refresh schedule ID.In Terraform v1.5.0 and later, use an import
block to import a QuickSight Refresh Schedule using the AWS account ID, data set ID and schedule ID separated by commas (,
). For example:
import {
to = aws_quicksight_refresh_schedule.example
id = "123456789012,dataset-id,schedule-id"
}
Using terraform import
, import a QuickSight Refresh Schedule using the AWS account ID, data set ID and schedule ID separated by commas (,
). For example:
% terraform import aws_quicksight_refresh_schedule.example 123456789012,dataset-id,schedule-id