1.204.0

interface CfnRecordingConfigurationProps

LanguageType name
.NETAmazon.CDK.AWS.IVS.CfnRecordingConfigurationProps
Javasoftware.amazon.awscdk.services.ivs.CfnRecordingConfigurationProps
Pythonaws_cdk.aws_ivs.CfnRecordingConfigurationProps
TypeScript @aws-cdk/aws-ivs » CfnRecordingConfigurationProps

Properties for defining a CfnRecordingConfiguration.

Example

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

  // the properties below are optional
  name: 'name',
  recordingReconnectWindowSeconds: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  thumbnailConfiguration: {
    recordingMode: 'recordingMode',

    // the properties below are optional
    targetIntervalSeconds: 123,
  },
};

Properties

NameTypeDescription
destinationConfigurationIResolvable | DestinationConfigurationPropertyA destination configuration contains information about where recorded video will be stored.
name?stringRecording-configuration name.
recordingReconnectWindowSeconds?numberIf a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
tags?CfnTag[]An array of key-value pairs to apply to this resource.
thumbnailConfiguration?IResolvable | ThumbnailConfigurationPropertyA 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.

destinationConfiguration

Type: IResolvable | DestinationConfigurationProperty

A destination configuration contains information about where recorded video will be stored.

See the DestinationConfiguration property type for more information.

name?

Type: string (optional)

Recording-configuration name.

The value does not need to be unique.

recordingReconnectWindowSeconds?

Type: number (optional)

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

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

thumbnailConfiguration?

Type: IResolvable | ThumbnailConfigurationProperty (optional)

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.

← PreviousNext →