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	awscc.mediatailor.channels

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
channel_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	channels	INSERT	ChannelName, Outputs, PlaybackMode, region
delete_resource	channels	DELETE	Identifier, region
update_resource	channels	UPDATE	Identifier, PatchDocument, region
list_resources	channels_list_only	SELECT	region
get_resource	channels	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.mediatailor.channels
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ channel_name }}';

list (identifiers only)

Lists all channels in a region.

SELECT
  region,
  channel_name
FROM awscc.mediatailor.channels_list_only
WHERE
  region = 'us-east-1';

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.mediatailor.channels (
  ChannelName,
  Outputs,
  PlaybackMode,
  region
)
SELECT
  '{{ channel_name }}',
  '{{ outputs }}',
  '{{ playback_mode }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.mediatailor.channels (
  Audiences,
  ChannelName,
  FillerSlate,
  LogConfiguration,
  Outputs,
  PlaybackMode,
  Tags,
  Tier,
  TimeShiftConfiguration,
  region
)
SELECT
  '{{ audiences }}',
  '{{ channel_name }}',
  '{{ filler_slate }}',
  '{{ log_configuration }}',
  '{{ outputs }}',
  '{{ playback_mode }}',
  '{{ tags }}',
  '{{ tier }}',
  '{{ time_shift_configuration }}',
  '{{ 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: channel_name
        value: '{{ channel_name }}'
      - name: filler_slate
        value:
          source_location_name: '{{ source_location_name }}'
          vod_source_name: '{{ vod_source_name }}'
      - name: log_configuration
        value:
          log_types:
            - '{{ log_types[0] }}'
      - name: outputs
        value:
          - dash_playlist_settings:
              manifest_window_seconds: null
              min_buffer_time_seconds: null
              min_update_period_seconds: null
              suggested_presentation_delay_seconds: null
            hls_playlist_settings:
              manifest_window_seconds: null
              ad_markup_type:
                - '{{ ad_markup_type[0] }}'
            manifest_name: '{{ manifest_name }}'
            source_group: '{{ source_group }}'
      - name: playback_mode
        value: '{{ playback_mode }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: tier
        value: '{{ tier }}'
      - name: time_shift_configuration
        value:
          max_time_delay_seconds: null

UPDATE example

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

/*+ update */
UPDATE awscc.mediatailor.channels
SET PatchDocument = string('{{ {
    "Audiences": audiences,
    "FillerSlate": filler_slate,
    "LogConfiguration": log_configuration,
    "Outputs": outputs,
    "PlaybackMode": playback_mode,
    "Tags": tags,
    "TimeShiftConfiguration": time_shift_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ channel_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.mediatailor.channels
WHERE
  Identifier = '{{ channel_name }}' 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