RecordingConfigurationProps

class aws_cdk.aws_ivs_alpha.RecordingConfigurationProps(*, bucket, recording_configuration_name=None, recording_reconnect_window=None, rendition_configuration=None, thumbnail_configuration=None)

Bases: object

(experimental) Properties of the IVS Recording configuration.

Parameters:

  • bucket (IBucket) – (experimental) S3 bucket where recorded videos will be stored.

  • recording_configuration_name (Optional[str]) – (experimental) The name of the Recording configuration. The value does not need to be unique. Default: - auto generate

  • recording_reconnect_window (Optional[Duration]) – (experimental) If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. recordingReconnectWindow must be between 0 and 300 seconds Default: - 0 seconds (means disabled)

  • rendition_configuration (Optional[RenditionConfiguration]) – (experimental) A rendition configuration describes which renditions should be recorded for a stream. Default: - no rendition configuration

  • thumbnail_configuration (Optional[ThumbnailConfiguration]) – (experimental) A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session. Default: - no thumbnail configuration

Stability:

experimental

ExampleMetadata:

infused

Example:

# recording_bucket: s3.Bucket


recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
    bucket=recording_bucket,

    # set rendition configuration
    rendition_configuration=ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD])
)

Attributes

bucket

(experimental) S3 bucket where recorded videos will be stored.

Stability:

experimental

recording_configuration_name

(experimental) The name of the Recording configuration.

The value does not need to be unique.

Default:

  • auto generate

Stability:

experimental

recording_reconnect_window

(experimental) If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.

recordingReconnectWindow must be between 0 and 300 seconds

Default:

  • 0 seconds (means disabled)

Stability:

experimental

rendition_configuration

(experimental) A rendition configuration describes which renditions should be recorded for a stream.

Default:

  • no rendition configuration

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html

Stability:

experimental

thumbnail_configuration

(experimental) A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session.

Default:

  • no thumbnail configuration

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html

Stability:

experimental