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	awscc.kinesisvideo.signaling_channels

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the Kinesis Video Signaling Channel.
region	string	AWS region.

For more information, see AWS::KinesisVideo::SignalingChannel.

Methods

Name	Resource	Accessible by	Required Params
create_resource	signaling_channels	INSERT	, region
delete_resource	signaling_channels	DELETE	Identifier, region
update_resource	signaling_channels	UPDATE	Identifier, PatchDocument, region
list_resources	signaling_channels_list_only	SELECT	region
get_resource	signaling_channels	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual signaling_channel.

SELECT
  region,
  arn,
  name,
  type,
  message_ttl_seconds,
  tags
FROM awscc.kinesisvideo.signaling_channels
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all signaling_channels in a region.

SELECT
  region,
  name
FROM awscc.kinesisvideo.signaling_channels_list_only
WHERE
  region = '{{ region }}';

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 awscc.kinesisvideo.signaling_channels (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.kinesisvideo.signaling_channels (
  Name,
  Type,
  MessageTtlSeconds,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ message_ttl_seconds }}',
  '{{ 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: signaling_channel
  props:
    - name: name
      value: '{{ name }}'
    - name: type
      value: '{{ type }}'
    - name: message_ttl_seconds
      value: '{{ message_ttl_seconds }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.kinesisvideo.signaling_channels
SET PatchDocument = string('{{ {
    "Type": type,
    "MessageTtlSeconds": message_ttl_seconds,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.kinesisvideo.signaling_channels
WHERE
  Identifier = '{{ name }}' 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 signaling_channels resource, the following permissions are required:

Create

kinesisvideo:CreateSignalingChannel,
kinesisvideo:DescribeSignalingChannel,
kinesisvideo:TagResource

Read

kinesisvideo:DescribeSignalingChannel,
kinesisvideo:ListTagsForResource

Update

kinesisvideo:UpdateSignalingChannel,
kinesisvideo:DescribeSignalingChannel,
kinesisvideo:TagResource,
kinesisvideo:UntagResource,
kinesisvideo:ListTagsForResource

Delete

kinesisvideo:DeleteSignalingChannel,
kinesisvideo:DescribeSignalingChannel

List

kinesisvideo:ListSignalingChannels