event_bridge_rule_templates

Creates, updates, deletes or gets an event_bridge_rule_template resource or lists event_bridge_rule_templates in a region

Overview

Name	event_bridge_rule_templates
Type	Resource
Description	Definition of AWS::MediaLive::EventBridgeRuleTemplate Resource Type
Id	awscc.medialive.event_bridge_rule_templates

Fields

get (all properties)

Name	Datatype	Description
arn	string	An eventbridge rule template's ARN (Amazon Resource Name)
created_at	string	Placeholder documentation for __timestampIso8601
description	string	A resource's optional description.
▶event_targets	array	Placeholder documentation for __listOfEventBridgeRuleTemplateTarget
event_type	string	The type of event to match with the rule.
group_id	string	An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
group_identifier	string	An eventbridge rule template group's identifier. Can be either be its id or current name.
id	string	An eventbridge rule template's id. AWS provided templates have ids that start with aws-
identifier	string	Placeholder documentation for __string
modified_at	string	Placeholder documentation for __timestampIso8601
name	string	A resource's name. Names must be unique within the scope of a resource type in a specific region.
tags	object	Represents the tags associated with a resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	An eventbridge rule template's id. AWS provided templates have ids that start with aws-
identifier	string	Placeholder documentation for __string
region	string	AWS region.

For more information, see AWS::MediaLive::EventBridgeRuleTemplate.

Methods

Name	Resource	Accessible by	Required Params
create_resource	event_bridge_rule_templates	INSERT	EventType, Name, region
delete_resource	event_bridge_rule_templates	DELETE	Identifier, region
update_resource	event_bridge_rule_templates	UPDATE	Identifier, PatchDocument, region
list_resources	event_bridge_rule_templates_list_only	SELECT	region
get_resource	event_bridge_rule_templates	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual event_bridge_rule_template.

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

list (identifiers only)

Lists all event_bridge_rule_templates in a region.

SELECT
  region,
  identifier
FROM awscc.medialive.event_bridge_rule_templates_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.medialive.event_bridge_rule_templates (
  EventType,
  Name,
  region
)
SELECT
  '{{ event_type }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.medialive.event_bridge_rule_templates (
  Description,
  EventTargets,
  EventType,
  GroupIdentifier,
  Name,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ event_targets }}',
  '{{ event_type }}',
  '{{ group_identifier }}',
  '{{ 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: event_bridge_rule_template
  props:
    - name: description
      value: '{{ description }}'
    - name: event_targets
      value:
        - arn: '{{ arn }}'
    - name: event_type
      value: '{{ event_type }}'
    - name: group_identifier
      value: '{{ group_identifier }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.medialive.event_bridge_rule_templates
SET PatchDocument = string('{{ {
    "Description": description,
    "EventTargets": event_targets,
    "EventType": event_type,
    "GroupIdentifier": group_identifier,
    "Name": name
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ identifier }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.medialive.event_bridge_rule_templates
WHERE
  Identifier = '{{ identifier }}' 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 event_bridge_rule_templates resource, the following permissions are required:

Create

medialive:CreateEventBridgeRuleTemplate,
medialive:GetEventBridgeRuleTemplate,
medialive:CreateTags

Read

medialive:GetEventBridgeRuleTemplate

Update

medialive:UpdateEventBridgeRuleTemplate,
medialive:GetEventBridgeRuleTemplate,
medialive:CreateTags,
medialive:DeleteTags

Delete

medialive:DeleteEventBridgeRuleTemplate

List

medialive:ListEventBridgeRuleTemplates