channels

Creates, updates, deletes or gets a channel resource or lists channels in a region

Overview

Name	channels
Type	Resource
Description	Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.
Id	awscc.mediapackagev2.channels

Fields

Name	Datatype	Description
arn	string	<p>The Amazon Resource Name (ARN) associated with the resource.</p>
channel_group_name	string
channel_name	string
created_at	string	<p>The date and time the channel was created.</p>
description	string	<p>Enter any descriptive text that helps you to identify the channel.</p>
▶ingest_endpoints	array	<p>The list of ingest endpoints.</p>
▶input_switch_configuration	object	<p>The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.</p>
input_type	string
modified_at	string	<p>The date and time the channel was modified.</p>
▶output_header_configuration	object	<p>The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.</p>
ingest_endpoint_urls	array
▶tags	array
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ChannelGroupName, ChannelName, 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 properties from an individual channel.

SELECT
region,
arn,
channel_group_name,
channel_name,
created_at,
description,
ingest_endpoints,
input_switch_configuration,
input_type,
modified_at,
output_header_configuration,
ingest_endpoint_urls,
tags
FROM awscc.mediapackagev2.channels
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.mediapackagev2.channels (
 ChannelGroupName,
 ChannelName,
 region
)
SELECT 
'{{ ChannelGroupName }}',
 '{{ ChannelName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.mediapackagev2.channels (
 ChannelGroupName,
 ChannelName,
 Description,
 InputSwitchConfiguration,
 InputType,
 OutputHeaderConfiguration,
 Tags,
 region
)
SELECT 
 '{{ ChannelGroupName }}',
 '{{ ChannelName }}',
 '{{ Description }}',
 '{{ InputSwitchConfiguration }}',
 '{{ InputType }}',
 '{{ OutputHeaderConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: channel
    props:
      - name: ChannelGroupName
        value: '{{ ChannelGroupName }}'
      - name: ChannelName
        value: '{{ ChannelName }}'
      - name: Description
        value: '{{ Description }}'
      - name: InputSwitchConfiguration
        value:
          MQCSInputSwitching: '{{ MQCSInputSwitching }}'
          PreferredInput: '{{ PreferredInput }}'
      - name: InputType
        value: '{{ InputType }}'
      - name: OutputHeaderConfiguration
        value:
          PublishMQCS: '{{ PublishMQCS }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

mediapackagev2:TagResource,
mediapackagev2:CreateChannel

Read

mediapackagev2:GetChannel

Update

mediapackagev2:TagResource,
mediapackagev2:UntagResource,
mediapackagev2:ListTagsForResource,
mediapackagev2:UpdateChannel

Delete

mediapackagev2:GetChannel,
mediapackagev2:DeleteChannel

List

mediapackagev2:ListChannels