AWS Native v0.55.0, Mar 28 23

aws-native.kinesisvideo.getStream

Resource Type Definition for AWS::KinesisVideo::Stream

Using getStream

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getStream(args: GetStreamArgs, opts?: InvokeOptions): Promise<GetStreamResult>
function getStreamOutput(args: GetStreamOutputArgs, opts?: InvokeOptions): Output<GetStreamResult>

def get_stream(name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetStreamResult
def get_stream_output(name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetStreamResult]

func LookupStream(ctx *Context, args *LookupStreamArgs, opts ...InvokeOption) (*LookupStreamResult, error)
func LookupStreamOutput(ctx *Context, args *LookupStreamOutputArgs, opts ...InvokeOption) LookupStreamResultOutput

> Note: This function is named LookupStream in the Go SDK.

public static class GetStream 
{
    public static Task<GetStreamResult> InvokeAsync(GetStreamArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamResult> Invoke(GetStreamInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStreamResult> getStream(GetStreamArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:kinesisvideo:getStream
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the Kinesis Video stream.

Name string: The name of the Kinesis Video stream.

name String: The name of the Kinesis Video stream.

name string: The name of the Kinesis Video stream.

name str: The name of the Kinesis Video stream.

name String: The name of the Kinesis Video stream.

getStream Result

The following output properties are available:

Arn string: The Amazon Resource Name (ARN) of the Kinesis Video stream.
DataRetentionInHours int: The number of hours till which Kinesis Video will retain the data in the stream
DeviceName string: The name of the device that is writing to the stream.
KmsKeyId string: AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
MediaType string: The media type of the stream. Consumers of the stream can use this information when processing the stream.
Tags List<Pulumi.AwsNative.KinesisVideo.Outputs.StreamTag>: An array of key-value pairs associated with the Kinesis Video Stream.

Arn string: The Amazon Resource Name (ARN) of the Kinesis Video stream.
DataRetentionInHours int: The number of hours till which Kinesis Video will retain the data in the stream
DeviceName string: The name of the device that is writing to the stream.
KmsKeyId string: AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
MediaType string: The media type of the stream. Consumers of the stream can use this information when processing the stream.
Tags []StreamTag: An array of key-value pairs associated with the Kinesis Video Stream.

arn String: The Amazon Resource Name (ARN) of the Kinesis Video stream.
dataRetentionInHours Integer: The number of hours till which Kinesis Video will retain the data in the stream
deviceName String: The name of the device that is writing to the stream.
kmsKeyId String: AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
mediaType String: The media type of the stream. Consumers of the stream can use this information when processing the stream.
tags List<StreamTag>: An array of key-value pairs associated with the Kinesis Video Stream.

arn string: The Amazon Resource Name (ARN) of the Kinesis Video stream.
dataRetentionInHours number: The number of hours till which Kinesis Video will retain the data in the stream
deviceName string: The name of the device that is writing to the stream.
kmsKeyId string: AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
mediaType string: The media type of the stream. Consumers of the stream can use this information when processing the stream.
tags StreamTag[]: An array of key-value pairs associated with the Kinesis Video Stream.

arn str: The Amazon Resource Name (ARN) of the Kinesis Video stream.
data_retention_in_hours int: The number of hours till which Kinesis Video will retain the data in the stream
device_name str: The name of the device that is writing to the stream.
kms_key_id str: AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
media_type str: The media type of the stream. Consumers of the stream can use this information when processing the stream.
tags Sequence[StreamTag]: An array of key-value pairs associated with the Kinesis Video Stream.

arn String: The Amazon Resource Name (ARN) of the Kinesis Video stream.
dataRetentionInHours Number: The number of hours till which Kinesis Video will retain the data in the stream
deviceName String: The name of the device that is writing to the stream.
kmsKeyId String: AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
mediaType String: The media type of the stream. Consumers of the stream can use this information when processing the stream.
tags List<Property Map>: An array of key-value pairs associated with the Kinesis Video Stream.

Supporting Types

StreamTag

Key string: The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0