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.EdgeConfig

Description

Documentation

data EdgeConfig Source #

A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

See: newEdgeConfig smart constructor.

Constructors

EdgeConfig'

Fields

deletionConfig :: Maybe DeletionConfig
The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.
uploaderConfig :: Maybe UploaderConfig
The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.
hubDeviceArn :: Text
The "Internet of Things (IoT) Thing" Arn of the stream.
recorderConfig :: RecorderConfig
The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

Instances

Instances details

FromJSON EdgeConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.EdgeConfig Methods parseJSON :: Value -> Parser EdgeConfig # parseJSONList :: Value -> Parser [EdgeConfig] #
ToJSON EdgeConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.EdgeConfig Methods toJSON :: EdgeConfig -> Value # toEncoding :: EdgeConfig -> Encoding # toJSONList :: [EdgeConfig] -> Value # toEncodingList :: [EdgeConfig] -> Encoding #
Generic EdgeConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.EdgeConfig Associated Types type Rep EdgeConfig :: Type -> Type # Methods from :: EdgeConfig -> Rep EdgeConfig x # to :: Rep EdgeConfig x -> EdgeConfig #
Show EdgeConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.EdgeConfig Methods showsPrec :: Int -> EdgeConfig -> ShowS # show :: EdgeConfig -> String # showList :: [EdgeConfig] -> ShowS #
NFData EdgeConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.EdgeConfig Methods rnf :: EdgeConfig -> () #
Eq EdgeConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.EdgeConfig Methods (==) :: EdgeConfig -> EdgeConfig -> Bool # (/=) :: EdgeConfig -> EdgeConfig -> Bool #
Hashable EdgeConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.EdgeConfig Methods hashWithSalt :: Int -> EdgeConfig -> Int # hash :: EdgeConfig -> Int #
type Rep EdgeConfig Source #
Instance details Defined in Amazonka.KinesisVideo.Types.EdgeConfig type Rep EdgeConfig = D1 ('MetaData "EdgeConfig" "Amazonka.KinesisVideo.Types.EdgeConfig" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "EdgeConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deletionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeletionConfig)) :: S1 ('MetaSel ('Just "uploaderConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UploaderConfig))) :: (S1 ('MetaSel ('Just "hubDeviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "recorderConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecorderConfig))))

newEdgeConfig Source #

Arguments

:: Text	`$sel:hubDeviceArn:EdgeConfig'`
-> RecorderConfig	`$sel:recorderConfig:EdgeConfig'`
-> EdgeConfig

Create a value of EdgeConfig 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:deletionConfig:EdgeConfig', edgeConfig_deletionConfig - The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

$sel:uploaderConfig:EdgeConfig', edgeConfig_uploaderConfig - The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

$sel:hubDeviceArn:EdgeConfig', edgeConfig_hubDeviceArn - The "Internet of Things (IoT) Thing" Arn of the stream.

$sel:recorderConfig:EdgeConfig', edgeConfig_recorderConfig - The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

edgeConfig_deletionConfig :: Lens' EdgeConfig (Maybe DeletionConfig) Source #

The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

edgeConfig_uploaderConfig :: Lens' EdgeConfig (Maybe UploaderConfig) Source #

The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

edgeConfig_hubDeviceArn :: Lens' EdgeConfig Text Source #

The "Internet of Things (IoT) Thing" Arn of the stream.

edgeConfig_recorderConfig :: Lens' EdgeConfig RecorderConfig Source #

The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.