event_bridge_rule_templates

Creates, updates, deletes, gets or lists an event_bridge_rule_templates resource.

Overview

Name	event_bridge_rule_templates
Type	Resource
Id	aws.medialive.event_bridge_rule_templates

Fields

The following fields are returned by SELECT queries:

get_event_bridge_rule_template

Name	Datatype	Description
arn	string	An eventbridge rule template's ARN (Amazon Resource Name)
created_at	string (date-time)	Placeholder documentation for __timestampIso8601
description	string	Placeholder documentation for __stringMin0Max1024
event_targets	array	Placeholder documentation for __listOfEventBridgeRuleTemplateTarget
event_type	string	The type of event to match with the rule. (MEDIALIVE_MULTIPLEX_ALERT, MEDIALIVE_MULTIPLEX_STATE_CHANGE, MEDIALIVE_CHANNEL_ALERT, MEDIALIVE_CHANNEL_INPUT_CHANGE, MEDIALIVE_CHANNEL_STATE_CHANGE, MEDIAPACKAGE_INPUT_NOTIFICATION, MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION, MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION, SIGNAL_MAP_ACTIVE_ALARM, MEDIACONNECT_ALERT, MEDIACONNECT_SOURCE_HEALTH, MEDIACONNECT_OUTPUT_HEALTH, MEDIACONNECT_FLOW_STATUS_CHANGE)
group_id	string	Placeholder documentation for __stringMin7Max11PatternAws097
id	string	Placeholder documentation for __stringMin7Max11PatternAws097
modified_at	string (date-time)	Placeholder documentation for __timestampIso8601
name	string	Placeholder documentation for __stringMin1Max255PatternS
tags	object

list_event_bridge_rule_templates

Name	Datatype	Description
arn	string	An eventbridge rule template's ARN (Amazon Resource Name)
created_at	string (date-time)	Placeholder documentation for __timestampIso8601
description	string	Placeholder documentation for __stringMin0Max1024
event_target_count	integer	The number of targets configured to send matching events.
event_type	string	The type of event to match with the rule. (MEDIALIVE_MULTIPLEX_ALERT, MEDIALIVE_MULTIPLEX_STATE_CHANGE, MEDIALIVE_CHANNEL_ALERT, MEDIALIVE_CHANNEL_INPUT_CHANGE, MEDIALIVE_CHANNEL_STATE_CHANGE, MEDIAPACKAGE_INPUT_NOTIFICATION, MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION, MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION, SIGNAL_MAP_ACTIVE_ALARM, MEDIACONNECT_ALERT, MEDIACONNECT_SOURCE_HEALTH, MEDIACONNECT_OUTPUT_HEALTH, MEDIACONNECT_FLOW_STATUS_CHANGE)
group_id	string	An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
id	string	An eventbridge rule template's id. AWS provided templates have ids that start with aws-
modified_at	string (date-time)	Placeholder documentation for __timestampIso8601
name	string	Placeholder documentation for __stringMin1Max255PatternS
tags	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_event_bridge_rule_template	select	identifier, region		Retrieves the specified eventbridge rule template.
list_event_bridge_rule_templates	select	region	groupIdentifier, maxResults, nextToken, signalMapIdentifier	Lists eventbridge rule templates.
create_event_bridge_rule_template	insert	region, EventType, GroupIdentifier		Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.
update_event_bridge_rule_template	update	identifier, region		Updates the specified eventbridge rule template.
delete_event_bridge_rule_template	delete	identifier, region		Deletes an eventbridge rule template.

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's identifier. Can be either be its id or current name.
region	string	AWS region (default: us-east-1)
groupIdentifier	string	An eventbridge rule template group's identifier. Can be either be its id or current name.
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

Retrieves the specified eventbridge rule template.

SELECT
arn,
created_at,
description,
event_targets,
event_type,
group_id,
id,
modified_at,
name,
tags
FROM aws.medialive.event_bridge_rule_templates
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_event_bridge_rule_templates

Lists eventbridge rule templates.

SELECT
arn,
created_at,
description,
event_target_count,
event_type,
group_id,
id,
modified_at,
name,
tags
FROM aws.medialive.event_bridge_rule_templates
WHERE region = '{{ region }}' -- required
AND groupIdentifier = '{{ groupIdentifier }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND signalMapIdentifier = '{{ signalMapIdentifier }}'
;

INSERT examples

create_event_bridge_rule_template

Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.

INSERT INTO aws.medialive.event_bridge_rule_templates (
Description,
EventTargets,
EventType,
GroupIdentifier,
Name,
Tags,
RequestId,
region
)
SELECT 
'{{ Description }}',
'{{ EventTargets }}',
'{{ EventType }}' /* required */,
'{{ GroupIdentifier }}' /* required */,
'{{ Name }}',
'{{ Tags }}',
'{{ RequestId }}',
'{{ region }}'
RETURNING
arn,
created_at,
description,
event_targets,
event_type,
group_id,
id,
modified_at,
name,
tags
;

Manifest

# Description fields are for documentation purposes
- name: event_bridge_rule_templates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the event_bridge_rule_templates resource.
  - name: Description
    value: "{{ Description }}"
    description: |
      Placeholder documentation for __stringMin0Max1024
  - name: EventTargets
    description: |
      Placeholder documentation for __listOfEventBridgeRuleTemplateTarget
    value:
      - Arn: "{{ Arn }}"
  - name: EventType
    value: "{{ EventType }}"
    description: |
      The type of event to match with the rule.
    valid_values: ['MEDIALIVE_MULTIPLEX_ALERT', 'MEDIALIVE_MULTIPLEX_STATE_CHANGE', 'MEDIALIVE_CHANNEL_ALERT', 'MEDIALIVE_CHANNEL_INPUT_CHANGE', 'MEDIALIVE_CHANNEL_STATE_CHANGE', 'MEDIAPACKAGE_INPUT_NOTIFICATION', 'MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION', 'MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION', 'SIGNAL_MAP_ACTIVE_ALARM', 'MEDIACONNECT_ALERT', 'MEDIACONNECT_SOURCE_HEALTH', 'MEDIACONNECT_OUTPUT_HEALTH', 'MEDIACONNECT_FLOW_STATUS_CHANGE']
  - name: GroupIdentifier
    value: "{{ GroupIdentifier }}"
    description: |
      Placeholder documentation for __stringPatternS
  - 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

Updates the specified eventbridge rule template.

UPDATE aws.medialive.event_bridge_rule_templates
SET 
Description = '{{ Description }}',
EventTargets = '{{ EventTargets }}',
EventType = '{{ EventType }}',
GroupIdentifier = '{{ GroupIdentifier }}',
Name = '{{ Name }}'
WHERE 
identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
created_at,
description,
event_targets,
event_type,
group_id,
id,
modified_at,
name,
tags;

DELETE examples

delete_event_bridge_rule_template

Deletes an eventbridge rule template.

DELETE FROM aws.medialive.event_bridge_rule_templates
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;