RefreshSchedule class
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")
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 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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_refreshschedule" "example" {
schedule = {
schedule_frequency = {
interval = "HOURLY"
}
refresh_type = "FULL_REFRESH"
}
data_set_id = "dataset-id"
schedule_id = "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
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")
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 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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "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 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
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")
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 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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "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 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
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
Constructors
- RefreshSchedule(String name, {RefreshScheduleArgs? args, CustomResourceOptions? options})
-
Creates a new RefreshSchedule.
nameThe Pulumi resource name.argsArguments used to configure this RefreshSchedule. The set of arguments for RefreshSchedule.optionsResource options controlling this resource's behavior. - RefreshSchedule.reference(String urn)
- Creates a typed reference to an existing RefreshSchedule resource.
Properties
-
arn
↔ Output<
String> -
ARN of the refresh schedule.
latefinal
-
awsAccountId
↔ Output<
String> -
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dataSetId
↔ Output<
String> -
The ID of the dataset.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schedule
↔ Output<
RefreshScheduleSchedule> -
The refresh schedule. See schedule
latefinal
-
scheduleId
↔ Output<
String> -
The ID of the refresh schedule.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {RefreshScheduleState? state, CustomResourceOptions? options}) → RefreshSchedule -
Gets an existing RefreshSchedule resource's state with the given
nameandid.