schedule_groups

Creates, updates, deletes or gets a schedule_group resource or lists schedule_groups in a region

Overview

Name	schedule_groups
Type	Resource
Description	Definition of AWS::Scheduler::ScheduleGroup Resource Type
Id	aws.scheduler.schedule_groups

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the schedule group.
creation_date	string	The time at which the schedule group was created.
last_modification_date	string	The time at which the schedule group was last modified.
name	string
state	string	Specifies the state of the schedule group.
tags	array	The list of tags to associate with the schedule group.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 schedule_groups in a region.

SELECT
region,
arn,
creation_date,
last_modification_date,
name,
state,
tags
FROM aws.scheduler.schedule_groups
WHERE region = 'us-east-1';

Gets all properties from an individual schedule_group.

SELECT
region,
arn,
creation_date,
last_modification_date,
name,
state,
tags
FROM aws.scheduler.schedule_groups
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.scheduler.schedule_groups (
 Name,
 Tags,
 region
)
SELECT 
'{{ Name }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.scheduler.schedule_groups (
 Name,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: schedule_group
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

scheduler:TagResource,
scheduler:CreateScheduleGroup,
scheduler:GetScheduleGroup,
scheduler:ListTagsForResource

Read

scheduler:GetScheduleGroup,
scheduler:ListTagsForResource

Update

scheduler:TagResource,
scheduler:UntagResource,
scheduler:ListTagsForResource,
scheduler:GetScheduleGroup

Delete

scheduler:DeleteScheduleGroup,
scheduler:GetScheduleGroup,
scheduler:DeleteSchedule

List

scheduler:ListScheduleGroups