event_bridge_rule_template_groups
Creates, updates, deletes, gets or lists an event_bridge_rule_template_groups resource.
Overview
| Name | event_bridge_rule_template_groups |
| Type | Resource |
| Id | aws.medialive.event_bridge_rule_template_groups |
Fields
The following fields are returned by SELECT queries:
- get_event_bridge_rule_template_group
- list_event_bridge_rule_template_groups
| Name | Datatype | Description |
|---|---|---|
arn | string | An eventbridge rule template group's ARN (Amazon Resource Name) |
created_at | string (date-time) | Placeholder documentation for __timestampIso8601 |
description | string | Placeholder documentation for __stringMin0Max1024 |
id | string | Placeholder documentation for __stringMin7Max11PatternAws097 |
modified_at | string (date-time) | Placeholder documentation for __timestampIso8601 |
name | string | Placeholder documentation for __stringMin1Max255PatternS |
tags | object |
| Name | Datatype | Description |
|---|---|---|
arn | string | An eventbridge rule template group's ARN (Amazon Resource Name) |
created_at | string (date-time) | Placeholder documentation for __timestampIso8601 |
description | string | Placeholder documentation for __stringMin0Max1024 |
id | string | An eventbridge rule template group's id. AWS provided template groups have ids that start with aws- |
modified_at | string (date-time) | Placeholder documentation for __timestampIso8601 |
name | string | Placeholder documentation for __stringMin1Max255PatternS |
tags | object | |
template_count | integer | The number of templates in a group. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_event_bridge_rule_template_group | select | identifier, region | Retrieves the specified eventbridge rule template group. | |
list_event_bridge_rule_template_groups | select | region | maxResults, nextToken, signalMapIdentifier | Lists eventbridge rule template groups. |
create_event_bridge_rule_template_group | insert | region | Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules. | |
update_event_bridge_rule_template_group | update | identifier, region | Updates the specified eventbridge rule template group. | |
delete_event_bridge_rule_template_group | delete | identifier, region | Deletes an eventbridge rule template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
identifier | string | An eventbridge rule template group's identifier. Can be either be its id or current name. |
region | string | AWS region (default: us-east-1) |
maxResults | integer | |
nextToken | string | A token used to retrieve the next set of results in paginated list responses. |
signalMapIdentifier | string | A signal map's identifier. Can be either be its id or current name. |
SELECT examples
- get_event_bridge_rule_template_group
- list_event_bridge_rule_template_groups
Retrieves the specified eventbridge rule template group.
SELECT
arn,
created_at,
description,
id,
modified_at,
name,
tags
FROM aws.medialive.event_bridge_rule_template_groups
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;
Lists eventbridge rule template groups.
SELECT
arn,
created_at,
description,
id,
modified_at,
name,
tags,
template_count
FROM aws.medialive.event_bridge_rule_template_groups
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND signalMapIdentifier = '{{ signalMapIdentifier }}'
;
INSERT examples
- create_event_bridge_rule_template_group
- Manifest
Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.
INSERT INTO aws.medialive.event_bridge_rule_template_groups (
Description,
Name,
Tags,
RequestId,
region
)
SELECT
'{{ Description }}',
'{{ Name }}',
'{{ Tags }}',
'{{ RequestId }}',
'{{ region }}'
RETURNING
arn,
created_at,
description,
id,
modified_at,
name,
tags
;
# Description fields are for documentation purposes
- name: event_bridge_rule_template_groups
props:
- name: region
value: "{{ region }}"
description: Required parameter for the event_bridge_rule_template_groups resource.
- name: Description
value: "{{ Description }}"
description: |
Placeholder documentation for __stringMin0Max1024
- name: Name
value: "{{ Name }}"
description: |
Placeholder documentation for __stringMin1Max255PatternS
- name: Tags
value: "{{ Tags }}"
description: |
Represents the tags associated with a resource.
- name: RequestId
value: "{{ RequestId }}"
description: |
Placeholder documentation for __stringMin1Max256PatternS
UPDATE examples
- update_event_bridge_rule_template_group
Updates the specified eventbridge rule template group.
UPDATE aws.medialive.event_bridge_rule_template_groups
SET
Description = '{{ Description }}'
WHERE
identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
created_at,
description,
id,
modified_at,
name,
tags;
DELETE examples
- delete_event_bridge_rule_template_group
Deletes an eventbridge rule template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.
DELETE FROM aws.medialive.event_bridge_rule_template_groups
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;