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

Interface FailoverFailoverOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FailoverFailoverOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-31T10:49:55.142Z")
@Stability(Experimental)
public interface FailoverFailoverOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for switchover-mode source failover.

Example:

 // 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.*;
 FailoverFailoverOptions failoverFailoverOptions = FailoverFailoverOptions.builder()
         .primarySource("primarySource")
         .state(State.ENABLED)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FailoverFailoverOptions.Builder	builder()
default String	getPrimarySource()	(experimental) The name of the source you want to treat as primary.
default State	getState()	(experimental) Whether failover is enabled.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPrimarySource

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

(experimental) The name of the source you want to treat as primary.

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

Default: - both sources are equal priority

getState

@Stability(Experimental)
@Nullable
default State getState()

(experimental) Whether failover is enabled.

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

Default: State.ENABLED

builder

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

Returns:

a FailoverFailoverOptions.Builder of FailoverFailoverOptions