cloud_watch_alarm_template_groups

Creates, updates, deletes or gets a cloud_watch_alarm_template_group resource or lists cloud_watch_alarm_template_groups in a region

Overview

Name	cloud_watch_alarm_template_groups
Type	Resource
Description	Definition of AWS::MediaLive::CloudWatchAlarmTemplateGroup Resource Type
Id	awscc.medialive.cloud_watch_alarm_template_groups

Fields

get (all properties)

Name	Datatype	Description
arn	string	A cloudwatch alarm template group's ARN (Amazon Resource Name)
created_at	string
description	string	A resource's optional description.
id	string	A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
identifier	string
modified_at	string
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	A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
identifier	string
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual cloud_watch_alarm_template_group.

SELECT
  region,
  arn,
  created_at,
  description,
  id,
  identifier,
  modified_at,
  name,
  tags
FROM awscc.medialive.cloud_watch_alarm_template_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ identifier }}';

list (identifiers only)

Lists all cloud_watch_alarm_template_groups in a region.

SELECT
  region,
  identifier
FROM awscc.medialive.cloud_watch_alarm_template_groups_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.medialive.cloud_watch_alarm_template_groups (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.medialive.cloud_watch_alarm_template_groups (
  Description,
  Name,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cloud_watch_alarm_template_group
    props:
      - name: description
        value: '{{ description }}'
      - name: name
        value: '{{ name }}'
      - name: tags
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.medialive.cloud_watch_alarm_template_groups
SET PatchDocument = string('{{ {
    "Description": description
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.medialive.cloud_watch_alarm_template_groups
WHERE
  Identifier = '{{ identifier }}' AND
  region = 'us-east-1';

Permissions

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

Create

medialive:CreateCloudWatchAlarmTemplateGroup,
medialive:GetCloudWatchAlarmTemplateGroup,
medialive:CreateTags

Read

medialive:GetCloudWatchAlarmTemplateGroup

Update

medialive:UpdateCloudWatchAlarmTemplateGroup,
medialive:GetCloudWatchAlarmTemplateGroup,
medialive:CreateTags,
medialive:DeleteTags

Delete

medialive:DeleteCloudWatchAlarmTemplateGroup

List

medialive:ListCloudWatchAlarmTemplateGroups