aws-cdk-lib.aws_mediaconnect.CfnFlow.FailoverConfigProperty

interface FailoverConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.MediaConnect.CfnFlow.FailoverConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsmediaconnect#CfnFlow_FailoverConfigProperty
Javasoftware.amazon.awscdk.services.mediaconnect.CfnFlow.FailoverConfigProperty
Pythonaws_cdk.aws_mediaconnect.CfnFlow.FailoverConfigProperty
TypeScript aws-cdk-lib » aws_mediaconnect » CfnFlow » FailoverConfigProperty

The settings for source failover.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediaconnect as mediaconnect } from 'aws-cdk-lib';
const failoverConfigProperty: mediaconnect.CfnFlow.FailoverConfigProperty = {
  failoverMode: 'failoverMode',
  recoveryWindow: 123,
  sourcePriority: {
    primarySource: 'primarySource',
  },
  state: 'state',
};

Properties

NameTypeDescription
failoverMode?stringThe type of failover you choose for this flow.
recoveryWindow?numberThe size of the buffer (delay) that the service maintains.
sourcePriority?IResolvable | SourcePriorityPropertyThe priority you want to assign to a source.
state?stringThe state of source failover on the flow.

failoverMode?

Type: string (optional)

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.


recoveryWindow?

Type: number (optional)

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.


sourcePriority?

Type: IResolvable | SourcePriorityProperty (optional)

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.


state?

Type: string (optional)

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.