Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlow.FailoverConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.FailoverConfigProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.FailoverConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.mediaconnect.*;
 FailoverConfigProperty failoverConfigProperty = FailoverConfigProperty.builder()
         .failoverMode("failoverMode")
         .recoveryWindow(123)
         .sourcePriority(SourcePriorityProperty.builder()
                 .primarySource("primarySource")
                 .build())
         .state("state")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlow.FailoverConfigProperty.Builder	builder()
default String	getFailoverMode()	The type of failover you choose for this flow.
default Number	getRecoveryWindow()	The size of the buffer (delay) that the service maintains.
default Object	getSourcePriority()	The priority you want to assign to a source.
default String	getState()	The state of source failover on the flow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFailoverMode

@Stability(Stable)
@Nullable
default String getFailoverMode()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-failovermode

getRecoveryWindow

@Stability(Stable)
@Nullable
default Number getRecoveryWindow()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-recoverywindow

getSourcePriority

@Stability(Stable)
@Nullable
default Object getSourcePriority()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-sourcepriority

getState

@Stability(Stable)
@Nullable
default String getState()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-state

builder

@Stability(Stable)
static CfnFlow.FailoverConfigProperty.Builder builder()

Returns:

a CfnFlow.FailoverConfigProperty.Builder of CfnFlow.FailoverConfigProperty