class FailoverConfig
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.MediaConnect.Alpha.FailoverConfig |
Go | github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2#FailoverConfig |
Java | software.amazon.awscdk.services.mediaconnect.alpha.FailoverConfig |
Python | aws_cdk.aws_mediaconnect_alpha.FailoverConfig |
TypeScript (source) | @aws-cdk/aws-mediaconnect-alpha ยป FailoverConfig |
Source failover configuration for a flow.
MediaConnect supports two failover modes:
- {@link FailoverConfig.merge} combines two binary-identical sources into a single stream, recovering lost packets from the other source (SMPTE 2022-7).
- {@link FailoverConfig.failover} switches between a primary and backup source when the active source stops receiving data.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as mediaconnect_alpha from '@aws-cdk/aws-mediaconnect-alpha';
const failoverConfig = mediaconnect_alpha.FailoverConfig.failover(/* all optional props */ {
primarySource: 'primarySource',
state: mediaconnect_alpha.State.ENABLED,
});
Methods
| Name | Description |
|---|---|
| static failover(options?) | Configure switchover-mode failover. |
| static merge(options?) | Configure merge-mode failover. |
static failover(options?)
public static failover(options?: FailoverFailoverOptions): FailoverConfig
Parameters
- options
FailoverFailover Options
Returns
Configure switchover-mode failover.
The flow swaps to the backup source when the primary source stops receiving data.
static merge(options?)
public static merge(options?: MergeFailoverOptions): FailoverConfig
Parameters
- options
MergeFailover Options
Returns
Configure merge-mode failover.
Requires two binary-identical sources.

.NET
Go
Java
Python
TypeScript (