signaling_channels

Creates, updates, deletes or gets a signaling_channel resource or lists signaling_channels in a region

Overview

Name	signaling_channels
Type	Resource
Description	Resource Type Definition for AWS::KinesisVideo::SignalingChannel
Id	aws.kinesisvideo.signaling_channels

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
name	string	The name of the Kinesis Video Signaling Channel.
type	string	The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
message_ttl_seconds	integer	The period of time a signaling channel retains undelivered messages before they are discarded.
tags	array	An array of key-value pairs to apply to this resource.
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
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual signaling_channel.

SELECT
region,
arn,
name,
type,
message_ttl_seconds,
tags
FROM aws.kinesisvideo.signaling_channels
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.kinesisvideo.signaling_channels (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.kinesisvideo.signaling_channels (
 Name,
 Type,
 MessageTtlSeconds,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Type }}',
 '{{ MessageTtlSeconds }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: signaling_channel
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Type
        value: '{{ Type }}'
      - name: MessageTtlSeconds
        value: '{{ MessageTtlSeconds }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.kinesisvideo.signaling_channels
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

kinesisvideo:CreateSignalingChannel,
kinesisvideo:DescribeSignalingChannel

Read

kinesisvideo:DescribeSignalingChannel

Update

kinesisvideo:UpdateSignalingChannel,
kinesisvideo:DescribeSignalingChannel

Delete

kinesisvideo:DeleteSignalingChannel,
kinesisvideo:DescribeSignalingChannel