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

get (all properties)

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

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	channels	INSERT	ChannelGroupName, ChannelName, 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,
  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 = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all channels in a region.

SELECT
  region,
  arn
FROM awscc.mediapackagev2.channels_list_only
WHERE
  region = '{{ region }}';

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
  '{{ channel_group_name }}',
  '{{ channel_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.mediapackagev2.channels (
  ChannelGroupName,
  ChannelName,
  Description,
  InputSwitchConfiguration,
  InputType,
  OutputHeaderConfiguration,
  Tags,
  region
)
SELECT
  '{{ channel_group_name }}',
  '{{ channel_name }}',
  '{{ description }}',
  '{{ input_switch_configuration }}',
  '{{ input_type }}',
  '{{ output_header_configuration }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: channel
  props:
    - name: channel_group_name
      value: '{{ channel_group_name }}'
    - name: channel_name
      value: '{{ channel_name }}'
    - name: description
      value: '{{ description }}'
    - name: input_switch_configuration
      value:
        m_qc_sinput_switching: '{{ m_qc_sinput_switching }}'
        preferred_input: '{{ preferred_input }}'
    - name: input_type
      value: '{{ input_type }}'
    - name: output_header_configuration
      value:
        publish_mq_cs: '{{ publish_mq_cs }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.mediapackagev2.channels
SET PatchDocument = string('{{ {
    "Description": description,
    "InputSwitchConfiguration": input_switch_configuration,
    "OutputHeaderConfiguration": output_header_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.mediapackagev2.channels
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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