Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. quicksight
  5. RefreshSchedule

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.quicksight.RefreshSchedule

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of the AWS::QuickSight::RefreshSchedule Resource Type.

    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: Optional[RefreshScheduleArgs] = None,
                    opts: Optional[ResourceOptions] = None)

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

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

    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.

    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

    The RefreshSchedule resource accepts the following input properties:

    AwsAccountId string
    The AWS account ID of the account that you are creating a schedule in.
    DataSetId string
    The ID of the dataset that you are creating a refresh schedule for.
    Schedule Pulumi.AwsNative.QuickSight.Inputs.RefreshScheduleMap
    The refresh schedule of a dataset.
    AwsAccountId string
    The AWS account ID of the account that you are creating a schedule in.
    DataSetId string
    The ID of the dataset that you are creating a refresh schedule for.
    Schedule RefreshScheduleMapArgs
    The refresh schedule of a dataset.
    awsAccountId String
    The AWS account ID of the account that you are creating a schedule in.
    dataSetId String
    The ID of the dataset that you are creating a refresh schedule for.
    schedule RefreshScheduleMap
    The refresh schedule of a dataset.
    awsAccountId string
    The AWS account ID of the account that you are creating a schedule in.
    dataSetId string
    The ID of the dataset that you are creating a refresh schedule for.
    schedule RefreshScheduleMap
    The refresh schedule of a dataset.
    aws_account_id str
    The AWS account ID of the account that you are creating a schedule in.
    data_set_id str
    The ID of the dataset that you are creating a refresh schedule for.
    schedule RefreshScheduleMapArgs
    The refresh schedule of a dataset.
    awsAccountId String
    The AWS account ID of the account that you are creating a schedule in.
    dataSetId String
    The ID of the dataset that you are creating a refresh schedule for.
    schedule Property Map
    The refresh schedule of a dataset.

    Outputs

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

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    RefreshScheduleMap, RefreshScheduleMapArgs

    RefreshType Pulumi.AwsNative.QuickSight.RefreshScheduleMapRefreshType

    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 Amazon QuickSight User Guide .

    ScheduleFrequency Pulumi.AwsNative.QuickSight.Inputs.RefreshScheduleMapScheduleFrequencyProperties
    ScheduleId string
    StartAfterDateTime string
    RefreshType RefreshScheduleMapRefreshType

    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 Amazon QuickSight User Guide .

    ScheduleFrequency RefreshScheduleMapScheduleFrequencyProperties
    ScheduleId string
    StartAfterDateTime string
    refreshType RefreshScheduleMapRefreshType

    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 Amazon QuickSight User Guide .

    scheduleFrequency RefreshScheduleMapScheduleFrequencyProperties
    scheduleId String
    startAfterDateTime String
    refreshType RefreshScheduleMapRefreshType

    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 Amazon QuickSight User Guide .

    scheduleFrequency RefreshScheduleMapScheduleFrequencyProperties
    scheduleId string
    startAfterDateTime string
    refresh_type RefreshScheduleMapRefreshType

    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 Amazon QuickSight User Guide .

    schedule_frequency RefreshScheduleMapScheduleFrequencyProperties
    schedule_id str
    start_after_date_time str
    refreshType "FULL_REFRESH" | "INCREMENTAL_REFRESH"

    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 Amazon QuickSight User Guide .

    scheduleFrequency Property Map
    scheduleId String
    startAfterDateTime String

    RefreshScheduleMapRefreshType, RefreshScheduleMapRefreshTypeArgs

    FullRefresh
    FULL_REFRESH
    IncrementalRefresh
    INCREMENTAL_REFRESH
    RefreshScheduleMapRefreshTypeFullRefresh
    FULL_REFRESH
    RefreshScheduleMapRefreshTypeIncrementalRefresh
    INCREMENTAL_REFRESH
    FullRefresh
    FULL_REFRESH
    IncrementalRefresh
    INCREMENTAL_REFRESH
    FullRefresh
    FULL_REFRESH
    IncrementalRefresh
    INCREMENTAL_REFRESH
    FULL_REFRESH
    FULL_REFRESH
    INCREMENTAL_REFRESH
    INCREMENTAL_REFRESH
    "FULL_REFRESH"
    FULL_REFRESH
    "INCREMENTAL_REFRESH"
    INCREMENTAL_REFRESH

    RefreshScheduleMapScheduleFrequencyProperties, RefreshScheduleMapScheduleFrequencyPropertiesArgs

    RefreshScheduleMapScheduleFrequencyPropertiesInterval, RefreshScheduleMapScheduleFrequencyPropertiesIntervalArgs

    Minute15
    MINUTE15
    Minute30
    MINUTE30
    Hourly
    HOURLY
    Daily
    DAILY
    Weekly
    WEEKLY
    Monthly
    MONTHLY
    RefreshScheduleMapScheduleFrequencyPropertiesIntervalMinute15
    MINUTE15
    RefreshScheduleMapScheduleFrequencyPropertiesIntervalMinute30
    MINUTE30
    RefreshScheduleMapScheduleFrequencyPropertiesIntervalHourly
    HOURLY
    RefreshScheduleMapScheduleFrequencyPropertiesIntervalDaily
    DAILY
    RefreshScheduleMapScheduleFrequencyPropertiesIntervalWeekly
    WEEKLY
    RefreshScheduleMapScheduleFrequencyPropertiesIntervalMonthly
    MONTHLY
    Minute15
    MINUTE15
    Minute30
    MINUTE30
    Hourly
    HOURLY
    Daily
    DAILY
    Weekly
    WEEKLY
    Monthly
    MONTHLY
    Minute15
    MINUTE15
    Minute30
    MINUTE30
    Hourly
    HOURLY
    Daily
    DAILY
    Weekly
    WEEKLY
    Monthly
    MONTHLY
    MINUTE15
    MINUTE15
    MINUTE30
    MINUTE30
    HOURLY
    HOURLY
    DAILY
    DAILY
    WEEKLY
    WEEKLY
    MONTHLY
    MONTHLY
    "MINUTE15"
    MINUTE15
    "MINUTE30"
    MINUTE30
    "HOURLY"
    HOURLY
    "DAILY"
    DAILY
    "WEEKLY"
    WEEKLY
    "MONTHLY"
    MONTHLY

    RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayProperties, RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesArgs

    RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesDayOfWeek, RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesDayOfWeekArgs

    Sunday
    SUNDAY
    Monday
    MONDAY
    Tuesday
    TUESDAY
    Wednesday
    WEDNESDAY
    Thursday
    THURSDAY
    Friday
    FRIDAY
    Saturday
    SATURDAY
    RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesDayOfWeekSunday
    SUNDAY
    RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesDayOfWeekMonday
    MONDAY
    RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesDayOfWeekTuesday
    TUESDAY
    RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesDayOfWeekWednesday
    WEDNESDAY
    RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesDayOfWeekThursday
    THURSDAY
    RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesDayOfWeekFriday
    FRIDAY
    RefreshScheduleMapScheduleFrequencyPropertiesRefreshOnDayPropertiesDayOfWeekSaturday
    SATURDAY
    Sunday
    SUNDAY
    Monday
    MONDAY
    Tuesday
    TUESDAY
    Wednesday
    WEDNESDAY
    Thursday
    THURSDAY
    Friday
    FRIDAY
    Saturday
    SATURDAY
    Sunday
    SUNDAY
    Monday
    MONDAY
    Tuesday
    TUESDAY
    Wednesday
    WEDNESDAY
    Thursday
    THURSDAY
    Friday
    FRIDAY
    Saturday
    SATURDAY
    SUNDAY
    SUNDAY
    MONDAY
    MONDAY
    TUESDAY
    TUESDAY
    WEDNESDAY
    WEDNESDAY
    THURSDAY
    THURSDAY
    FRIDAY
    FRIDAY
    SATURDAY
    SATURDAY
    "SUNDAY"
    SUNDAY
    "MONDAY"
    MONDAY
    "TUESDAY"
    TUESDAY
    "WEDNESDAY"
    WEDNESDAY
    "THURSDAY"
    THURSDAY
    "FRIDAY"
    FRIDAY
    "SATURDAY"
    SATURDAY

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native