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

Amazonka.KinesisVideo.Types.DeletionConfig

Description

Documentation

data DeletionConfig Source #

The configuration details required to delete the connection of the stream from the Edge Agent.

See: newDeletionConfig smart constructor.

Constructors

DeletionConfig'

Fields

deleteAfterUpload :: Maybe Bool
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.
edgeRetentionInHours :: Maybe Natural
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.
localSizeConfig :: Maybe LocalSizeConfig
The value of the local size required in order to delete the edge configuration.

Instances

Instances details

FromJSON DeletionConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.DeletionConfig Methods parseJSON :: Value -> Parser DeletionConfig # parseJSONList :: Value -> Parser [DeletionConfig] #
ToJSON DeletionConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.DeletionConfig Methods toJSON :: DeletionConfig -> Value # toEncoding :: DeletionConfig -> Encoding # toJSONList :: [DeletionConfig] -> Value # toEncodingList :: [DeletionConfig] -> Encoding #
Generic DeletionConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.DeletionConfig Associated Types type Rep DeletionConfig :: Type -> Type # Methods from :: DeletionConfig -> Rep DeletionConfig x # to :: Rep DeletionConfig x -> DeletionConfig #
Read DeletionConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.DeletionConfig Methods readsPrec :: Int -> ReadS DeletionConfig # readList :: ReadS [DeletionConfig] # readPrec :: ReadPrec DeletionConfig # readListPrec :: ReadPrec [DeletionConfig] #
Show DeletionConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.DeletionConfig Methods showsPrec :: Int -> DeletionConfig -> ShowS # show :: DeletionConfig -> String # showList :: [DeletionConfig] -> ShowS #
NFData DeletionConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.DeletionConfig Methods rnf :: DeletionConfig -> () #
Eq DeletionConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.DeletionConfig Methods (==) :: DeletionConfig -> DeletionConfig -> Bool # (/=) :: DeletionConfig -> DeletionConfig -> Bool #
Hashable DeletionConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.DeletionConfig Methods hashWithSalt :: Int -> DeletionConfig -> Int # hash :: DeletionConfig -> Int #
type Rep DeletionConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.DeletionConfig type Rep DeletionConfig = D1 ('MetaData "DeletionConfig" "Amazonka.KinesisVideo.Types.DeletionConfig" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "DeletionConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteAfterUpload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "edgeRetentionInHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "localSizeConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LocalSizeConfig)))))

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.