Package com.pulumi.aws.kinesis

Class VideoStream

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.kinesis.VideoStream

public class VideoStream
extends com.pulumi.resources.CustomResource

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](https://aws.amazon.com/documentation/kinesis/). ## Example Usage

 
 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());
 
     }
 }
 
 

## Import Using `pulumi import`, import Kinesis Streams using the `arn`. For example: ```sh $ pulumi import aws:kinesis/videoStream:VideoStream test_stream arn:aws:kinesisvideo:us-west-2:123456789012:stream/pulumi-kinesis-test/1554978910975 ```

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

com.pulumi.resources.CustomResource.CustomResourceInternal

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

Field Summary

Fields inherited from class com.pulumi.resources.Resource

childResources, remote

Constructor Summary

Constructors

Constructor	Description
VideoStream(java.lang.String name)
VideoStream(java.lang.String name, VideoStreamArgs args)
VideoStream(java.lang.String name, VideoStreamArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	arn()
com.pulumi.core.Output<java.lang.String>	creationTime()
com.pulumi.core.Output<java.util.Optional<java.lang.Integer>>	dataRetentionInHours()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	deviceName()
static VideoStream	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VideoStreamState state, com.pulumi.resources.CustomResourceOptions options)	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
com.pulumi.core.Output<java.lang.String>	kmsKeyId()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	mediaType()
com.pulumi.core.Output<java.lang.String>	name()
com.pulumi.core.Output<java.lang.String>	region()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>	tags()
com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>	tagsAll()
com.pulumi.core.Output<java.lang.String>	version()

Methods inherited from class com.pulumi.resources.CustomResource

getId, id, idFuture

Methods inherited from class com.pulumi.resources.Resource

getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VideoStream

public VideoStream(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

VideoStream

public VideoStream(java.lang.String name,
                   @Nullable
                   VideoStreamArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

VideoStream

public VideoStream(java.lang.String name,
                   @Nullable
                   VideoStreamArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

options - A bag of options that control this resource's behavior.

Method Detail

arn

public com.pulumi.core.Output<java.lang.String> arn()

Returns:

ARN specifying the Stream (same as `id`).

creationTime

public com.pulumi.core.Output<java.lang.String> creationTime()

Returns:

Time stamp that indicates when the stream was created.

dataRetentionInHours

public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> dataRetentionInHours()

Returns:

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

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> deviceName()

Returns:

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

kmsKeyId

public com.pulumi.core.Output<java.lang.String> kmsKeyId()

Returns:

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.

mediaType

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> mediaType()

Returns:

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](http://www.iana.org/assignments/media-types/media-types.xhtml). If you choose to specify the MediaType, see [Naming Requirements](https://tools.ietf.org/html/rfc6838#section-4.2) for guidelines.

name

public com.pulumi.core.Output<java.lang.String> name()

Returns:

Name to identify the stream. Unique to the AWS account and region the stream is created in.

region

public com.pulumi.core.Output<java.lang.String> region()

Returns:

Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

tags

public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()

Returns:

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.

tagsAll

public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()

Returns:

Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

version

public com.pulumi.core.Output<java.lang.String> version()

Returns:

Version of the stream.

get

public static VideoStream get(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              VideoStreamState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)

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

Parameters:

name - The _unique_ name of the resulting resource.

id - The _unique_ provider ID of the resource to lookup.

state -

options - Optional settings to control the behavior of the CustomResource.