Skip to content
v2.275.0

CfnStageProps Struct ​

Properties for defining a CfnStage.

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 cfnStageProps: ivs.CfnStageProps = {
  autoParticipantRecordingConfiguration: {
    storageConfigurationArn: 'storageConfigurationArn',

    // the properties below are optional
    hlsConfiguration: {
      participantRecordingHlsConfiguration: {
        targetSegmentDurationSeconds: 123,
      },
    },
    mediaTypes: ['mediaTypes'],
    recordingReconnectWindowSeconds: 123,
    thumbnailConfiguration: {
      participantThumbnailConfiguration: {
        recordingMode: 'recordingMode',
        storage: ['storage'],
        targetIntervalSeconds: 123,
      },
    },
  },
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

autoParticipantRecordingConfigurationoptionalIResolvable | CfnStage.AutoParticipantRecordingConfigurationPropertyauto_participant_recording_configurationoptionaltyping.Union[IResolvable, AutoParticipantRecordingConfigurationProperty]autoParticipantRecordingConfigurationoptionalIResolvableAutoParticipantRecordingConfigurationoptionalIResolvableAutoParticipantRecordingConfigurationoptionalinterface{}#
Configuration object for individual participant recording.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
Stage name.
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 .