channel_groups

Creates, updates, deletes or gets a channel_group resource or lists channel_groups in a region

Overview

Name	channel_groups
Type	Resource
Description	Represents a channel group that facilitates the grouping of multiple channels.
Id	aws.mediapackagev2.channel_groups

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) associated with the resource.
channel_group_name	string
created_at	string	The date and time the channel group was created.
description	string	Enter any descriptive text that helps you to identify the channel group.
egress_domain	string	The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
modified_at	string	The date and time the channel group was modified.
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ChannelGroupName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all channel_groups in a region.

SELECT
region,
arn,
channel_group_name,
created_at,
description,
egress_domain,
modified_at,
tags
FROM aws.mediapackagev2.channel_groups
WHERE region = 'us-east-1';

Gets all properties from an individual channel_group.

SELECT
region,
arn,
channel_group_name,
created_at,
description,
egress_domain,
modified_at,
tags
FROM aws.mediapackagev2.channel_groups
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.mediapackagev2.channel_groups (
 ChannelGroupName,
 region
)
SELECT 
'{{ ChannelGroupName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.mediapackagev2.channel_groups (
 ChannelGroupName,
 Description,
 Tags,
 region
)
SELECT 
 '{{ ChannelGroupName }}',
 '{{ Description }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: channel_group
    props:
      - name: ChannelGroupName
        value: '{{ ChannelGroupName }}'
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.mediapackagev2.channel_groups
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

mediapackagev2:TagResource,
mediapackagev2:CreateChannelGroup

Read

mediapackagev2:GetChannelGroup

Update

mediapackagev2:TagResource,
mediapackagev2:UntagResource,
mediapackagev2:ListTagsForResource,
mediapackagev2:UpdateChannelGroup

Delete

mediapackagev2:GetChannelGroup,
mediapackagev2:DeleteChannelGroup

List

mediapackagev2:ListChannelGroups