You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb

Overview

Note:

When making an API call, you may pass CreateStreamInput data as a hash:

{
  device_name: "DeviceName",
  stream_name: "StreamName", # required
  media_type: "MediaType",
  kms_key_id: "KmsKeyId",
  data_retention_in_hours: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#data_retention_in_hoursInteger

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)


88
89
90
91
92
93
94
95
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 88

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours)
  include Aws::Structure
end

#device_nameString

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

In the current implementation, Kinesis Video Streams does not use this name.

Returns:

  • (String)


88
89
90
91
92
93
94
95
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 88

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours)
  include Aws::Structure
end

#kms_key_idString

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.

For more information, see DescribeKey.

Returns:

  • (String)


88
89
90
91
92
93
94
95
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 88

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours)
  include Aws::Structure
end

#media_typeString

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.

To play video on the console, the media must be H.264 encoded, and you need to specify this video type in this parameter as video/h264.

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

Returns:

  • (String)


88
89
90
91
92
93
94
95
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 88

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours)
  include Aws::Structure
end

#stream_nameString

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)


88
89
90
91
92
93
94
95
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 88

class CreateStreamInput < Struct.new(
  :device_name,
  :stream_name,
  :media_type,
  :kms_key_id,
  :data_retention_in_hours)
  include Aws::Structure
end