Skip to content
v2.276.0

Experimental

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

BridgeFailoverConfig Class ​

Source failover configuration for a bridge.

Bridges only support FAILOVER (switchover) mode — the MERGE mode available on Flow.sourceFailoverConfig is not allowed on bridges by the service. Use {@link BridgeFailoverConfig.failover} to construct the configuration.

Example ​

ts
// 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 bridgeFailoverConfig = mediaconnect_alpha.BridgeFailoverConfig.failover(/* all optional props */ {
  primarySource: 'primarySource',
  state: mediaconnect_alpha.State.ENABLED,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_mediaconnect_alpha as mediaconnect_alpha

bridge_failover_config = mediaconnect_alpha.BridgeFailoverConfig.failover(
    primary_source="primarySource",
    state=mediaconnect_alpha.State.ENABLED
)
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.mediaconnect.alpha.*;

BridgeFailoverConfig bridgeFailoverConfig = BridgeFailoverConfig.failover(BridgeFailoverOptions.builder()
        .primarySource("primarySource")
        .state(State.ENABLED)
        .build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaConnect.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaConnect.Alpha;

var bridgeFailoverConfig = BridgeFailoverConfig.Failover(new BridgeFailoverOptions {
    PrimarySource = "primarySource",
    State = State.ENABLED
});
go
// Install: go get github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awsmediaconnectalpha"

bridgeFailoverConfig := mediaconnect_alpha.BridgeFailoverConfig_Failover(&BridgeFailoverOptions{
	PrimarySource: jsii.String("primarySource"),
	State: mediaconnect_alpha.State_ENABLED,
})

Methods ​

failover(options?: BridgeFailoverOptions): BridgeFailoverConfig // chainable@staticmethod def failover(options: typing.Optional[BridgeFailoverOptions] = None) -> BridgeFailoverConfigpublic static BridgeFailoverConfig failover(BridgeFailoverOptions options)public static BridgeFailoverConfig Failover(BridgeFailoverOptions? options = null)func Failover(Options BridgeFailoverOptions) BridgeFailoverConfigstatic#
Configure switchover-mode failover.

The bridge swaps to the backup source when the primary source stops receiving data.