channels

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

Overview

Name	channels
Type	Resource
Description	Definition of AWS::MediaTailor::Channel Resource Type
Id	aws.mediatailor.channels

Fields

Name	Datatype	Description
arn	string	The ARN of the channel.
audiences	array	The list of audiences defined in channel.
channel_name	string
filler_slate	object	Slate VOD source configuration.
log_configuration	object	The log configuration for the channel.
outputs	array	The channel's output properties.
playback_mode	string
tags	array	The tags to assign to the channel.
tier	string
time_shift_configuration	object	The configuration for time-shifted viewing.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ChannelName, Outputs, PlaybackMode, 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 channels in a region.

SELECT
region,
arn,
audiences,
channel_name,
filler_slate,
log_configuration,
outputs,
playback_mode,
tags,
tier,
time_shift_configuration
FROM aws.mediatailor.channels
WHERE region = 'us-east-1';

Gets all properties from an individual channel.

SELECT
region,
arn,
audiences,
channel_name,
filler_slate,
log_configuration,
outputs,
playback_mode,
tags,
tier,
time_shift_configuration
FROM aws.mediatailor.channels
WHERE region = 'us-east-1' AND data__Identifier = '<ChannelName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.mediatailor.channels (
 ChannelName,
 Outputs,
 PlaybackMode,
 region
)
SELECT 
'{{ ChannelName }}',
 '{{ Outputs }}',
 '{{ PlaybackMode }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.mediatailor.channels (
 Audiences,
 ChannelName,
 FillerSlate,
 LogConfiguration,
 Outputs,
 PlaybackMode,
 Tags,
 Tier,
 TimeShiftConfiguration,
 region
)
SELECT 
 '{{ Audiences }}',
 '{{ ChannelName }}',
 '{{ FillerSlate }}',
 '{{ LogConfiguration }}',
 '{{ Outputs }}',
 '{{ PlaybackMode }}',
 '{{ Tags }}',
 '{{ Tier }}',
 '{{ TimeShiftConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: channel
    props:
      - name: Audiences
        value:
          - '{{ Audiences[0] }}'
      - name: ChannelName
        value: '{{ ChannelName }}'
      - name: FillerSlate
        value:
          SourceLocationName: '{{ SourceLocationName }}'
          VodSourceName: '{{ VodSourceName }}'
      - name: LogConfiguration
        value:
          LogTypes:
            - '{{ LogTypes[0] }}'
      - name: Outputs
        value:
          - DashPlaylistSettings:
              ManifestWindowSeconds: null
              MinBufferTimeSeconds: null
              MinUpdatePeriodSeconds: null
              SuggestedPresentationDelaySeconds: null
            HlsPlaylistSettings:
              ManifestWindowSeconds: null
              AdMarkupType:
                - '{{ AdMarkupType[0] }}'
            ManifestName: '{{ ManifestName }}'
            SourceGroup: '{{ SourceGroup }}'
      - name: PlaybackMode
        value: '{{ PlaybackMode }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Tier
        value: '{{ Tier }}'
      - name: TimeShiftConfiguration
        value:
          MaxTimeDelaySeconds: null

DELETE example

/*+ delete */
DELETE FROM aws.mediatailor.channels
WHERE data__Identifier = '<ChannelName>'
AND region = 'us-east-1';

Permissions

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

Create

mediatailor:CreateChannel,
mediatailor:TagResource,
mediatailor:ConfigureLogsForChannel,
iam:CreateServiceLinkedRole,
mediatailor:DescribeChannel

Read

mediatailor:DescribeChannel

Update

mediatailor:UpdateChannel,
mediatailor:TagResource,
mediatailor:UntagResource,
iam:CreateServiceLinkedRole,
mediatailor:ConfigureLogsForChannel,
mediatailor:DescribeChannel

Delete

mediatailor:DeleteChannel,
mediatailor:DescribeChannel

List

mediatailor:ListChannels