@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
181 lines (180 loc) • 6.22 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing a QuickSight Refresh Schedule.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.RefreshSchedule("example", {
* dataSetId: "dataset-id",
* scheduleId: "schedule-id",
* schedule: {
* refreshType: "FULL_REFRESH",
* scheduleFrequency: {
* interval: "HOURLY",
* },
* },
* });
* ```
*
* ### With Weekly Refresh
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.RefreshSchedule("example", {
* dataSetId: "dataset-id",
* scheduleId: "schedule-id",
* schedule: {
* refreshType: "INCREMENTAL_REFRESH",
* scheduleFrequency: {
* interval: "WEEKLY",
* timeOfTheDay: "01:00",
* timezone: "Europe/London",
* refreshOnDay: {
* dayOfWeek: "MONDAY",
* },
* },
* },
* });
* ```
*
* ### With Monthly Refresh
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.RefreshSchedule("example", {
* dataSetId: "dataset-id",
* scheduleId: "schedule-id",
* schedule: {
* refreshType: "INCREMENTAL_REFRESH",
* scheduleFrequency: {
* interval: "MONTHLY",
* timeOfTheDay: "01:00",
* timezone: "Europe/London",
* refreshOnDay: {
* dayOfMonth: "1",
* },
* },
* },
* });
* ```
*
* ## 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:
*
* ```sh
* $ pulumi import aws:quicksight/refreshSchedule:RefreshSchedule example 123456789012,dataset-id,schedule-id
* ```
*/
export declare class RefreshSchedule extends pulumi.CustomResource {
/**
* Get an existing RefreshSchedule resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RefreshScheduleState, opts?: pulumi.CustomResourceOptions): RefreshSchedule;
/**
* Returns true if the given object is an instance of RefreshSchedule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is RefreshSchedule;
/**
* Amazon Resource Name (ARN) of the refresh schedule.
*/
readonly arn: pulumi.Output<string>;
readonly awsAccountId: pulumi.Output<string>;
/**
* The ID of the dataset.
*/
readonly dataSetId: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* The [refresh schedule](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RefreshSchedule.html). See schedule
*
* The following arguments are optional:
*/
readonly schedule: pulumi.Output<outputs.quicksight.RefreshScheduleSchedule | undefined>;
/**
* The ID of the refresh schedule.
*/
readonly scheduleId: pulumi.Output<string>;
/**
* Create a RefreshSchedule resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: RefreshScheduleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RefreshSchedule resources.
*/
export interface RefreshScheduleState {
/**
* Amazon Resource Name (ARN) of the refresh schedule.
*/
arn?: pulumi.Input<string>;
awsAccountId?: pulumi.Input<string>;
/**
* The ID of the dataset.
*/
dataSetId?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The [refresh schedule](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RefreshSchedule.html). See schedule
*
* The following arguments are optional:
*/
schedule?: pulumi.Input<inputs.quicksight.RefreshScheduleSchedule>;
/**
* The ID of the refresh schedule.
*/
scheduleId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RefreshSchedule resource.
*/
export interface RefreshScheduleArgs {
awsAccountId?: pulumi.Input<string>;
/**
* The ID of the dataset.
*/
dataSetId: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The [refresh schedule](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RefreshSchedule.html). See schedule
*
* The following arguments are optional:
*/
schedule?: pulumi.Input<inputs.quicksight.RefreshScheduleSchedule>;
/**
* The ID of the refresh schedule.
*/
scheduleId: pulumi.Input<string>;
}