AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateStream operation. Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works.

You must have permissions for the KinesisVideo:CreateStream action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KinesisVideo.AmazonKinesisVideoRequest
      Amazon.KinesisVideo.Model.CreateStreamRequest

Namespace: Amazon.KinesisVideo.Model
Assembly: AWSSDK.KinesisVideo.dll
Version: 3.x.y.z

Syntax

C#
public class CreateStreamRequest : AmazonKinesisVideoRequest
         IAmazonWebServiceRequest

The CreateStreamRequest type exposes the following members

Constructors

NameDescription
Public Method CreateStreamRequest()

Properties

NameTypeDescription
Public Property DataRetentionInHours System.Int32

Gets and sets the property DataRetentionInHours.

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

Public Property DeviceName System.String

Gets and sets the property DeviceName.

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (Amazon Web Services/kinesisvideo) is used.

For more information, see DescribeKey.

Public Property MediaType System.String

Gets and sets the property MediaType.

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

Public Property StreamName System.String

Gets and sets the property StreamName.

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5