CreateStreamInput
¶
Source code in docs_src/capo_kinesis_video/types/create_stream_input.py
data_retention_in_hours
instance-attribute
¶
data_retention_in_hours: NotRequired[DataRetentionInHours]
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. The minimum is 1 hour.
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.
device_name
instance-attribute
¶
device_name: NotRequired[DeviceName]
The name of the device that is writing to the stream.
In the current implementation, Kinesis Video Streams doesn't use this name.
kms_key_id
instance-attribute
¶
kms_key_id: NotRequired[KmsKeyId]
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 (aws/kinesisvideo) is used.
For more information, see DescribeKey.
media_type
instance-attribute
¶
media_type: NotRequired[MediaType]
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).
stream_name
instance-attribute
¶
stream_name: StreamName
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.
stream_storage_configuration
instance-attribute
¶
stream_storage_configuration: NotRequired[StreamStorageConfiguration]
The configuration for the stream's storage, including the default storage tier for stream data. This configuration determines how stream data is stored and accessed, with different tiers offering varying levels of performance and cost optimization.
If not specified, the stream will use the default storage configuration with HOT tier for optimal performance.
tags
instance-attribute
¶
tags: NotRequired[ResourceTags]
A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).