@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
196 lines (195 loc) • 9.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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
*
* ```typescript
* 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
*
* 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
* ```
*/
export declare class VideoStream extends pulumi.CustomResource {
/**
* Get an existing VideoStream resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VideoStreamState, opts?: pulumi.CustomResourceOptions): VideoStream;
/**
* Returns true if the given object is an instance of VideoStream. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VideoStream;
/**
* The Amazon Resource Name (ARN) specifying the Stream (same as `id`)
*/
readonly arn: pulumi.Output<string>;
/**
* A time stamp that indicates when the stream was created.
*/
readonly creationTime: pulumi.Output<string>;
/**
* 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.
*/
readonly dataRetentionInHours: pulumi.Output<number | undefined>;
/**
* The name of the device that is writing to the stream. **In the current implementation, Kinesis Video Streams does not use this name.**
*/
readonly deviceName: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly kmsKeyId: pulumi.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](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.
*/
readonly mediaType: pulumi.Output<string | undefined>;
/**
* A name to identify the stream. This is unique to the
* AWS account and region the Stream is created in.
*/
readonly name: pulumi.Output<string>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* 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.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* The version of the stream.
*/
readonly version: pulumi.Output<string>;
/**
* Create a VideoStream resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: VideoStreamArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VideoStream resources.
*/
export interface VideoStreamState {
/**
* The Amazon Resource Name (ARN) specifying the Stream (same as `id`)
*/
arn?: pulumi.Input<string>;
/**
* A time stamp that indicates when the stream was created.
*/
creationTime?: pulumi.Input<string>;
/**
* 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.
*/
dataRetentionInHours?: pulumi.Input<number>;
/**
* The name of the device that is writing to the stream. **In the current implementation, Kinesis Video Streams does not use this name.**
*/
deviceName?: pulumi.Input<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.
*/
kmsKeyId?: pulumi.Input<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](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.
*/
mediaType?: pulumi.Input<string>;
/**
* A name to identify the stream. This is unique to the
* AWS account and region the Stream is created in.
*/
name?: pulumi.Input<string>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* 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.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The version of the stream.
*/
version?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VideoStream resource.
*/
export interface VideoStreamArgs {
/**
* 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.
*/
dataRetentionInHours?: pulumi.Input<number>;
/**
* The name of the device that is writing to the stream. **In the current implementation, Kinesis Video Streams does not use this name.**
*/
deviceName?: pulumi.Input<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.
*/
kmsKeyId?: pulumi.Input<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](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.
*/
mediaType?: pulumi.Input<string>;
/**
* A name to identify the stream. This is unique to the
* AWS account and region the Stream is created in.
*/
name?: pulumi.Input<string>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* 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.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}