Interface CfnChannel.AutomaticInputFailoverSettingsProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnChannel.AutomaticInputFailoverSettingsProperty extends
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.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 AutomaticInputFailoverSettingsProperty automaticInputFailoverSettingsProperty = AutomaticInputFailoverSettingsProperty.builder()
  • 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.

    • 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.

    • getInputPreference

      @Stability(Stable) @Nullable default String getInputPreference()
      Input preference when deciding which input to make active when a previously failed input has recovered.
    • getSecondaryInputId

      @Stability(Stable) @Nullable default String getSecondaryInputId()
      The input ID of the secondary input in the automatic input failover pair.
    • builder

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