streams

Creates, updates, deletes or gets a stream resource or lists streams in a region

Overview

Name	streams
Type	Resource
Description	Resource Type Definition for AWS::KinesisVideo::Stream
Id	aws.kinesisvideo.streams

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the Kinesis Video stream.
name	string	The name of the Kinesis Video stream.
data_retention_in_hours	integer	The number of hours till which Kinesis Video will retain the data in the stream
device_name	string	The name of the device that is writing to the stream.
kms_key_id	string	AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
media_type	string	The media type of the stream. Consumers of the stream can use this information when processing the stream.
tags	array	An array of key-value pairs associated with the Kinesis Video Stream.
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 stream.

SELECT
region,
arn,
name,
data_retention_in_hours,
device_name,
kms_key_id,
media_type,
tags
FROM aws.kinesisvideo.streams
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.kinesisvideo.streams (
 Name,
 DataRetentionInHours,
 DeviceName,
 KmsKeyId,
 MediaType,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ DataRetentionInHours }}',
 '{{ DeviceName }}',
 '{{ KmsKeyId }}',
 '{{ MediaType }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: stream
    props:
      - name: Name
        value: '{{ Name }}'
      - name: DataRetentionInHours
        value: '{{ DataRetentionInHours }}'
      - name: DeviceName
        value: '{{ DeviceName }}'
      - name: KmsKeyId
        value: '{{ KmsKeyId }}'
      - name: MediaType
        value: '{{ MediaType }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

kinesisvideo:DescribeStream,
kinesisvideo:CreateStream

Read

kinesisvideo:DescribeStream

Update

kinesisvideo:DescribeStream,
kinesisvideo:UpdateStream,
kinesisvideo:UpdateDataRetention

Delete

kinesisvideo:DescribeStream,
kinesisvideo:DeleteStream