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	awscc.scheduler.schedule_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string
region	string	AWS region.

For more information, see AWS::Scheduler::ScheduleGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	schedule_groups	INSERT	region
delete_resource	schedule_groups	DELETE	Identifier, region
update_resource	schedule_groups	UPDATE	Identifier, PatchDocument, region
list_resources	schedule_groups_list_only	SELECT	region
get_resource	schedule_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual schedule_group.

SELECT
  region,
  arn,
  creation_date,
  last_modification_date,
  name,
  state,
  tags
FROM awscc.scheduler.schedule_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all schedule_groups in a region.

SELECT
  region,
  name
FROM awscc.scheduler.schedule_groups_list_only
WHERE
  region = '{{ region }}';

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 awscc.scheduler.schedule_groups (
  Name,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.scheduler.schedule_groups (
  Name,
  Tags,
  region
)
SELECT
  '{{ 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_group
  props:
    - 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_group resource, using stack-deploy.

/*+ update */
UPDATE awscc.scheduler.schedule_groups
SET PatchDocument = string('{{ {
    "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.scheduler.schedule_groups
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 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