VideoStream class
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
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.kinesis.VideoStream("default", {
name: "kinesis-video-stream",
dataRetentionInHours: 1,
deviceName: "kinesis-video-device-name",
mediaType: "video/h264",
tags: {
Name: "kinesis-video-stream",
},
});
import pulumi
import pulumi_aws as aws
default = aws.kinesis.VideoStream("default",
name="kinesis-video-stream",
data_retention_in_hours=1,
device_name="kinesis-video-device-name",
media_type="video/h264",
tags={
"Name": "kinesis-video-stream",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.Kinesis.VideoStream("default", new()
{
Name = "kinesis-video-stream",
DataRetentionInHours = 1,
DeviceName = "kinesis-video-device-name",
MediaType = "video/h264",
Tags =
{
{ "Name", "kinesis-video-stream" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
Name: pulumi.String("kinesis-video-stream"),
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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_kinesis_videostream" "default" {
name = "kinesis-video-stream"
data_retention_in_hours = 1
device_name = "kinesis-video-device-name"
media_type = "video/h264"
tags = {
"Name" = "kinesis-video-stream"
}
}
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.ArrayList;
import java.util.Arrays;
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()
.name("kinesis-video-stream")
.dataRetentionInHours(1)
.deviceName("kinesis-video-device-name")
.mediaType("video/h264")
.tags(Map.of("Name", "kinesis-video-stream"))
.build());
}
}
resources:
default:
type: aws:kinesis:VideoStream
properties:
name: kinesis-video-stream
dataRetentionInHours: 1
deviceName: kinesis-video-device-name
mediaType: video/h264
tags:
Name: kinesis-video-stream
Import
Using pulumi import, import Kinesis Streams using the arn. For example:
$ pulumi import aws:kinesis/videoStream:VideoStream test_stream arn:aws:kinesisvideo:us-west-2:123456789012:stream/pulumi-kinesis-test/1554978910975
Constructors
- VideoStream(String name, {VideoStreamArgs? args, CustomResourceOptions? options})
-
Creates a new VideoStream.
nameThe Pulumi resource name.argsArguments used to configure this VideoStream. The set of arguments for VideoStream.optionsResource options controlling this resource's behavior. - VideoStream.reference(String urn)
- Creates a typed reference to an existing VideoStream resource.
Properties
-
arn
↔ Output<
String> -
ARN specifying the Stream (same as
id)latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
creationTime
↔ Output<
String> -
A time stamp that indicates when the stream was created.
latefinal
-
dataRetentionInHours
↔ Output<
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.latefinal -
deviceName
↔ Output<
String?> -
The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kmsKeyId
↔ Output<
String> -
ID of the 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.latefinal -
mediaType
↔ Output<
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.
latefinal
-
name
↔ Output<
String> -
A name to identify the stream. This is unique to the
AWS account and region the Stream is created in.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
version
↔ Output<
String> -
The version of the stream.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {VideoStreamState? state, CustomResourceOptions? options}) → VideoStream -
Gets an existing VideoStream resource's state with the given
nameandid.