AWS CDK Reference

Appearance

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.

BridgeFailoverOptions Struct ​

Options for bridge source failover.

Stability
Experimental
Source
lib/bridge.ts

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 bridgeFailoverOptions: mediaconnect_alpha.BridgeFailoverOptions = {
  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_options = mediaconnect_alpha.BridgeFailoverOptions(
    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.*;

BridgeFailoverOptions bridgeFailoverOptions = 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 bridgeFailoverOptions = 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 mediaconnect_alpha "github.com/aws/aws-cdk-go/awsmediaconnectalpha"

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

Properties ​

primarySourceoptionalstringprimary_sourceoptionalstrprimarySourceoptionalStringPrimarySourceoptionalstringPrimarySourceoptional*string#
The name of the source you want to treat as primary.

Default: both sources are equal priority

If set, MediaConnect always uses this source when it is available. When unset, both sources are treated with equal priority.

stateoptionalStatestateoptionalStatestateoptionalStateStateoptionalStateStateoptionalState= State.ENABLED#
Whether failover is enabled.

Set to State.DISABLED to keep the configuration on the bridge without switching failover on.