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
- data RecordingConfiguration = RecordingConfiguration' {}
- newRecordingConfiguration :: Text -> DestinationConfiguration -> RecordingConfigurationState -> RecordingConfiguration
- recordingConfiguration_name :: Lens' RecordingConfiguration (Maybe Text)
- recordingConfiguration_recordingReconnectWindowSeconds :: Lens' RecordingConfiguration (Maybe Natural)
- recordingConfiguration_tags :: Lens' RecordingConfiguration (Maybe (HashMap Text Text))
- recordingConfiguration_thumbnailConfiguration :: Lens' RecordingConfiguration (Maybe ThumbnailConfiguration)
- recordingConfiguration_arn :: Lens' RecordingConfiguration Text
- recordingConfiguration_destinationConfiguration :: Lens' RecordingConfiguration DestinationConfiguration
- recordingConfiguration_state :: Lens' RecordingConfiguration RecordingConfigurationState
Documentation
data RecordingConfiguration Source #
An object representing a configuration to record a channel stream.
See: newRecordingConfiguration
smart constructor.
RecordingConfiguration' | |
|
Instances
newRecordingConfiguration Source #
Create a value of RecordingConfiguration
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:name:RecordingConfiguration'
, recordingConfiguration_name
- Recording-configuration name. The value does not need to be unique.
$sel:recordingReconnectWindowSeconds:RecordingConfiguration'
, recordingConfiguration_recordingReconnectWindowSeconds
- If a broadcast disconnects and then reconnects within the specified
interval, the multiple streams will be considered a single broadcast and
merged together. Default: 0.
$sel:tags:RecordingConfiguration'
, recordingConfiguration_tags
- Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
$sel:thumbnailConfiguration:RecordingConfiguration'
, recordingConfiguration_thumbnailConfiguration
- A complex type that allows you to enable/disable the recording of
thumbnails for a live session and modify the interval at which
thumbnails are generated for the live session.
$sel:arn:RecordingConfiguration'
, recordingConfiguration_arn
- Recording-configuration ARN.
$sel:destinationConfiguration:RecordingConfiguration'
, recordingConfiguration_destinationConfiguration
- A complex type that contains information about where recorded video will
be stored.
$sel:state:RecordingConfiguration'
, recordingConfiguration_state
- Indicates the current state of the recording configuration. When the
state is ACTIVE
, the configuration is ready for recording a channel
stream.
recordingConfiguration_name :: Lens' RecordingConfiguration (Maybe Text) Source #
Recording-configuration name. The value does not need to be unique.
recordingConfiguration_recordingReconnectWindowSeconds :: Lens' RecordingConfiguration (Maybe Natural) Source #
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
recordingConfiguration_tags :: Lens' RecordingConfiguration (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value)
. See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
recordingConfiguration_thumbnailConfiguration :: Lens' RecordingConfiguration (Maybe ThumbnailConfiguration) Source #
A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
recordingConfiguration_arn :: Lens' RecordingConfiguration Text Source #
Recording-configuration ARN.
recordingConfiguration_destinationConfiguration :: Lens' RecordingConfiguration DestinationConfiguration Source #
A complex type that contains information about where recorded video will be stored.
recordingConfiguration_state :: Lens' RecordingConfiguration RecordingConfigurationState Source #
Indicates the current state of the recording configuration. When the
state is ACTIVE
, the configuration is ready for recording a channel
stream.