Interface CfnFlow.IFailoverConfigProperty
The settings for source failover.
Namespace: Amazon.CDK.AWS.MediaConnect
Assembly: Amazon.CDK.AWS.MediaConnect.dll
Syntax (csharp)
public interface IFailoverConfigProperty
Syntax (vb)
Public Interface IFailoverConfigProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaConnect;
var failoverConfigProperty = new FailoverConfigProperty {
FailoverMode = "failoverMode",
RecoveryWindow = 123,
SourcePriority = new SourcePriorityProperty {
PrimarySource = "primarySource"
},
State = "state"
};
Synopsis
Properties
FailoverMode | The type of failover you choose for this flow. |
RecoveryWindow | The size of the buffer (delay) that the service maintains. |
SourcePriority | The priority you want to assign to a source. |
State | The state of source failover on the flow. |
Properties
FailoverMode
The type of failover you choose for this flow.
virtual string FailoverMode { get; }
Property Value
System.String
Remarks
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.
RecoveryWindow
The size of the buffer (delay) that the service maintains.
virtual Nullable<double> RecoveryWindow { get; }
Property Value
System.Nullable<System.Double>
Remarks
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.
SourcePriority
The priority you want to assign to a source.
virtual object SourcePriority { get; }
Property Value
System.Object
Remarks
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.
State
The state of source failover on the flow.
virtual string State { get; }
Property Value
System.String
Remarks
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.