AWS::MediaConnect::Flow FailoverConfig

The settings for source failover.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "FailoverMode" : String,
  "RecoveryWindow" : Integer,
  "SourcePriority" : SourcePriority,
  "State" : String
}

YAML

  FailoverMode: String
  RecoveryWindow: Integer
  SourcePriority: 
    SourcePriority
  State: String

Properties

FailoverMode

The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. The string for this property must be entered as MERGE or FAILOVER. No other string entry is valid.

Required: No

Type: String

Allowed values: MERGE | FAILOVER

Update requires: No interruption

RecoveryWindow

The size of the buffer (delay) that the service maintains. A larger buffer means a longer delay in transmitting the stream, but more room for error correction. A smaller buffer means a shorter delay, but less room for error correction. You can choose a value from 100-500 ms. If you keep this field blank, the service uses the default value of 200 ms. This setting only applies when Failover Mode is set to MERGE.

Required: No

Type: Integer

Update requires: No interruption

SourcePriority

The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.

Required: No

Type: SourcePriority

Update requires: No interruption

State

The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption