Skip to content
v2.273.0

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

RtmpOutputDefinition Struct ​

Output definition for an RTMP output group.

outputName is normalised (underscores → hyphens) for use as the destination reference ID.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive_alpha from '@aws-cdk/aws-medialive-alpha';
import * as cdk from 'aws-cdk-lib';

declare const encodeConfiguration: medialive_alpha.EncodeConfiguration;
declare const rtmpCertificateMode: medialive_alpha.RtmpCertificateMode;
declare const rtmpDestination: medialive_alpha.RtmpDestination;
const rtmpOutputDefinition: medialive_alpha.RtmpOutputDefinition = {
  destinations: [rtmpDestination],
  encodes: [encodeConfiguration],
  outputName: 'outputName',

  // the properties below are optional
  certificateMode: rtmpCertificateMode,
  connectionRetryInterval: cdk.Duration.minutes(30),
  numRetries: 123,
};

Properties ​

certificateModeRtmpCertificateModecertificate_modeRtmpCertificateModecertificateModeRtmpCertificateModeCertificateModeRtmpCertificateModeCertificateModeRtmpCertificateMode= service default#
The TLS certificate verification mode.
connectionRetryIntervalDurationconnection_retry_intervalDurationconnectionRetryIntervalDurationConnectionRetryIntervalDurationConnectionRetryIntervalDuration= service default#
The interval between connection retry attempts.
destinationsRtmpDestination[]destinationstyping.List[RtmpDestination]destinationsList<RtmpDestination>DestinationsRtmpDestination[]Destinations*[]RtmpDestinationrequired#
The RTMP destination(s) for this output — one per channel pipeline.

MediaLive publishes each RTMP output to one destination per pipeline (the console calls these "Destination A" and "Destination B"). Provide a single destination for a SINGLE_PIPELINE channel, or two (A then B) for a STANDARD channel.

encodesEncodeConfiguration[]encodestyping.List[EncodeConfiguration]encodesList<EncodeConfiguration>EncodesEncodeConfiguration[]Encodes*[]EncodeConfigurationrequired#
The encode configurations to wire to this output.
numRetriesnumbernum_retriesint | floatnumRetriesNumberNumRetriesdoubleNumRetries*float64= service default#
The number of retry attempts.
outputNamestringoutput_namestroutputNameStringOutputNamestringOutputName*stringrequired#
The name of this output.

Must be unique across all outputs in the channel.