channels

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

Overview

Name	channels
Type	Resource
Description	Resource Type definition for AWS::IVS::Channel
Id	aws.ivs.channels

Fields

Name	Datatype	Description
arn	string	Channel ARN is automatically generated on creation and assigned as the unique identifier.
name	string	Channel
authorized	boolean	Whether the channel is authorized.
insecure_ingest	boolean	Whether the channel allows insecure ingest.
latency_mode	string	Channel latency mode.
type	string	Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
tags	array	A list of key-value pairs that contain metadata for the asset model.
playback_url	string	Channel Playback URL.
ingest_endpoint	string	Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
recording_configuration_arn	string	Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
preset	string	Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, 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,
name,
authorized,
insecure_ingest,
latency_mode,
type,
tags,
playback_url,
ingest_endpoint,
recording_configuration_arn,
preset
FROM aws.ivs.channels
WHERE region = 'us-east-1';

Gets all properties from an individual channel.

SELECT
region,
arn,
name,
authorized,
insecure_ingest,
latency_mode,
type,
tags,
playback_url,
ingest_endpoint,
recording_configuration_arn,
preset
FROM aws.ivs.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 aws.ivs.channels (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ivs.channels (
 Name,
 Authorized,
 InsecureIngest,
 LatencyMode,
 Type,
 Tags,
 RecordingConfigurationArn,
 Preset,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Authorized }}',
 '{{ InsecureIngest }}',
 '{{ LatencyMode }}',
 '{{ Type }}',
 '{{ Tags }}',
 '{{ RecordingConfigurationArn }}',
 '{{ Preset }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: channel
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Authorized
        value: '{{ Authorized }}'
      - name: InsecureIngest
        value: '{{ InsecureIngest }}'
      - name: LatencyMode
        value: '{{ LatencyMode }}'
      - name: Type
        value: '{{ Type }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: RecordingConfigurationArn
        value: '{{ RecordingConfigurationArn }}'
      - name: Preset
        value: '{{ Preset }}'

DELETE example

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

Permissions

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

Create

ivs:CreateChannel,
ivs:TagResource

Read

ivs:GetChannel,
ivs:ListTagsForResource

Update

ivs:GetChannel,
ivs:UpdateChannel,
ivs:TagResource,
ivs:UnTagResource,
ivs:ListTagsForResource

Delete

ivs:DeleteChannel,
ivs:UnTagResource

List

ivs:ListChannels,
ivs:ListTagsForResource