Class: Aws::KinesisVideo::Types::CreateStreamInput

Inherits:

Struct

• Object
• Struct
• Aws::KinesisVideo::Types::CreateStreamInput

Includes:

Structure

Defined in:

lib/aws-sdk-kinesisvideo/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_retention_in_hours ⇒ Integer

  The number of hours that you want to retain the data in the stream.

• #device_name ⇒ String

  The name of the device that is writing to the stream.

• #kms_key_id ⇒ String

  The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

• #media_type ⇒ String

  The media type of the stream.

• #stream_name ⇒ String

  A name for the stream that you are creating.

• #tags ⇒ Hash<String,String>

  A list of tags to associate with the specified stream.

Instance Attribute Details

#data_retention_in_hours ⇒ Integer

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.

When the ‘DataRetentionInHours` value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

Returns:

• (Integer)

# File 'lib/aws-sdk-kinesisvideo/types.rb', line 251

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#device_name ⇒ String

The name of the device that is writing to the stream.

<note markdown=“1”> In the current implementation, Kinesis Video Streams does not use this name.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-kinesisvideo/types.rb', line 251

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The ID of the Key Management Service (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 (‘Amazon Web Services/kinesisvideo`) is used.

For more information, see [DescribeKey].

[1]: docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters

Returns:

• (String)

# File 'lib/aws-sdk-kinesisvideo/types.rb', line 251

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#media_type ⇒ 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.

Example valid values include “video/h264” and “video/h264,audio/aac”.

This parameter is optional; the default value is ‘null` (or empty in JSON).

[1]: www.iana.org/assignments/media-types/media-types.xhtml [2]: tools.ietf.org/html/rfc6838#section-4.2

Returns:

• (String)

# File 'lib/aws-sdk-kinesisvideo/types.rb', line 251

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name ⇒ String

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

Returns:

• (String)

# File 'lib/aws-sdk-kinesisvideo/types.rb', line 251

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-kinesisvideo/types.rb', line 251

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end