FailoverConfig

class aws_cdk.aws_mediaconnect_alpha.FailoverConfig(*args: Any, **kwargs)

Bases: object

(experimental) 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.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# 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

failover_config = mediaconnect_alpha.FailoverConfig.failover(
    primary_source="primarySource",
    state=mediaconnect_alpha.State.ENABLED
)

Static Methods

classmethod failover(*, primary_source=None, state=None)

(experimental) Configure switchover-mode failover.

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

Parameters:

primary_source (Optional[str]) – (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
state (Optional[State]) – (experimental) Whether failover is enabled. Set to State.DISABLED to keep the configuration on the flow without switching failover on. Default: State.ENABLED

Stability:

experimental

Return type:

FailoverConfig

classmethod merge(*, recovery_window=None, state=None)

(experimental) Configure merge-mode failover.

Requires two binary-identical sources.

Parameters:

recovery_window (Optional[Duration]) – (experimental) Search window time to look for SMPTE 2022-7 packets. A larger recovery window means a longer delay in transmitting the stream, but more room for error correction. A smaller window means a shorter delay but less room for correction. Valid range: 100–15000 ms. Default: - 200 ms
state (Optional[State]) – (experimental) Whether failover is enabled. Set to State.DISABLED to keep the configuration on the flow without switching failover on. Default: State.ENABLED

Stability:

experimental

Return type:

FailoverConfig