Skip to content
v2.277.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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_medialive_alpha as medialive_alpha
import aws_cdk as cdk

# encode_configuration: medialive_alpha.EncodeConfiguration
# rtmp_certificate_mode: medialive_alpha.RtmpCertificateMode
# rtmp_destination: medialive_alpha.RtmpDestination

rtmp_output_definition = medialive_alpha.RtmpOutputDefinition(
    destinations=[rtmp_destination],
    encodes=[encode_configuration],
    output_name="outputName",

    # the properties below are optional
    certificate_mode=rtmp_certificate_mode,
    connection_retry_interval=cdk.Duration.minutes(30),
    num_retries=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.medialive.alpha.*;
import software.amazon.awscdk.*;

EncodeConfiguration encodeConfiguration;
RtmpCertificateMode rtmpCertificateMode;
RtmpDestination rtmpDestination;

RtmpOutputDefinition rtmpOutputDefinition = RtmpOutputDefinition.builder()
        .destinations(List.of(rtmpDestination))
        .encodes(List.of(encodeConfiguration))
        .outputName("outputName")

        // the properties below are optional
        .certificateMode(rtmpCertificateMode)
        .connectionRetryInterval(Duration.minutes(30))
        .numRetries(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaLive.Alpha;
using Amazon.CDK;

EncodeConfiguration encodeConfiguration;
RtmpCertificateMode rtmpCertificateMode;
RtmpDestination rtmpDestination;

var rtmpOutputDefinition = new RtmpOutputDefinition {
    Destinations = new [] { rtmpDestination },
    Encodes = new [] { encodeConfiguration },
    OutputName = "outputName",

    // the properties below are optional
    CertificateMode = rtmpCertificateMode,
    ConnectionRetryInterval = Duration.Minutes(30),
    NumRetries = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import medialive_alpha "github.com/aws/aws-cdk-go/awsmedialivealpha"
import cdk "github.com/aws/aws-cdk-go/awscdk"

var encodeConfiguration EncodeConfiguration
var rtmpCertificateMode RtmpCertificateMode
var rtmpDestination RtmpDestination

rtmpOutputDefinition := &RtmpOutputDefinition{
	Destinations: []RtmpDestination{
		rtmpDestination,
	},
	Encodes: []EncodeConfiguration{
		encodeConfiguration,
	},
	OutputName: jsii.String("outputName"),

	// the properties below are optional
	CertificateMode: rtmpCertificateMode,
	ConnectionRetryInterval: cdk.Duration_Minutes(jsii.Number(30)),
	NumRetries: jsii.Number(123),
}

Properties ​

certificateModeoptionalRtmpCertificateModecertificate_modeoptionalRtmpCertificateModecertificateModeoptionalRtmpCertificateModeCertificateModeoptionalRtmpCertificateModeCertificateModeoptionalRtmpCertificateMode #
The TLS certificate verification mode.

Default: service default

connectionRetryIntervaloptionalDurationconnection_retry_intervaloptionalDurationconnectionRetryIntervaloptionalDurationConnectionRetryIntervaloptionalDurationConnectionRetryIntervaloptionalDuration #
The interval between connection retry attempts.

Default: service default

destinationsRtmpDestination[]destinationstyping.List[RtmpDestination]destinationsList<RtmpDestination>DestinationsRtmpDestination[]Destinations*[]RtmpDestination required #
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*[]EncodeConfiguration required #
The encode configurations to wire to this output.
numRetriesoptionalnumbernum_retriesoptionalint | floatnumRetriesoptionalNumberNumRetriesoptionaldoubleNumRetriesoptional*float64 #
The number of retry attempts.

Default: service default

outputNamestringoutput_namestroutputNameStringOutputNamestringOutputName*string required #
The name of this output.

Must be unique across all outputs in the channel.