Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
Documentation
data DeletionConfig Source #
The configuration details required to delete the connection of the stream from the Edge Agent.
See: newDeletionConfig
smart constructor.
DeletionConfig' | |
|
Instances
newDeletionConfig :: DeletionConfig Source #
Create a value of DeletionConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteAfterUpload:DeletionConfig'
, deletionConfig_deleteAfterUpload
- The boolean
value used to indicate whether or not you want to mark the
media for deletion, once it has been uploaded to the Kinesis Video
Stream cloud. The media files can be deleted if any of the deletion
configuration values are set to true
, such as when the limit for the
EdgeRetentionInHours
, or the MaxLocalMediaSizeInMB
, has been
reached.
Since the default value is set to true
, configure the uploader
schedule such that the media files are not being deleted before they are
initially uploaded to AWS cloud.
$sel:edgeRetentionInHours:DeletionConfig'
, deletionConfig_edgeRetentionInHours
- The number of hours that you want to retain the data in the stream on
the Edge Agent. The default value of the retention time is 720 hours,
which translates to 30 days.
$sel:localSizeConfig:DeletionConfig'
, deletionConfig_localSizeConfig
- The value of the local size required in order to delete the edge
configuration.
deletionConfig_deleteAfterUpload :: Lens' DeletionConfig (Maybe Bool) Source #
The boolean
value used to indicate whether or not you want to mark the
media for deletion, once it has been uploaded to the Kinesis Video
Stream cloud. The media files can be deleted if any of the deletion
configuration values are set to true
, such as when the limit for the
EdgeRetentionInHours
, or the MaxLocalMediaSizeInMB
, has been
reached.
Since the default value is set to true
, configure the uploader
schedule such that the media files are not being deleted before they are
initially uploaded to AWS cloud.
deletionConfig_edgeRetentionInHours :: Lens' DeletionConfig (Maybe Natural) Source #
The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.
deletionConfig_localSizeConfig :: Lens' DeletionConfig (Maybe LocalSizeConfig) Source #
The value of the local size required in order to delete the edge configuration.