Package software.amazon.awscdk.services.mediaconnect.alpha

Interface FailoverConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FailoverConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:28.334Z")
@Stability(Experimental)
public interface FailoverConfigurationProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for failover Router Input configuration.

Example:

 Stack stack;
 RouterNetworkInterface networkInterface;
 RouterInput input = RouterInput.Builder.create(stack, "FailoverInput")
         .routerInputName("failover-input")
         .maximumBitrate(Bitrate.mbps(10))
         .routingScope(RoutingScope.REGIONAL)
         .tier(RouterInputTier.INPUT_50)
         .configuration(RouterInputConfiguration.failover(FailoverConfigurationProps.builder()
                 .networkInterface(networkInterface)
                 .protocols(List.of(RouterInputProtocol.rist(RistProtocolProps.builder()
                         .port(5000)
                         .recoveryLatency(Duration.millis(1000))
                         .build()), RouterInputProtocol.rist(RistProtocolProps.builder()
                         .port(5002) // Must not be consecutive with primary port
                         .recoveryLatency(Duration.millis(1000))
                         .build())))
                 .sourcePriority(SourcePriorityConfig.primarySecondary(PrimarySource.FIRST_SOURCE))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FailoverConfigurationProps.Builder	A builder for FailoverConfigurationProps
static final class	FailoverConfigurationProps.Jsii$Proxy	An implementation for FailoverConfigurationProps

Method Summary

Modifier and Type	Method	Description
static FailoverConfigurationProps.Builder	builder()
default String	getAvailabilityZone()	(experimental) The availability zone where the router input is located.
IRouterNetworkInterface	getNetworkInterface()	(experimental) Network interface for the Router Input.
List<RouterInputProtocol>	getProtocols()	(experimental) Array of exactly 2 protocol configurations for failover (must be same protocol type).
default SourcePriorityConfig	getSourcePriority()	(experimental) Source priority configuration for failover.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNetworkInterface

@Stability(Experimental)
@NotNull
IRouterNetworkInterface getNetworkInterface()

(experimental) Network interface for the Router Input.

getProtocols

@Stability(Experimental)
@NotNull
List<RouterInputProtocol> getProtocols()

(experimental) Array of exactly 2 protocol configurations for failover (must be same protocol type).

getAvailabilityZone

@Stability(Experimental)
@Nullable
default String getAvailabilityZone()

(experimental) The availability zone where the router input is located.

Default: - assigned by the MediaConnect service

getSourcePriority

@Stability(Experimental)
@Nullable
default SourcePriorityConfig getSourcePriority()

(experimental) Source priority configuration for failover.

Default: SourcePriorityConfig.none()

builder

@Stability(Experimental)
static FailoverConfigurationProps.Builder builder()

Returns:

a FailoverConfigurationProps.Builder of FailoverConfigurationProps