Class VideoStream

Provides a Kinesis Video Stream resource. Amazon Kinesis Video Streams makes it easy to securely stream video from connected devices to AWS for analytics, machine learning (ML), playback, and other processing.

For more details, see the Amazon Kinesis Documentation.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Aws.Kinesis.VideoStream("default", new Aws.Kinesis.VideoStreamArgs
    {
        DataRetentionInHours = 1,
        DeviceName = "kinesis-video-device-name",
        MediaType = "video/h264",
        Tags = 
        {
            { "Name", "kinesis-video-stream" },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

VideoStream

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Kinesis

Assembly: Pulumi.Aws.dll

Syntax

public class VideoStream : CustomResource

Constructors

VideoStream(String, VideoStreamArgs, CustomResourceOptions)

Create a VideoStream resource with the given unique name, arguments, and options.

Declaration

public VideoStream(string name, VideoStreamArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
VideoStreamArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

The Amazon Resource Name (ARN) specifying the Stream (same as id)

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

CreationTime

A time stamp that indicates when the stream was created.

Declaration

public Output<string> CreationTime { get; }

Property Value

Type	Description
Output<System.String>

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.

Declaration

public Output<int?> DataRetentionInHours { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

DeviceName

The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.

Declaration

public Output<string> DeviceName { get; }

Property Value

Type	Description
Output<System.String>

KmsKeyId

The ID of the AWS Key Management Service (AWS 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 (aws/kinesisvideo) is used.

Declaration

public Output<string> KmsKeyId { get; }

Property Value

Type	Description
Output<System.String>

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.

Declaration

public Output<string> MediaType { get; }

Property Value

Type	Description
Output<System.String>

Name

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Version

The version of the stream.

Declaration

public Output<string> Version { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, VideoStreamState, CustomResourceOptions)

Get an existing VideoStream resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static VideoStream Get(string name, Input<string> id, VideoStreamState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
VideoStreamState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
VideoStream