AWS Classic

v5.16.2 published on Tuesday, Oct 4, 2022 by Pulumi

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 System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.Kinesis.VideoStream("default", new()
    {
        DataRetentionInHours = 1,
        DeviceName = "kinesis-video-device-name",
        MediaType = "video/h264",
        Tags = 
        {
            { "Name", "kinesis-video-stream" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/kinesis"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kinesis.VideoStream;
import com.pulumi.aws.kinesis.VideoStreamArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new VideoStream("default", VideoStreamArgs.builder()        
            .dataRetentionInHours(1)
            .deviceName("kinesis-video-device-name")
            .mediaType("video/h264")
            .tags(Map.of("Name", "kinesis-video-stream"))
            .build());

    }
}
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",
    },
});
resources:
  default:
    type: aws:kinesis:VideoStream
    properties:
      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);
@overload
def VideoStream(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                data_retention_in_hours: Optional[int] = None,
                device_name: Optional[str] = None,
                kms_key_id: Optional[str] = None,
                media_type: Optional[str] = None,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
@overload
def VideoStream(resource_name: str,
                args: Optional[VideoStreamArgs] = None,
                opts: Optional[ResourceOptions] = None)
func NewVideoStream(ctx *Context, name string, args *VideoStreamArgs, opts ...ResourceOption) (*VideoStream, error)
public VideoStream(string name, VideoStreamArgs? args = null, CustomResourceOptions? opts = null)
public VideoStream(String name, VideoStreamArgs args)
public VideoStream(String name, VideoStreamArgs args, CustomResourceOptions options)
type: aws:kinesis:VideoStream
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args VideoStreamArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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.
name String
The unique name of the resource.
args VideoStreamArgs
The arguments to resource properties.
options 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 Architecture and Concepts 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

dataRetentionInHours Integer

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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

data_retention_in_hours 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.

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 Mapping[str, str]

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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 Map<String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

version str

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.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

version String

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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        creation_time: Optional[str] = None,
        data_retention_in_hours: Optional[int] = None,
        device_name: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        media_type: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        version: Optional[str] = None) -> VideoStream
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)
public static VideoStream get(String name, Output<String> id, VideoStreamState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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 Integer

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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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 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.

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 Mapping[str, str]

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

version str

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 Map<String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

version String

The version of the stream.

Import

Kinesis Streams can be imported using the arn, e.g.,

 $ pulumi import aws:kinesis/videoStream:VideoStream test_stream arn:aws:kinesisvideo:us-west-2:123456789012:stream/terraform-kinesis-test/1554978910975

[1]https://aws.amazon.com/documentation/kinesis/ [2]http://www.iana.org/assignments/media-types/media-types.xhtml [3]https://tools.ietf.org/html/rfc6838#section-4.2

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.