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	awscc.databrew.schedules

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
name	string	Schedule Name
region	string	AWS region.

For more information, see AWS::DataBrew::Schedule.

Methods

Name	Resource	Accessible by	Required Params
create_resource	schedules	INSERT	Name, CronExpression, region
delete_resource	schedules	DELETE	Identifier, region
update_resource	schedules	UPDATE	Identifier, PatchDocument, region
list_resources	schedules_list_only	SELECT	region
get_resource	schedules	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual schedule.

SELECT
  region,
  job_names,
  cron_expression,
  name,
  tags
FROM awscc.databrew.schedules
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all schedules in a region.

SELECT
  region,
  name
FROM awscc.databrew.schedules_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.databrew.schedules (
  CronExpression,
  Name,
  region
)
SELECT
  '{{ cron_expression }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.databrew.schedules (
  JobNames,
  CronExpression,
  Name,
  Tags,
  region
)
SELECT
  '{{ job_names }}',
  '{{ cron_expression }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ 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: schedule
  props:
    - name: job_names
      value:
        - '{{ job_names[0] }}'
    - name: cron_expression
      value: '{{ cron_expression }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.databrew.schedules
SET PatchDocument = string('{{ {
    "JobNames": job_names,
    "CronExpression": cron_expression,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.databrew.schedules
WHERE
  Identifier = '{{ name }}' 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 schedules resource, the following permissions are required:

Create

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

Read

databrew:DescribeSchedule,
iam:ListRoles

Update

databrew:UpdateSchedule,
databrew:TagResource,
databrew:UntagResource

Delete

databrew:DeleteSchedule

List

databrew:ListSchedules,
databrew:ListTagsForResource,
iam:ListRoles