Skip to content
v2.274.0

CfnRecordingConfigurationProps Struct ​

Properties for defining a CfnRecordingConfiguration.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ivs as ivs } from 'aws-cdk-lib';
const cfnRecordingConfigurationProps: ivs.CfnRecordingConfigurationProps = {
  destinationConfiguration: {
    s3: {
      bucketName: 'bucketName',
    },
  },

  // the properties below are optional
  name: 'name',
  recordingReconnectWindowSeconds: 123,
  renditionConfiguration: {
    renditions: ['renditions'],
    renditionSelection: 'renditionSelection',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  thumbnailConfiguration: {
    recordingMode: 'recordingMode',
    resolution: 'resolution',
    storage: ['storage'],
    targetIntervalSeconds: 123,
  },
};

Properties ​

destinationConfigurationIResolvable | CfnRecordingConfiguration.DestinationConfigurationPropertydestination_configurationtyping.Union[IResolvable, DestinationConfigurationProperty]destinationConfigurationIResolvableDestinationConfigurationIResolvableDestinationConfigurationinterface{}required#
A destination configuration describes an S3 bucket where recorded video will be stored.

See the DestinationConfiguration property type for more information.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
Recording-configuration name.

The value does not need to be unique.

recordingReconnectWindowSecondsoptionalnumberrecording_reconnect_window_secondsoptionalint | floatrecordingReconnectWindowSecondsoptionalNumberRecordingReconnectWindowSecondsoptionaldoubleRecordingReconnectWindowSecondsoptional*float64= 0#
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

renditionConfigurationoptionalIResolvable | CfnRecordingConfiguration.RenditionConfigurationPropertyrendition_configurationoptionaltyping.Union[IResolvable, RenditionConfigurationProperty]renditionConfigurationoptionalIResolvableRenditionConfigurationoptionalIResolvableRenditionConfigurationoptionalinterface{}#
A rendition configuration describes which renditions should be recorded for a stream.

See the RenditionConfiguration property type for more information.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.

For more information, see Tag .

thumbnailConfigurationoptionalIResolvable | CfnRecordingConfiguration.ThumbnailConfigurationPropertythumbnail_configurationoptionaltyping.Union[IResolvable, ThumbnailConfigurationProperty]thumbnailConfigurationoptionalIResolvableThumbnailConfigurationoptionalIResolvableThumbnailConfigurationoptionalinterface{}#
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.

See the ThumbnailConfiguration property type for more information.