Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. quicksight
  6. RefreshSchedule
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.quicksight.RefreshSchedule

aws logo aws logo
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Resource for managing a QuickSight Refresh Schedule.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.RefreshSchedule("example", {
    schedule: {
        scheduleFrequency: {
            interval: "HOURLY",
        },
        refreshType: "FULL_REFRESH",
    },
    dataSetId: "dataset-id",
    scheduleId: "schedule-id",
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.RefreshSchedule("example",
    schedule={
        "schedule_frequency": {
            "interval": "HOURLY",
        },
        "refresh_type": "FULL_REFRESH",
    },
    data_set_id="dataset-id",
    schedule_id="schedule-id")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewRefreshSchedule(ctx, "example", &quicksight.RefreshScheduleArgs{
			Schedule: &quicksight.RefreshScheduleScheduleArgs{
				ScheduleFrequency: &quicksight.RefreshScheduleScheduleScheduleFrequencyArgs{
					Interval: pulumi.String("HOURLY"),
				},
				RefreshType: pulumi.String("FULL_REFRESH"),
			},
			DataSetId:  pulumi.String("dataset-id"),
			ScheduleId: pulumi.String("schedule-id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.RefreshSchedule("example", new()
    {
        Schedule = new Aws.Quicksight.Inputs.RefreshScheduleScheduleArgs
        {
            ScheduleFrequency = new Aws.Quicksight.Inputs.RefreshScheduleScheduleScheduleFrequencyArgs
            {
                Interval = "HOURLY",
            },
            RefreshType = "FULL_REFRESH",
        },
        DataSetId = "dataset-id",
        ScheduleId = "schedule-id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.RefreshSchedule;
import com.pulumi.aws.quicksight.RefreshScheduleArgs;
import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleArgs;
import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new RefreshSchedule("example", RefreshScheduleArgs.builder()
            .schedule(RefreshScheduleScheduleArgs.builder()
                .scheduleFrequency(RefreshScheduleScheduleScheduleFrequencyArgs.builder()
                    .interval("HOURLY")
                    .build())
                .refreshType("FULL_REFRESH")
                .build())
            .dataSetId("dataset-id")
            .scheduleId("schedule-id")
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:RefreshSchedule
    properties:
      schedule:
        scheduleFrequency:
          interval: HOURLY
        refreshType: FULL_REFRESH
      dataSetId: dataset-id
      scheduleId: schedule-id

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_quicksight_refresh_schedule" "example" {
  lifecycle {
    create_before_destroy = true
  }
  schedule {
    schedule_frequency {
      interval = "HOURLY"
    }
    refresh_type = "FULL_REFRESH"
  }
  data_set_id = "dataset-id"
  schedule_id = "schedule-id"
}

    With Weekly Refresh

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.RefreshSchedule("example", {
    schedule: {
        scheduleFrequency: {
            refreshOnDay: {
                dayOfWeek: "MONDAY",
            },
            interval: "WEEKLY",
            timeOfTheDay: "01:00",
            timezone: "Europe/London",
        },
        refreshType: "INCREMENTAL_REFRESH",
    },
    dataSetId: "dataset-id",
    scheduleId: "schedule-id",
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.RefreshSchedule("example",
    schedule={
        "schedule_frequency": {
            "refresh_on_day": {
                "day_of_week": "MONDAY",
            },
            "interval": "WEEKLY",
            "time_of_the_day": "01:00",
            "timezone": "Europe/London",
        },
        "refresh_type": "INCREMENTAL_REFRESH",
    },
    data_set_id="dataset-id",
    schedule_id="schedule-id")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewRefreshSchedule(ctx, "example", &quicksight.RefreshScheduleArgs{
			Schedule: &quicksight.RefreshScheduleScheduleArgs{
				ScheduleFrequency: &quicksight.RefreshScheduleScheduleScheduleFrequencyArgs{
					RefreshOnDay: &quicksight.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs{
						DayOfWeek: pulumi.String("MONDAY"),
					},
					Interval:     pulumi.String("WEEKLY"),
					TimeOfTheDay: pulumi.String("01:00"),
					Timezone:     pulumi.String("Europe/London"),
				},
				RefreshType: pulumi.String("INCREMENTAL_REFRESH"),
			},
			DataSetId:  pulumi.String("dataset-id"),
			ScheduleId: pulumi.String("schedule-id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.RefreshSchedule("example", new()
    {
        Schedule = new Aws.Quicksight.Inputs.RefreshScheduleScheduleArgs
        {
            ScheduleFrequency = new Aws.Quicksight.Inputs.RefreshScheduleScheduleScheduleFrequencyArgs
            {
                RefreshOnDay = new Aws.Quicksight.Inputs.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs
                {
                    DayOfWeek = "MONDAY",
                },
                Interval = "WEEKLY",
                TimeOfTheDay = "01:00",
                Timezone = "Europe/London",
            },
            RefreshType = "INCREMENTAL_REFRESH",
        },
        DataSetId = "dataset-id",
        ScheduleId = "schedule-id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.RefreshSchedule;
import com.pulumi.aws.quicksight.RefreshScheduleArgs;
import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleArgs;
import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyArgs;
import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new RefreshSchedule("example", RefreshScheduleArgs.builder()
            .schedule(RefreshScheduleScheduleArgs.builder()
                .scheduleFrequency(RefreshScheduleScheduleScheduleFrequencyArgs.builder()
                    .refreshOnDay(RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs.builder()
                        .dayOfWeek("MONDAY")
                        .build())
                    .interval("WEEKLY")
                    .timeOfTheDay("01:00")
                    .timezone("Europe/London")
                    .build())
                .refreshType("INCREMENTAL_REFRESH")
                .build())
            .dataSetId("dataset-id")
            .scheduleId("schedule-id")
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:RefreshSchedule
    properties:
      schedule:
        scheduleFrequency:
          refreshOnDay:
            dayOfWeek: MONDAY
          interval: WEEKLY
          timeOfTheDay: 01:00
          timezone: Europe/London
        refreshType: INCREMENTAL_REFRESH
      dataSetId: dataset-id
      scheduleId: schedule-id

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_quicksight_refresh_schedule" "example" {
  lifecycle {
    create_before_destroy = true
  }
  schedule {
    schedule_frequency {
      refresh_on_day {
        day_of_week = "MONDAY"
      }
      interval        = "WEEKLY"
      time_of_the_day = "01:00"
      timezone        = "Europe/London"
    }
    refresh_type = "INCREMENTAL_REFRESH"
  }
  data_set_id = "dataset-id"
  schedule_id = "schedule-id"
}

    With Monthly Refresh

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.RefreshSchedule("example", {
    schedule: {
        scheduleFrequency: {
            refreshOnDay: {
                dayOfMonth: "1",
            },
            interval: "MONTHLY",
            timeOfTheDay: "01:00",
            timezone: "Europe/London",
        },
        refreshType: "INCREMENTAL_REFRESH",
    },
    dataSetId: "dataset-id",
    scheduleId: "schedule-id",
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.RefreshSchedule("example",
    schedule={
        "schedule_frequency": {
            "refresh_on_day": {
                "day_of_month": "1",
            },
            "interval": "MONTHLY",
            "time_of_the_day": "01:00",
            "timezone": "Europe/London",
        },
        "refresh_type": "INCREMENTAL_REFRESH",
    },
    data_set_id="dataset-id",
    schedule_id="schedule-id")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewRefreshSchedule(ctx, "example", &quicksight.RefreshScheduleArgs{
			Schedule: &quicksight.RefreshScheduleScheduleArgs{
				ScheduleFrequency: &quicksight.RefreshScheduleScheduleScheduleFrequencyArgs{
					RefreshOnDay: &quicksight.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs{
						DayOfMonth: pulumi.String("1"),
					},
					Interval:     pulumi.String("MONTHLY"),
					TimeOfTheDay: pulumi.String("01:00"),
					Timezone:     pulumi.String("Europe/London"),
				},
				RefreshType: pulumi.String("INCREMENTAL_REFRESH"),
			},
			DataSetId:  pulumi.String("dataset-id"),
			ScheduleId: pulumi.String("schedule-id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.RefreshSchedule("example", new()
    {
        Schedule = new Aws.Quicksight.Inputs.RefreshScheduleScheduleArgs
        {
            ScheduleFrequency = new Aws.Quicksight.Inputs.RefreshScheduleScheduleScheduleFrequencyArgs
            {
                RefreshOnDay = new Aws.Quicksight.Inputs.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs
                {
                    DayOfMonth = "1",
                },
                Interval = "MONTHLY",
                TimeOfTheDay = "01:00",
                Timezone = "Europe/London",
            },
            RefreshType = "INCREMENTAL_REFRESH",
        },
        DataSetId = "dataset-id",
        ScheduleId = "schedule-id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.RefreshSchedule;
import com.pulumi.aws.quicksight.RefreshScheduleArgs;
import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleArgs;
import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyArgs;
import com.pulumi.aws.quicksight.inputs.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new RefreshSchedule("example", RefreshScheduleArgs.builder()
            .schedule(RefreshScheduleScheduleArgs.builder()
                .scheduleFrequency(RefreshScheduleScheduleScheduleFrequencyArgs.builder()
                    .refreshOnDay(RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs.builder()
                        .dayOfMonth("1")
                        .build())
                    .interval("MONTHLY")
                    .timeOfTheDay("01:00")
                    .timezone("Europe/London")
                    .build())
                .refreshType("INCREMENTAL_REFRESH")
                .build())
            .dataSetId("dataset-id")
            .scheduleId("schedule-id")
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:RefreshSchedule
    properties:
      schedule:
        scheduleFrequency:
          refreshOnDay:
            dayOfMonth: '1'
          interval: MONTHLY
          timeOfTheDay: 01:00
          timezone: Europe/London
        refreshType: INCREMENTAL_REFRESH
      dataSetId: dataset-id
      scheduleId: schedule-id

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_quicksight_refresh_schedule" "example" {
  lifecycle {
    create_before_destroy = true
  }
  schedule {
    schedule_frequency {
      refresh_on_day {
        day_of_month = "1"
      }
      interval        = "MONTHLY"
      time_of_the_day = "01:00"
      timezone        = "Europe/London"
    }
    refresh_type = "INCREMENTAL_REFRESH"
  }
  data_set_id = "dataset-id"
  schedule_id = "schedule-id"
}

    Create RefreshSchedule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RefreshSchedule(name: string, args: RefreshScheduleArgs, opts?: CustomResourceOptions);
    @overload
def RefreshSchedule(resource_name: str,
                    args: RefreshScheduleArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def RefreshSchedule(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    data_set_id: Optional[str] = None,
                    schedule: Optional[RefreshScheduleScheduleArgs] = None,
                    schedule_id: Optional[str] = None,
                    aws_account_id: Optional[str] = None,
                    region: Optional[str] = None)
    func NewRefreshSchedule(ctx *Context, name string, args RefreshScheduleArgs, opts ...ResourceOption) (*RefreshSchedule, error)
    public RefreshSchedule(string name, RefreshScheduleArgs args, CustomResourceOptions? opts = null)
    public RefreshSchedule(String name, RefreshScheduleArgs args)
public RefreshSchedule(String name, RefreshScheduleArgs args, CustomResourceOptions options)

    type: aws:quicksight:RefreshSchedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_quicksight_refresh_schedule" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args RefreshScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RefreshScheduleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RefreshScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RefreshScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RefreshScheduleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var refreshScheduleResource = new Aws.Quicksight.RefreshSchedule("refreshScheduleResource", new()
{
    DataSetId = "string",
    Schedule = new Aws.Quicksight.Inputs.RefreshScheduleScheduleArgs
    {
        RefreshType = "string",
        ScheduleFrequency = new Aws.Quicksight.Inputs.RefreshScheduleScheduleScheduleFrequencyArgs
        {
            Interval = "string",
            RefreshOnDay = new Aws.Quicksight.Inputs.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs
            {
                DayOfMonth = "string",
                DayOfWeek = "string",
            },
            TimeOfTheDay = "string",
            Timezone = "string",
        },
        StartAfterDateTime = "string",
    },
    ScheduleId = "string",
    AwsAccountId = "string",
    Region = "string",
});

    example, err := quicksight.NewRefreshSchedule(ctx, "refreshScheduleResource", &quicksight.RefreshScheduleArgs{
	DataSetId: pulumi.String("string"),
	Schedule: &quicksight.RefreshScheduleScheduleArgs{
		RefreshType: pulumi.String("string"),
		ScheduleFrequency: &quicksight.RefreshScheduleScheduleScheduleFrequencyArgs{
			Interval: pulumi.String("string"),
			RefreshOnDay: &quicksight.RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs{
				DayOfMonth: pulumi.String("string"),
				DayOfWeek:  pulumi.String("string"),
			},
			TimeOfTheDay: pulumi.String("string"),
			Timezone:     pulumi.String("string"),
		},
		StartAfterDateTime: pulumi.String("string"),
	},
	ScheduleId:   pulumi.String("string"),
	AwsAccountId: pulumi.String("string"),
	Region:       pulumi.String("string"),
})

    resource "aws_quicksight_refresh_schedule" "refreshScheduleResource" {
  lifecycle {
    create_before_destroy = true
  }
  data_set_id = "string"
  schedule = {
    refresh_type = "string"
    schedule_frequency = {
      interval = "string"
      refresh_on_day = {
        day_of_month = "string"
        day_of_week  = "string"
      }
      time_of_the_day = "string"
      timezone        = "string"
    }
    start_after_date_time = "string"
  }
  schedule_id    = "string"
  aws_account_id = "string"
  region         = "string"
}

    var refreshScheduleResource = new RefreshSchedule("refreshScheduleResource", RefreshScheduleArgs.builder()
    .dataSetId("string")
    .schedule(RefreshScheduleScheduleArgs.builder()
        .refreshType("string")
        .scheduleFrequency(RefreshScheduleScheduleScheduleFrequencyArgs.builder()
            .interval("string")
            .refreshOnDay(RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs.builder()
                .dayOfMonth("string")
                .dayOfWeek("string")
                .build())
            .timeOfTheDay("string")
            .timezone("string")
            .build())
        .startAfterDateTime("string")
        .build())
    .scheduleId("string")
    .awsAccountId("string")
    .region("string")
    .build());

    refresh_schedule_resource = aws.quicksight.RefreshSchedule("refreshScheduleResource",
    data_set_id="string",
    schedule={
        "refresh_type": "string",
        "schedule_frequency": {
            "interval": "string",
            "refresh_on_day": {
                "day_of_month": "string",
                "day_of_week": "string",
            },
            "time_of_the_day": "string",
            "timezone": "string",
        },
        "start_after_date_time": "string",
    },
    schedule_id="string",
    aws_account_id="string",
    region="string")

    const refreshScheduleResource = new aws.quicksight.RefreshSchedule("refreshScheduleResource", {
    dataSetId: "string",
    schedule: {
        refreshType: "string",
        scheduleFrequency: {
            interval: "string",
            refreshOnDay: {
                dayOfMonth: "string",
                dayOfWeek: "string",
            },
            timeOfTheDay: "string",
            timezone: "string",
        },
        startAfterDateTime: "string",
    },
    scheduleId: "string",
    awsAccountId: "string",
    region: "string",
});

    type: aws:quicksight:RefreshSchedule
properties:
    awsAccountId: string
    dataSetId: string
    region: string
    schedule:
        refreshType: string
        scheduleFrequency:
            interval: string
            refreshOnDay:
                dayOfMonth: string
                dayOfWeek: string
            timeOfTheDay: string
            timezone: string
        startAfterDateTime: string
    scheduleId: string

    RefreshSchedule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RefreshSchedule resource accepts the following input properties:

    DataSetId string
    ID of the dataset.
    Schedule RefreshScheduleSchedule
    Refresh schedule configuration. See schedule Block.
    ScheduleId string

    ID of the refresh schedule.

    The following arguments are optional:

    AwsAccountId string
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    DataSetId string
    ID of the dataset.
    Schedule RefreshScheduleScheduleArgs
    Refresh schedule configuration. See schedule Block.
    ScheduleId string

    ID of the refresh schedule.

    The following arguments are optional:

    AwsAccountId string
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    data_set_id string
    ID of the dataset.
    schedule object
    Refresh schedule configuration. See schedule Block.
    schedule_id string

    ID of the refresh schedule.

    The following arguments are optional:

    aws_account_id string
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    dataSetId String
    ID of the dataset.
    schedule RefreshScheduleSchedule
    Refresh schedule configuration. See schedule Block.
    scheduleId String

    ID of the refresh schedule.

    The following arguments are optional:

    awsAccountId String
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    dataSetId string
    ID of the dataset.
    schedule RefreshScheduleSchedule
    Refresh schedule configuration. See schedule Block.
    scheduleId string

    ID of the refresh schedule.

    The following arguments are optional:

    awsAccountId string
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    data_set_id str
    ID of the dataset.
    schedule RefreshScheduleScheduleArgs
    Refresh schedule configuration. See schedule Block.
    schedule_id str

    ID of the refresh schedule.

    The following arguments are optional:

    aws_account_id str
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    dataSetId String
    ID of the dataset.
    schedule Property Map
    Refresh schedule configuration. See schedule Block.
    scheduleId String

    ID of the refresh schedule.

    The following arguments are optional:

    awsAccountId String
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RefreshSchedule resource produces the following output properties:

    Arn string
    ARN of the refresh schedule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    ARN of the refresh schedule.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn string
    ARN of the refresh schedule.
    id string
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the refresh schedule.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    ARN of the refresh schedule.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    ARN of the refresh schedule.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the refresh schedule.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RefreshSchedule Resource

    Get an existing RefreshSchedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RefreshScheduleState, opts?: CustomResourceOptions): RefreshSchedule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        data_set_id: Optional[str] = None,
        region: Optional[str] = None,
        schedule: Optional[RefreshScheduleScheduleArgs] = None,
        schedule_id: Optional[str] = None) -> RefreshSchedule
    func GetRefreshSchedule(ctx *Context, name string, id IDInput, state *RefreshScheduleState, opts ...ResourceOption) (*RefreshSchedule, error)
    public static RefreshSchedule Get(string name, Input<string> id, RefreshScheduleState? state, CustomResourceOptions? opts = null)
    public static RefreshSchedule get(String name, Output<String> id, RefreshScheduleState state, CustomResourceOptions options)
    resources:  _:    type: aws:quicksight:RefreshSchedule    get:      id: ${id}
    import {
  to = aws_quicksight_refresh_schedule.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the refresh schedule.
    AwsAccountId string
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    DataSetId string
    ID of the dataset.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Schedule RefreshScheduleSchedule
    Refresh schedule configuration. See schedule Block.
    ScheduleId string

    ID of the refresh schedule.

    The following arguments are optional:

    Arn string
    ARN of the refresh schedule.
    AwsAccountId string
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    DataSetId string
    ID of the dataset.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Schedule RefreshScheduleScheduleArgs
    Refresh schedule configuration. See schedule Block.
    ScheduleId string

    ID of the refresh schedule.

    The following arguments are optional:

    arn string
    ARN of the refresh schedule.
    aws_account_id string
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    data_set_id string
    ID of the dataset.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    schedule object
    Refresh schedule configuration. See schedule Block.
    schedule_id string

    ID of the refresh schedule.

    The following arguments are optional:

    arn String
    ARN of the refresh schedule.
    awsAccountId String
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    dataSetId String
    ID of the dataset.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    schedule RefreshScheduleSchedule
    Refresh schedule configuration. See schedule Block.
    scheduleId String

    ID of the refresh schedule.

    The following arguments are optional:

    arn string
    ARN of the refresh schedule.
    awsAccountId string
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    dataSetId string
    ID of the dataset.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    schedule RefreshScheduleSchedule
    Refresh schedule configuration. See schedule Block.
    scheduleId string

    ID of the refresh schedule.

    The following arguments are optional:

    arn str
    ARN of the refresh schedule.
    aws_account_id str
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    data_set_id str
    ID of the dataset.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    schedule RefreshScheduleScheduleArgs
    Refresh schedule configuration. See schedule Block.
    schedule_id str

    ID of the refresh schedule.

    The following arguments are optional:

    arn String
    ARN of the refresh schedule.
    awsAccountId String
    AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
    dataSetId String
    ID of the dataset.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    schedule Property Map
    Refresh schedule configuration. See schedule Block.
    scheduleId String

    ID of the refresh schedule.

    The following arguments are optional:

    Supporting Types

    RefreshScheduleSchedule, RefreshScheduleScheduleArgs

    RefreshType string
    Type of refresh that the dataset undergoes. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.
    ScheduleFrequency RefreshScheduleScheduleScheduleFrequency
    Configuration of the schedule frequency. See scheduleFrequency Block.
    StartAfterDateTime string
    Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
    RefreshType string
    Type of refresh that the dataset undergoes. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.
    ScheduleFrequency RefreshScheduleScheduleScheduleFrequency
    Configuration of the schedule frequency. See scheduleFrequency Block.
    StartAfterDateTime string
    Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
    refresh_type string
    Type of refresh that the dataset undergoes. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.
    schedule_frequency object
    Configuration of the schedule frequency. See scheduleFrequency Block.
    start_after_date_time string
    Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
    refreshType String
    Type of refresh that the dataset undergoes. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.
    scheduleFrequency RefreshScheduleScheduleScheduleFrequency
    Configuration of the schedule frequency. See scheduleFrequency Block.
    startAfterDateTime String
    Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
    refreshType string
    Type of refresh that the dataset undergoes. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.
    scheduleFrequency RefreshScheduleScheduleScheduleFrequency
    Configuration of the schedule frequency. See scheduleFrequency Block.
    startAfterDateTime string
    Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
    refresh_type str
    Type of refresh that the dataset undergoes. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.
    schedule_frequency RefreshScheduleScheduleScheduleFrequency
    Configuration of the schedule frequency. See scheduleFrequency Block.
    start_after_date_time str
    Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
    refreshType String
    Type of refresh that the dataset undergoes. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.
    scheduleFrequency Property Map
    Configuration of the schedule frequency. See scheduleFrequency Block.
    startAfterDateTime String
    Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

    RefreshScheduleScheduleScheduleFrequency, RefreshScheduleScheduleScheduleFrequencyArgs

    Interval string
    Interval between scheduled refreshes. Valid values are MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY and MONTHLY.
    RefreshOnDay RefreshScheduleScheduleScheduleFrequencyRefreshOnDay
    Refresh on entity configuration for weekly or monthly schedules. See refreshOnDay Block.
    TimeOfTheDay string
    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 string
    Timezone that you want the refresh schedule to use.
    Interval string
    Interval between scheduled refreshes. Valid values are MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY and MONTHLY.
    RefreshOnDay RefreshScheduleScheduleScheduleFrequencyRefreshOnDay
    Refresh on entity configuration for weekly or monthly schedules. See refreshOnDay Block.
    TimeOfTheDay string
    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 string
    Timezone that you want the refresh schedule to use.
    interval string
    Interval between scheduled refreshes. Valid values are MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY and MONTHLY.
    refresh_on_day object
    Refresh on entity configuration for weekly or monthly schedules. See refreshOnDay Block.
    time_of_the_day string
    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 string
    Timezone that you want the refresh schedule to use.
    interval String
    Interval between scheduled refreshes. Valid values are MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY and MONTHLY.
    refreshOnDay RefreshScheduleScheduleScheduleFrequencyRefreshOnDay
    Refresh on entity configuration for weekly or monthly schedules. See refreshOnDay Block.
    timeOfTheDay String
    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 String
    Timezone that you want the refresh schedule to use.
    interval string
    Interval between scheduled refreshes. Valid values are MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY and MONTHLY.
    refreshOnDay RefreshScheduleScheduleScheduleFrequencyRefreshOnDay
    Refresh on entity configuration for weekly or monthly schedules. See refreshOnDay Block.
    timeOfTheDay string
    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 string
    Timezone that you want the refresh schedule to use.
    interval str
    Interval between scheduled refreshes. Valid values are MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY and MONTHLY.
    refresh_on_day RefreshScheduleScheduleScheduleFrequencyRefreshOnDay
    Refresh on entity configuration for weekly or monthly schedules. See refreshOnDay Block.
    time_of_the_day str
    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 str
    Timezone that you want the refresh schedule to use.
    interval String
    Interval between scheduled refreshes. Valid values are MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY and MONTHLY.
    refreshOnDay Property Map
    Refresh on entity configuration for weekly or monthly schedules. See refreshOnDay Block.
    timeOfTheDay String
    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 String
    Timezone that you want the refresh schedule to use.

    RefreshScheduleScheduleScheduleFrequencyRefreshOnDay, RefreshScheduleScheduleScheduleFrequencyRefreshOnDayArgs

    DayOfMonth string
    Day of the month that you want to schedule refresh on.
    DayOfWeek string
    Day of the week that you want to schedule a refresh on. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY and SATURDAY.
    DayOfMonth string
    Day of the month that you want to schedule refresh on.
    DayOfWeek string
    Day of the week that you want to schedule a refresh on. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY and SATURDAY.
    day_of_month string
    Day of the month that you want to schedule refresh on.
    day_of_week string
    Day of the week that you want to schedule a refresh on. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY and SATURDAY.
    dayOfMonth String
    Day of the month that you want to schedule refresh on.
    dayOfWeek String
    Day of the week that you want to schedule a refresh on. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY and SATURDAY.
    dayOfMonth string
    Day of the month that you want to schedule refresh on.
    dayOfWeek string
    Day of the week that you want to schedule a refresh on. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY and SATURDAY.
    day_of_month str
    Day of the month that you want to schedule refresh on.
    day_of_week str
    Day of the week that you want to schedule a refresh on. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY and SATURDAY.
    dayOfMonth String
    Day of the month that you want to schedule refresh on.
    dayOfWeek String
    Day of the week that you want to schedule a refresh on. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY and SATURDAY.

    Import

    Using pulumi import, import a QuickSight Refresh Schedule using the AWS account ID, data set ID and schedule ID separated by commas (,). For example:

    $ pulumi import aws:quicksight/refreshSchedule:RefreshSchedule example 123456789012,dataset-id,schedule-id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.52.1
    published on Wednesday, Oct 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial