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" },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/kinesis"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := kinesis.NewVideoStream(ctx, "_default", &kinesis.VideoStreamArgs{
            DataRetentionInHours: pulumi.Int(1),
            DeviceName:           pulumi.String("kinesis-video-device-name"),
            MediaType:            pulumi.String("video/h264"),
            Tags: pulumi.StringMap{
                "Name": pulumi.String("kinesis-video-stream"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

default = aws.kinesis.VideoStream("default",
    data_retention_in_hours=1,
    device_name="kinesis-video-device-name",
    media_type="video/h264",
    tags={
        "Name": "kinesis-video-stream",
    })

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const defaultVideoStream = new aws.kinesis.VideoStream("default", {
    dataRetentionInHours: 1,
    deviceName: "kinesis-video-device-name",
    mediaType: "video/h264",
    tags: {
        Name: "kinesis-video-stream",
    },
});

Create a VideoStream Resource

new VideoStream(name: string, args?: VideoStreamArgs, opts?: CustomResourceOptions);

def VideoStream(resource_name, opts=None, data_retention_in_hours=None, device_name=None, kms_key_id=None, media_type=None, name=None, tags=None, __props__=None);

func NewVideoStream(ctx *Context, name string, args *VideoStreamArgs, opts ...ResourceOption) (*VideoStream, error)

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

name string: The unique name of the resource.
args VideoStreamArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VideoStreamArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VideoStreamArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

VideoStream Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The VideoStream resource accepts the following input properties:

DataRetentionInHours int: 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.
DeviceName string: The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
KmsKeyId string: 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.
MediaType string: 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.
Name string: A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

DataRetentionInHours int: 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.
DeviceName string: The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
KmsKeyId string: 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.
MediaType string: 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.
Name string: A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
Tags map[string]string: A map of tags to assign to the resource.

dataRetentionInHours number: 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.
deviceName string: The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
kmsKeyId string: 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.
mediaType string: 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.
name string: A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
tags {[key: string]: string}: A map of tags to assign to the resource.

data_retention_in_hours float: 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.
device_name str: The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
kms_key_id str: 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.
media_type str: 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.
name str: A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
tags Dict[str, str]: A map of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the VideoStream resource produces the following output properties:

Arn string: The Amazon Resource Name (ARN) specifying the Stream (same as id)
CreationTime string: A time stamp that indicates when the stream was created.
Id string: The provider-assigned unique ID for this managed resource.
Version string: The version of the stream.

Arn string: The Amazon Resource Name (ARN) specifying the Stream (same as id)
CreationTime string: A time stamp that indicates when the stream was created.
Id string: The provider-assigned unique ID for this managed resource.
Version string: The version of the stream.

arn string: The Amazon Resource Name (ARN) specifying the Stream (same as id)
creationTime string: A time stamp that indicates when the stream was created.
id string: The provider-assigned unique ID for this managed resource.
version string: The version of the stream.

arn str: The Amazon Resource Name (ARN) specifying the Stream (same as id)
creation_time str: A time stamp that indicates when the stream was created.
id str: The provider-assigned unique ID for this managed resource.
version str: The version of the stream.

Look up an Existing VideoStream Resource

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

public static get(name: string, id: Input<ID>, state?: VideoStreamState, opts?: CustomResourceOptions): VideoStream

static get(resource_name, id, opts=None, arn=None, creation_time=None, data_retention_in_hours=None, device_name=None, kms_key_id=None, media_type=None, name=None, tags=None, version=None, __props__=None);

func GetVideoStream(ctx *Context, name string, id IDInput, state *VideoStreamState, opts ...ResourceOption) (*VideoStream, error)

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

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The Amazon Resource Name (ARN) specifying the Stream (same as id)
CreationTime string: A time stamp that indicates when the stream was created.
DataRetentionInHours int: 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.
DeviceName string: The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
KmsKeyId string: 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.
MediaType string: 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.
Name string: A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
Version string: The version of the stream.

Arn string: The Amazon Resource Name (ARN) specifying the Stream (same as id)
CreationTime string: A time stamp that indicates when the stream was created.
DataRetentionInHours int: 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.
DeviceName string: The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
KmsKeyId string: 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.
MediaType string: 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.
Name string: A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
Tags map[string]string: A map of tags to assign to the resource.
Version string: The version of the stream.

arn string: The Amazon Resource Name (ARN) specifying the Stream (same as id)
creationTime string: A time stamp that indicates when the stream was created.
dataRetentionInHours number: 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.
deviceName string: The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
kmsKeyId string: 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.
mediaType string: 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.
name string: A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
tags {[key: string]: string}: A map of tags to assign to the resource.
version string: The version of the stream.

arn str: The Amazon Resource Name (ARN) specifying the Stream (same as id)
creation_time str: A time stamp that indicates when the stream was created.
data_retention_in_hours float: 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.
device_name str: The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
kms_key_id str: 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.
media_type str: 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.
name str: A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
tags Dict[str, str]: A map of tags to assign to the resource.
version str: The version of the stream.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud