RecordingConfiguration
An object representing a configuration to record a channel stream.
Contents
- arn
-
Recording-configuration ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+Required: Yes
- destinationConfiguration
-
A complex type that contains information about where recorded video will be stored.
Type: DestinationConfiguration object
Required: Yes
- state
-
Indicates the current state of the recording configuration. When the state is
ACTIVE, the configuration is ready for recording a channel stream.Type: String
Valid Values:
CREATING | CREATE_FAILED | ACTIVERequired: Yes
- name
-
Recording-configuration name. The value does not need to be unique.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_]*Required: No
- 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.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.
Required: No
- renditionConfiguration
-
Object that describes which renditions should be recorded for a stream.
Type: RenditionConfiguration object
Required: No
-
Tags attached to the resource. Array of 1-50 maps, each of the form
string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- 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.
Type: ThumbnailConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
