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	The Amazon Resource Name (ARN) of the data source.
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 = '{{ region }}' 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 = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.quicksight.refresh_schedules (
  AwsAccountId,
  DataSetId,
  Schedule,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ data_set_id }}',
  '{{ schedule }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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