CfnRefreshSchedulePropsMixin

class aws_cdk.mixins_preview.aws_quicksight.mixins.CfnRefreshSchedulePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a refresh schedule for a dataset in Quick Suite .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html
CloudformationResource:: AWS::QuickSight::RefreshSchedule
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_refresh_schedule_props_mixin = quicksight_mixins.CfnRefreshSchedulePropsMixin(quicksight_mixins.CfnRefreshScheduleMixinProps(
    aws_account_id="awsAccountId",
    data_set_id="dataSetId",
    schedule=quicksight_mixins.CfnRefreshSchedulePropsMixin.RefreshScheduleMapProperty(
        refresh_type="refreshType",
        schedule_frequency=quicksight_mixins.CfnRefreshSchedulePropsMixin.ScheduleFrequencyProperty(
            interval="interval",
            refresh_on_day=quicksight_mixins.CfnRefreshSchedulePropsMixin.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"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::QuickSight::RefreshSchedule.

Parameters:

props (Union[CfnRefreshScheduleMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['awsAccountId', 'dataSetId', 'schedule']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

RefreshOnDayProperty

class CfnRefreshSchedulePropsMixin.RefreshOnDayProperty(*, day_of_month=None, day_of_week=None)

Bases: object

The day that you want yout dataset to refresh.

Parameters:

day_of_month (Optional[str]) – The day of the month that you want your dataset to refresh. This value is required for monthly refresh intervals.
day_of_week (Optional[str]) – The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

refresh_on_day_property = quicksight_mixins.CfnRefreshSchedulePropsMixin.RefreshOnDayProperty(
    day_of_month="dayOfMonth",
    day_of_week="dayOfWeek"
)

Attributes

day_of_month

The day of the month that you want your dataset to refresh.

This value is required for monthly refresh intervals.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshonday.html#cfn-quicksight-refreshschedule-refreshonday-dayofmonth

day_of_week

The day of the week that you want to schedule the refresh on.

This value is required for weekly and monthly refresh intervals.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshonday.html#cfn-quicksight-refreshschedule-refreshonday-dayofweek

RefreshScheduleMapProperty

class CfnRefreshSchedulePropsMixin.RefreshScheduleMapProperty(*, refresh_type=None, schedule_frequency=None, schedule_id=None, start_after_date_time=None)

Bases: object

A summary of a configured refresh schedule for a dataset.

Parameters:

refresh_type (Optional[str]) – 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 Quick Suite User Guide .
schedule_frequency (Union[IResolvable, ScheduleFrequencyProperty, Dict[str, Any], None]) – The frequency for the refresh schedule.
schedule_id (Optional[str]) – An identifier for the refresh schedule.
start_after_date_time (Optional[str]) – Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

refresh_schedule_map_property = quicksight_mixins.CfnRefreshSchedulePropsMixin.RefreshScheduleMapProperty(
    refresh_type="refreshType",
    schedule_frequency=quicksight_mixins.CfnRefreshSchedulePropsMixin.ScheduleFrequencyProperty(
        interval="interval",
        refresh_on_day=quicksight_mixins.CfnRefreshSchedulePropsMixin.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

refresh_type

.

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 Quick Suite User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-refreshtype
Type:: The type of refresh that a dataset undergoes. Valid values are as follows

schedule_frequency

The frequency for the refresh schedule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-schedulefrequency

schedule_id

An identifier for the refresh schedule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-scheduleid

start_after_date_time

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-startafterdatetime

ScheduleFrequencyProperty

class CfnRefreshSchedulePropsMixin.ScheduleFrequencyProperty(*, interval=None, refresh_on_day=None, time_of_the_day=None, time_zone=None)

Bases: object

The frequency for the refresh schedule.

Parameters:

interval (Optional[str]) – The interval between scheduled refreshes. Valid values are as follows:. - MINUTE15 : The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. - MINUTE30 : The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. - HOURLY : The dataset refreshes every hour. This interval can only be used for one schedule per dataset. - DAILY : The dataset refreshes every day. - WEEKLY : The dataset refreshes every week. - MONTHLY : The dataset refreshes every month.
refresh_on_day (Union[IResolvable, RefreshOnDayProperty, Dict[str, Any], None]) – The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.
time_of_the_day (Optional[str]) – The 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.
time_zone (Optional[str]) – The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs() .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

schedule_frequency_property = quicksight_mixins.CfnRefreshSchedulePropsMixin.ScheduleFrequencyProperty(
    interval="interval",
    refresh_on_day=quicksight_mixins.CfnRefreshSchedulePropsMixin.RefreshOnDayProperty(
        day_of_month="dayOfMonth",
        day_of_week="dayOfWeek"
    ),
    time_of_the_day="timeOfTheDay",
    time_zone="timeZone"
)

Attributes

interval

.

MINUTE15 : The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
MINUTE30 : The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
HOURLY : The dataset refreshes every hour. This interval can only be used for one schedule per dataset.
DAILY : The dataset refreshes every day.
WEEKLY : The dataset refreshes every week.
MONTHLY : The dataset refreshes every month.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-interval
Type:: The interval between scheduled refreshes. Valid values are as follows

refresh_on_day

The day of the week that you want to schedule the refresh on.

This value is required for weekly and monthly refresh intervals.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-refreshonday

time_of_the_day

The 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-timeoftheday

time_zone

The timezone that you want the refresh schedule to use.

The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs() .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-timezone