channels

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

Overview

Name	channels
Type	Resource
Description	Resource schema for AWS::MediaPackage::Channel
Id	aws.mediapackage.channels

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) assigned to the Channel.
id	string	The ID of the Channel.
description	string	A short text description of the Channel.
hls_ingest	object	An HTTP Live Streaming (HLS) ingest resource configuration.
tags	array	A collection of tags associated with a resource
egress_access_logs	object	The configuration parameters for egress access logging.
ingress_access_logs	object	The configuration parameters for egress access logging.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Id, 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,
id,
description,
hls_ingest,
tags,
egress_access_logs,
ingress_access_logs
FROM aws.mediapackage.channels
WHERE region = 'us-east-1';

Gets all properties from an individual channel.

SELECT
region,
arn,
id,
description,
hls_ingest,
tags,
egress_access_logs,
ingress_access_logs
FROM aws.mediapackage.channels
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

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.mediapackage.channels (
 Id,
 region
)
SELECT 
'{{ Id }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.mediapackage.channels (
 Id,
 Description,
 HlsIngest,
 Tags,
 EgressAccessLogs,
 IngressAccessLogs,
 region
)
SELECT 
 '{{ Id }}',
 '{{ Description }}',
 '{{ HlsIngest }}',
 '{{ Tags }}',
 '{{ EgressAccessLogs }}',
 '{{ IngressAccessLogs }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: channel
    props:
      - name: Id
        value: '{{ Id }}'
      - name: Description
        value: '{{ Description }}'
      - name: HlsIngest
        value:
          ingestEndpoints:
            - Id: '{{ Id }}'
              Username: '{{ Username }}'
              Password: '{{ Password }}'
              Url: '{{ Url }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: EgressAccessLogs
        value:
          LogGroupName: '{{ LogGroupName }}'
      - name: IngressAccessLogs
        value: null

DELETE example

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

Permissions

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

Create

mediapackage:CreateChannel,
mediapackage:DescribeChannel,
mediapackage:UpdateChannel,
mediapackage:TagResource,
mediapackage:ConfigureLogs,
iam:CreateServiceLinkedRole

Read

mediapackage:DescribeChannel

Update

mediapackage:UpdateChannel,
mediapackage:ConfigureLogs,
iam:CreateServiceLinkedRole

Delete

mediapackage:DeleteChannel

List

mediapackage:ListChannels