CfnRefreshScheduleProps

class aws_cdk.aws_quicksight.CfnRefreshScheduleProps(*, aws_account_id=None, data_set_id=None, schedule=None)

Bases: object

Properties for defining a CfnRefreshSchedule.

Parameters:
  • aws_account_id (Optional[str]) – The AWS account ID of the account that you are creating a schedule in.

  • data_set_id (Optional[str]) – The ID of the dataset that you are creating a refresh schedule for.

  • schedule (Union[IResolvable, RefreshScheduleMapProperty, Dict[str, Any], None]) – The refresh schedule of a dataset.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_quicksight as quicksight

cfn_refresh_schedule_props = quicksight.CfnRefreshScheduleProps(
    aws_account_id="awsAccountId",
    data_set_id="dataSetId",
    schedule=quicksight.CfnRefreshSchedule.RefreshScheduleMapProperty(
        refresh_type="refreshType",
        schedule_frequency=quicksight.CfnRefreshSchedule.ScheduleFrequencyProperty(
            interval="interval",
            refresh_on_day=quicksight.CfnRefreshSchedule.RefreshOnDayProperty(
                day_of_month="dayOfMonth",
                day_of_week="dayOfWeek"
            ),
            time_of_the_day="timeOfTheDay",
            time_zone="timeZone"
        ),
        schedule_id="scheduleId",
        start_after_date_time="startAfterDateTime"
    )
)

Attributes

aws_account_id

The AWS account ID of the account that you are creating a schedule in.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html#cfn-quicksight-refreshschedule-awsaccountid

data_set_id

The ID of the dataset that you are creating a refresh schedule for.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html#cfn-quicksight-refreshschedule-datasetid

schedule

The refresh schedule of a dataset.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html#cfn-quicksight-refreshschedule-schedule