Skip to content

Resource: awsKinesisVideoStream

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

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.kinesisVideoStream.KinesisVideoStream(this, "default", {
  dataRetentionInHours: 1,
  deviceName: "kinesis-video-device-name",
  mediaType: "video/h264",
  name: "terraform-kinesis-video-stream",
  tags: {
    Name: "terraform-kinesis-video-stream",
  },
});

Argument Reference

The following arguments are supported:

  • name - (Required) A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
  • dataRetentionInHours – (Optional) 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 - (Optional) The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
  • kmsKeyId - (Optional) 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 - (Optional) 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.
  • tags - (Optional) A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The unique Stream id
  • arn - The Amazon Resource Name (ARN) specifying the Stream (same as id)
  • creationTime - A time stamp that indicates when the stream was created.
  • version - The version of the stream.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Timeouts

Configuration options:

  • create - (Default 5M)
  • update - (Default 120M)
  • delete - (Default 120M)

Import

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

$ terraform import aws_kinesis_video_stream.test_stream arn:aws:kinesisvideo:us-west-2:123456789012:stream/terraform-kinesis-test/1554978910975