interface OutputGroupProperty

Language	Type name
.NET	Amazon.CDK.AWS.MediaLive.CfnChannel.OutputGroupProperty
Java	software.amazon.awscdk.services.medialive.CfnChannel.OutputGroupProperty
Python	aws_cdk.aws_medialive.CfnChannel.OutputGroupProperty
TypeScript	@aws-cdk/aws-medialive » CfnChannel » OutputGroupProperty

The settings for one output group.

The parent of this entity is EncoderSettings.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive from '@aws-cdk/aws-medialive';
const outputGroupProperty: medialive.CfnChannel.OutputGroupProperty = {
  name: 'name',
  outputGroupSettings: {
    archiveGroupSettings: {
      archiveCdnSettings: {
        archiveS3Settings: {
          cannedAcl: 'cannedAcl',
        },
      },
      destination: {
        destinationRefId: 'destinationRefId',
      },
      rolloverInterval: 123,
    },
    frameCaptureGroupSettings: {
      destination: {
        destinationRefId: 'destinationRefId',
      },
      frameCaptureCdnSettings: {
        frameCaptureS3Settings: {
          cannedAcl: 'cannedAcl',
        },
      },
    },
    hlsGroupSettings: {
      adMarkers: ['adMarkers'],
      baseUrlContent: 'baseUrlContent',
      baseUrlContent1: 'baseUrlContent1',
      baseUrlManifest: 'baseUrlManifest',
      baseUrlManifest1: 'baseUrlManifest1',
      captionLanguageMappings: [{
        captionChannel: 123,
        languageCode: 'languageCode',
        languageDescription: 'languageDescription',
      }],
      captionLanguageSetting: 'captionLanguageSetting',
      clientCache: 'clientCache',
      codecSpecification: 'codecSpecification',
      constantIv: 'constantIv',
      destination: {
        destinationRefId: 'destinationRefId',
      },
      directoryStructure: 'directoryStructure',
      discontinuityTags: 'discontinuityTags',
      encryptionType: 'encryptionType',
      hlsCdnSettings: {
        hlsAkamaiSettings: {
          connectionRetryInterval: 123,
          filecacheDuration: 123,
          httpTransferMode: 'httpTransferMode',
          numRetries: 123,
          restartDelay: 123,
          salt: 'salt',
          token: 'token',
        },
        hlsBasicPutSettings: {
          connectionRetryInterval: 123,
          filecacheDuration: 123,
          numRetries: 123,
          restartDelay: 123,
        },
        hlsMediaStoreSettings: {
          connectionRetryInterval: 123,
          filecacheDuration: 123,
          mediaStoreStorageClass: 'mediaStoreStorageClass',
          numRetries: 123,
          restartDelay: 123,
        },
        hlsS3Settings: {
          cannedAcl: 'cannedAcl',
        },
        hlsWebdavSettings: {
          connectionRetryInterval: 123,
          filecacheDuration: 123,
          httpTransferMode: 'httpTransferMode',
          numRetries: 123,
          restartDelay: 123,
        },
      },
      hlsId3SegmentTagging: 'hlsId3SegmentTagging',
      iFrameOnlyPlaylists: 'iFrameOnlyPlaylists',
      incompleteSegmentBehavior: 'incompleteSegmentBehavior',
      indexNSegments: 123,
      inputLossAction: 'inputLossAction',
      ivInManifest: 'ivInManifest',
      ivSource: 'ivSource',
      keepSegments: 123,
      keyFormat: 'keyFormat',
      keyFormatVersions: 'keyFormatVersions',
      keyProviderSettings: {
        staticKeySettings: {
          keyProviderServer: {
            passwordParam: 'passwordParam',
            uri: 'uri',
            username: 'username',
          },
          staticKeyValue: 'staticKeyValue',
        },
      },
      manifestCompression: 'manifestCompression',
      manifestDurationFormat: 'manifestDurationFormat',
      minSegmentLength: 123,
      mode: 'mode',
      outputSelection: 'outputSelection',
      programDateTime: 'programDateTime',
      programDateTimeClock: 'programDateTimeClock',
      programDateTimePeriod: 123,
      redundantManifest: 'redundantManifest',
      segmentationMode: 'segmentationMode',
      segmentLength: 123,
      segmentsPerSubdirectory: 123,
      streamInfResolution: 'streamInfResolution',
      timedMetadataId3Frame: 'timedMetadataId3Frame',
      timedMetadataId3Period: 123,
      timestampDeltaMilliseconds: 123,
      tsFileMode: 'tsFileMode',
    },
    mediaPackageGroupSettings: {
      destination: {
        destinationRefId: 'destinationRefId',
      },
    },
    msSmoothGroupSettings: {
      acquisitionPointId: 'acquisitionPointId',
      audioOnlyTimecodeControl: 'audioOnlyTimecodeControl',
      certificateMode: 'certificateMode',
      connectionRetryInterval: 123,
      destination: {
        destinationRefId: 'destinationRefId',
      },
      eventId: 'eventId',
      eventIdMode: 'eventIdMode',
      eventStopBehavior: 'eventStopBehavior',
      filecacheDuration: 123,
      fragmentLength: 123,
      inputLossAction: 'inputLossAction',
      numRetries: 123,
      restartDelay: 123,
      segmentationMode: 'segmentationMode',
      sendDelayMs: 123,
      sparseTrackType: 'sparseTrackType',
      streamManifestBehavior: 'streamManifestBehavior',
      timestampOffset: 'timestampOffset',
      timestampOffsetMode: 'timestampOffsetMode',
    },
    multiplexGroupSettings: { },
    rtmpGroupSettings: {
      adMarkers: ['adMarkers'],
      authenticationScheme: 'authenticationScheme',
      cacheFullBehavior: 'cacheFullBehavior',
      cacheLength: 123,
      captionData: 'captionData',
      inputLossAction: 'inputLossAction',
      restartDelay: 123,
    },
    udpGroupSettings: {
      inputLossAction: 'inputLossAction',
      timedMetadataId3Frame: 'timedMetadataId3Frame',
      timedMetadataId3Period: 123,
    },
  },
  outputs: [{
    audioDescriptionNames: ['audioDescriptionNames'],
    captionDescriptionNames: ['captionDescriptionNames'],
    outputName: 'outputName',
    outputSettings: {
      archiveOutputSettings: {
        containerSettings: {
          m2TsSettings: {
            absentInputAudioBehavior: 'absentInputAudioBehavior',
            arib: 'arib',
            aribCaptionsPid: 'aribCaptionsPid',
            aribCaptionsPidControl: 'aribCaptionsPidControl',
            audioBufferModel: 'audioBufferModel',
            audioFramesPerPes: 123,
            audioPids: 'audioPids',
            audioStreamType: 'audioStreamType',
            bitrate: 123,
            bufferModel: 'bufferModel',
            ccDescriptor: 'ccDescriptor',
            dvbNitSettings: {
              networkId: 123,
              networkName: 'networkName',
              repInterval: 123,
            },
            dvbSdtSettings: {
              outputSdt: 'outputSdt',
              repInterval: 123,
              serviceName: 'serviceName',
              serviceProviderName: 'serviceProviderName',
            },
            dvbSubPids: 'dvbSubPids',
            dvbTdtSettings: {
              repInterval: 123,
            },
            dvbTeletextPid: 'dvbTeletextPid',
            ebif: 'ebif',
            ebpAudioInterval: 'ebpAudioInterval',
            ebpLookaheadMs: 123,
            ebpPlacement: 'ebpPlacement',
            ecmPid: 'ecmPid',
            esRateInPes: 'esRateInPes',
            etvPlatformPid: 'etvPlatformPid',
            etvSignalPid: 'etvSignalPid',
            fragmentTime: 123,
            klv: 'klv',
            klvDataPids: 'klvDataPids',
            nielsenId3Behavior: 'nielsenId3Behavior',
            nullPacketBitrate: 123,
            patInterval: 123,
            pcrControl: 'pcrControl',
            pcrPeriod: 123,
            pcrPid: 'pcrPid',
            pmtInterval: 123,
            pmtPid: 'pmtPid',
            programNum: 123,
            rateMode: 'rateMode',
            scte27Pids: 'scte27Pids',
            scte35Control: 'scte35Control',
            scte35Pid: 'scte35Pid',
            scte35PrerollPullupMilliseconds: 123,
            segmentationMarkers: 'segmentationMarkers',
            segmentationStyle: 'segmentationStyle',
            segmentationTime: 123,
            timedMetadataBehavior: 'timedMetadataBehavior',
            timedMetadataPid: 'timedMetadataPid',
            transportStreamId: 123,
            videoPid: 'videoPid',
          },
          rawSettings: { },
        },
        extension: 'extension',
        nameModifier: 'nameModifier',
      },
      frameCaptureOutputSettings: {
        nameModifier: 'nameModifier',
      },
      hlsOutputSettings: {
        h265PackagingType: 'h265PackagingType',
        hlsSettings: {
          audioOnlyHlsSettings: {
            audioGroupId: 'audioGroupId',
            audioOnlyImage: {
              passwordParam: 'passwordParam',
              uri: 'uri',
              username: 'username',
            },
            audioTrackType: 'audioTrackType',
            segmentType: 'segmentType',
          },
          fmp4HlsSettings: {
            audioRenditionSets: 'audioRenditionSets',
            nielsenId3Behavior: 'nielsenId3Behavior',
            timedMetadataBehavior: 'timedMetadataBehavior',
          },
          frameCaptureHlsSettings: { },
          standardHlsSettings: {
            audioRenditionSets: 'audioRenditionSets',
            m3U8Settings: {
              audioFramesPerPes: 123,
              audioPids: 'audioPids',
              ecmPid: 'ecmPid',
              nielsenId3Behavior: 'nielsenId3Behavior',
              patInterval: 123,
              pcrControl: 'pcrControl',
              pcrPeriod: 123,
              pcrPid: 'pcrPid',
              pmtInterval: 123,
              pmtPid: 'pmtPid',
              programNum: 123,
              scte35Behavior: 'scte35Behavior',
              scte35Pid: 'scte35Pid',
              timedMetadataBehavior: 'timedMetadataBehavior',
              timedMetadataPid: 'timedMetadataPid',
              transportStreamId: 123,
              videoPid: 'videoPid',
            },
          },
        },
        nameModifier: 'nameModifier',
        segmentModifier: 'segmentModifier',
      },
      mediaPackageOutputSettings: { },
      msSmoothOutputSettings: {
        h265PackagingType: 'h265PackagingType',
        nameModifier: 'nameModifier',
      },
      multiplexOutputSettings: {
        destination: {
          destinationRefId: 'destinationRefId',
        },
      },
      rtmpOutputSettings: {
        certificateMode: 'certificateMode',
        connectionRetryInterval: 123,
        destination: {
          destinationRefId: 'destinationRefId',
        },
        numRetries: 123,
      },
      udpOutputSettings: {
        bufferMsec: 123,
        containerSettings: {
          m2TsSettings: {
            absentInputAudioBehavior: 'absentInputAudioBehavior',
            arib: 'arib',
            aribCaptionsPid: 'aribCaptionsPid',
            aribCaptionsPidControl: 'aribCaptionsPidControl',
            audioBufferModel: 'audioBufferModel',
            audioFramesPerPes: 123,
            audioPids: 'audioPids',
            audioStreamType: 'audioStreamType',
            bitrate: 123,
            bufferModel: 'bufferModel',
            ccDescriptor: 'ccDescriptor',
            dvbNitSettings: {
              networkId: 123,
              networkName: 'networkName',
              repInterval: 123,
            },
            dvbSdtSettings: {
              outputSdt: 'outputSdt',
              repInterval: 123,
              serviceName: 'serviceName',
              serviceProviderName: 'serviceProviderName',
            },
            dvbSubPids: 'dvbSubPids',
            dvbTdtSettings: {
              repInterval: 123,
            },
            dvbTeletextPid: 'dvbTeletextPid',
            ebif: 'ebif',
            ebpAudioInterval: 'ebpAudioInterval',
            ebpLookaheadMs: 123,
            ebpPlacement: 'ebpPlacement',
            ecmPid: 'ecmPid',
            esRateInPes: 'esRateInPes',
            etvPlatformPid: 'etvPlatformPid',
            etvSignalPid: 'etvSignalPid',
            fragmentTime: 123,
            klv: 'klv',
            klvDataPids: 'klvDataPids',
            nielsenId3Behavior: 'nielsenId3Behavior',
            nullPacketBitrate: 123,
            patInterval: 123,
            pcrControl: 'pcrControl',
            pcrPeriod: 123,
            pcrPid: 'pcrPid',
            pmtInterval: 123,
            pmtPid: 'pmtPid',
            programNum: 123,
            rateMode: 'rateMode',
            scte27Pids: 'scte27Pids',
            scte35Control: 'scte35Control',
            scte35Pid: 'scte35Pid',
            scte35PrerollPullupMilliseconds: 123,
            segmentationMarkers: 'segmentationMarkers',
            segmentationStyle: 'segmentationStyle',
            segmentationTime: 123,
            timedMetadataBehavior: 'timedMetadataBehavior',
            timedMetadataPid: 'timedMetadataPid',
            transportStreamId: 123,
            videoPid: 'videoPid',
          },
        },
        destination: {
          destinationRefId: 'destinationRefId',
        },
        fecOutputSettings: {
          columnDepth: 123,
          includeFec: 'includeFec',
          rowLength: 123,
        },
      },
    },
    videoDescriptionName: 'videoDescriptionName',
  }],
};

Properties

Name	Type	Description
name?	string	A custom output group name that you can optionally define.
outputGroupSettings?	IResolvable | OutputGroupSettingsProperty	The settings associated with the output group.
outputs?	IResolvable | IResolvable | OutputProperty[]	The settings for the outputs in the output group.

---

name?

Type: string (optional)

A custom output group name that you can optionally define.

Only letters, numbers, and the underscore character are allowed. The maximum length is 32 characters.

---

outputGroupSettings?

Type: IResolvable | OutputGroupSettingsProperty (optional)

The settings associated with the output group.

---

outputs?

Type: IResolvable | IResolvable | OutputProperty[] (optional)

The settings for the outputs in the output group.