refresh_schedules

Creates, updates, deletes or gets a refresh_schedule resource or lists refresh_schedules in a region

Overview

Name	refresh_schedules
Type	Resource
Description	Definition of the AWS::QuickSight::RefreshSchedule Resource Type.
Id	awscc.quicksight.refresh_schedules

Fields

get (all properties)

Name	Datatype	Description
arn	string	<p>The Amazon Resource Name (ARN) of the data source.</p>
aws_account_id	string
data_set_id	string
▶schedule	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
aws_account_id	string
data_set_id	string
▶schedule	object
region	string	AWS region.

For more information, see AWS::QuickSight::RefreshSchedule.

Methods

Name	Resource	Accessible by	Required Params
create_resource	refresh_schedules	INSERT	, region
delete_resource	refresh_schedules	DELETE	Identifier, region
update_resource	refresh_schedules	UPDATE	Identifier, PatchDocument, region
list_resources	refresh_schedules_list_only	SELECT	region
get_resource	refresh_schedules	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual refresh_schedule.

SELECT
  region,
  arn,
  aws_account_id,
  data_set_id,
  schedule
FROM awscc.quicksight.refresh_schedules
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ aws_account_id }}|{{ data_set_id }}|{{ schedule/schedule_id }}';

list (identifiers only)

Lists all refresh_schedules in a region.

SELECT
  region,
  aws_account_id,
  data_set_id,
  schedule/schedule_id
FROM awscc.quicksight.refresh_schedules_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new refresh_schedule resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.quicksight.refresh_schedules (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.quicksight.refresh_schedules (
  AwsAccountId,
  DataSetId,
  Schedule,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ data_set_id }}',
  '{{ schedule }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: refresh_schedule
    props:
      - name: aws_account_id
        value: '{{ aws_account_id }}'
      - name: data_set_id
        value: '{{ data_set_id }}'
      - name: schedule
        value:
          schedule_id: '{{ schedule_id }}'
          schedule_frequency:
            interval: '{{ interval }}'
            refresh_on_day:
              day_of_week: '{{ day_of_week }}'
              day_of_month: '{{ day_of_month }}'
            time_zone: '{{ time_zone }}'
            time_of_the_day: '{{ time_of_the_day }}'
          start_after_date_time: '{{ start_after_date_time }}'
          refresh_type: '{{ refresh_type }}'

DELETE example

/*+ delete */
DELETE FROM awscc.quicksight.refresh_schedules
WHERE
  Identifier = '{{ aws_account_id }}|{{ data_set_id }}|{{ schedule/schedule_id }}' AND
  region = 'us-east-1';

Permissions

To operate on the refresh_schedules resource, the following permissions are required:

Create

quicksight:CreateRefreshSchedule,
quicksight:DescribeRefreshSchedule

Update

quicksight:UpdateRefreshSchedule,
quicksight:DescribeRefreshSchedule

Delete

quicksight:DeleteRefreshSchedule,
quicksight:DescribeRefreshSchedule

List

quicksight:ListRefreshSchedules

Read

quicksight:DescribeRefreshSchedule