triggers

Creates, updates, deletes or gets a trigger resource or lists triggers in a region

Overview

Name	triggers
Type	Resource
Description	Resource Type definition for AWS::Glue::Trigger
Id	awscc.glue.triggers

Fields

get (all properties)

Name	Datatype	Description
type	string	The type of trigger that this is.
start_on_creation	boolean	Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.
description	string	A description of this trigger.
▶actions	array	The actions initiated by this trigger.
▶event_batching_condition	object	Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
workflow_name	string	The name of the workflow associated with the trigger.
schedule	string	A cron expression used to specify the schedule.
tags	object	The tags to use with this trigger.
name	string	The name of the trigger.
▶predicate	object	The predicate of this trigger, which defines when it will fire.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the trigger.
region	string	AWS region.

For more information, see AWS::Glue::Trigger.

Methods

Name	Resource	Accessible by	Required Params
create_resource	triggers	INSERT	Type, Actions, region
delete_resource	triggers	DELETE	Identifier, region
update_resource	triggers	UPDATE	Identifier, PatchDocument, region
list_resources	triggers_list_only	SELECT	region
get_resource	triggers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual trigger.

SELECT
  region,
  type,
  start_on_creation,
  description,
  actions,
  event_batching_condition,
  workflow_name,
  schedule,
  tags,
  name,
  predicate
FROM awscc.glue.triggers
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all triggers in a region.

SELECT
  region,
  name
FROM awscc.glue.triggers_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.glue.triggers (
  Type,
  Actions,
  region
)
SELECT
  '{{ type }}',
  '{{ actions }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.glue.triggers (
  Type,
  StartOnCreation,
  Description,
  Actions,
  EventBatchingCondition,
  WorkflowName,
  Schedule,
  Tags,
  Name,
  Predicate,
  region
)
SELECT
  '{{ type }}',
  '{{ start_on_creation }}',
  '{{ description }}',
  '{{ actions }}',
  '{{ event_batching_condition }}',
  '{{ workflow_name }}',
  '{{ schedule }}',
  '{{ tags }}',
  '{{ name }}',
  '{{ predicate }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: trigger
    props:
      - name: type
        value: '{{ type }}'
      - name: start_on_creation
        value: '{{ start_on_creation }}'
      - name: description
        value: '{{ description }}'
      - name: actions
        value:
          - notification_property:
              notify_delay_after: '{{ notify_delay_after }}'
            crawler_name: '{{ crawler_name }}'
            timeout: '{{ timeout }}'
            job_name: '{{ job_name }}'
            arguments: {}
            security_configuration: '{{ security_configuration }}'
      - name: event_batching_condition
        value:
          batch_size: '{{ batch_size }}'
          batch_window: '{{ batch_window }}'
      - name: workflow_name
        value: '{{ workflow_name }}'
      - name: schedule
        value: '{{ schedule }}'
      - name: tags
        value: {}
      - name: name
        value: '{{ name }}'
      - name: predicate
        value:
          logical: '{{ logical }}'
          conditions:
            - job_name: '{{ job_name }}'
              crawler_name: '{{ crawler_name }}'
              state: '{{ state }}'
              crawl_state: '{{ crawl_state }}'
              logical_operator: '{{ logical_operator }}'

UPDATE example

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

/*+ update */
UPDATE awscc.glue.triggers
SET PatchDocument = string('{{ {
    "StartOnCreation": start_on_creation,
    "Description": description,
    "Actions": actions,
    "EventBatchingCondition": event_batching_condition,
    "Schedule": schedule,
    "Tags": tags,
    "Predicate": predicate
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.glue.triggers
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1';

Permissions

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

Create

glue:CreateTrigger,
glue:GetTrigger,
glue:TagResource

Read

glue:GetTrigger,
glue:GetTags

Update

glue:UpdateTrigger,
glue:UntagResource,
glue:TagResource

Delete

glue:DeleteTrigger,
glue:GetTrigger

List

glue:ListTriggers