schedules

Creates, updates, deletes or gets a schedule resource or lists schedules in a region

Overview

Name	schedules
Type	Resource
Description	Resource schema for AWS::DataBrew::Schedule.
Id	aws.databrew.schedules

Fields

Name	Datatype	Description
job_names	array
cron_expression	string	Schedule cron
name	string	Schedule Name
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, CronExpression, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all schedules in a region.

SELECT
region,
job_names,
cron_expression,
name,
tags
FROM aws.databrew.schedules
WHERE region = 'us-east-1';

Gets all properties from an individual schedule.

SELECT
region,
job_names,
cron_expression,
name,
tags
FROM aws.databrew.schedules
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.databrew.schedules (
 CronExpression,
 Name,
 region
)
SELECT 
'{{ CronExpression }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.databrew.schedules (
 JobNames,
 CronExpression,
 Name,
 Tags,
 region
)
SELECT 
 '{{ JobNames }}',
 '{{ CronExpression }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: schedule
    props:
      - name: JobNames
        value:
          - '{{ JobNames[0] }}'
      - name: CronExpression
        value: '{{ CronExpression }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.databrew.schedules
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

databrew:CreateSchedule,
databrew:TagResource,
databrew:UntagResource,
iam:PassRole

Read

databrew:DescribeSchedule,
databrew:ListTagsForResource,
iam:ListRoles

Update

databrew:UpdateSchedule

Delete

databrew:DeleteSchedule

List

databrew:ListSchedules,
databrew:ListTagsForResource,
iam:ListRoles