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	awscc.mediapackagev2.channel_groups

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
arn	string	<p>The Amazon Resource Name (ARN) associated with the resource.</p>
region	string	AWS region.

For more information, see AWS::MediaPackageV2::ChannelGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	channel_groups	INSERT	ChannelGroupName, region
delete_resource	channel_groups	DELETE	Identifier, region
update_resource	channel_groups	UPDATE	Identifier, PatchDocument, region
list_resources	channel_groups_list_only	SELECT	region
get_resource	channel_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual channel_group.

SELECT
  region,
  arn,
  channel_group_name,
  created_at,
  description,
  egress_domain,
  modified_at,
  tags
FROM awscc.mediapackagev2.channel_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all channel_groups in a region.

SELECT
  region,
  arn
FROM awscc.mediapackagev2.channel_groups_list_only
WHERE
  region = 'us-east-1';

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 awscc.mediapackagev2.channel_groups (
  ChannelGroupName,
  region
)
SELECT
  '{{ channel_group_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.mediapackagev2.channel_groups (
  ChannelGroupName,
  Description,
  Tags,
  region
)
SELECT
  '{{ channel_group_name }}',
  '{{ 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: channel_group_name
        value: '{{ channel_group_name }}'
      - name: description
        value: '{{ description }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.mediapackagev2.channel_groups
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.mediapackagev2.channel_groups
WHERE
  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