Package software.amazon.awscdk.services.medialive

Interface CfnChannel.AutomaticInputFailoverSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.AutomaticInputFailoverSettingsProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.AutomaticInputFailoverSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Settings to configure the conditions that will define the input as unhealthy and that will make MediaLive fail over to the other input in the input failover pair.

The parent of this entity is InputAttachment.

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.medialive.*;
 AutomaticInputFailoverSettingsProperty automaticInputFailoverSettingsProperty = AutomaticInputFailoverSettingsProperty.builder()
         .errorClearTimeMsec(123)
         .failoverConditions(List.of(FailoverConditionProperty.builder()
                 .failoverConditionSettings(FailoverConditionSettingsProperty.builder()
                         .audioSilenceSettings(AudioSilenceFailoverSettingsProperty.builder()
                                 .audioSelectorName("audioSelectorName")
                                 .audioSilenceThresholdMsec(123)
                                 .build())
                         .inputLossSettings(InputLossFailoverSettingsProperty.builder()
                                 .inputLossThresholdMsec(123)
                                 .build())
                         .videoBlackSettings(VideoBlackFailoverSettingsProperty.builder()
                                 .blackDetectThreshold(123)
                                 .videoBlackThresholdMsec(123)
                                 .build())
                         .build())
                 .build()))
         .inputPreference("inputPreference")
         .secondaryInputId("secondaryInputId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannel.AutomaticInputFailoverSettingsProperty.Builder	builder()
default Number	getErrorClearTimeMsec()	This clear time defines the requirement a recovered input must meet to be considered healthy.
default Object	getFailoverConditions()	A list of failover conditions.
default String	getInputPreference()	Input preference when deciding which input to make active when a previously failed input has recovered.
default String	getSecondaryInputId()	The input ID of the secondary input in the automatic input failover pair.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getErrorClearTimeMsec

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

This clear time defines the requirement a recovered input must meet to be considered healthy.

The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html#cfn-medialive-channel-automaticinputfailoversettings-errorcleartimemsec

getFailoverConditions

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

A list of failover conditions.

If any of these conditions occur, MediaLive will perform a failover to the other input.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnChannel.FailoverConditionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html#cfn-medialive-channel-automaticinputfailoversettings-failoverconditions

getInputPreference

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

Input preference when deciding which input to make active when a previously failed input has recovered.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html#cfn-medialive-channel-automaticinputfailoversettings-inputpreference

getSecondaryInputId

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

The input ID of the secondary input in the automatic input failover pair.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html#cfn-medialive-channel-automaticinputfailoversettings-secondaryinputid

builder

@Stability(Stable)
static CfnChannel.AutomaticInputFailoverSettingsProperty.Builder builder()

Returns:

a CfnChannel.AutomaticInputFailoverSettingsProperty.Builder of CfnChannel.AutomaticInputFailoverSettingsProperty