Class: AWSCDK::MediaLive::CfnChannel::AutomaticInputFailoverSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error_clear_time_msec: nil, failover_conditions: nil, input_preference: nil, secondary_input_id: nil) ⇒ AutomaticInputFailoverSettingsProperty

Returns a new instance of AutomaticInputFailoverSettingsProperty.

Parameters:

  • error_clear_time_msec (Numeric, nil) (defaults to: nil) —

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

  • failover_conditions (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::FailoverConditionProperty>, nil) (defaults to: nil) —

    A list of failover conditions.

  • input_preference (String, nil) (defaults to: nil) —

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

  • secondary_input_id (String, nil) (defaults to: nil) —

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



2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
 
# File 'media_live/cfn_channel.rb', line 2429

def initialize(error_clear_time_msec: nil, failover_conditions: nil, input_preference: nil, secondary_input_id: nil)
  @error_clear_time_msec = error_clear_time_msec
  Jsii::Type.check_type(@error_clear_time_msec, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "errorClearTimeMsec") unless @error_clear_time_msec.nil?
  @failover_conditions = failover_conditions
  Jsii::Type.check_type(@failover_conditions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFsaXZlLkNmbkNoYW5uZWwuRmFpbG92ZXJDb25kaXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "failoverConditions") unless @failover_conditions.nil?
  @input_preference = input_preference
  Jsii::Type.check_type(@input_preference, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputPreference") unless @input_preference.nil?
  @secondary_input_id = secondary_input_id
  Jsii::Type.check_type(@secondary_input_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secondaryInputId") unless @secondary_input_id.nil?
end

Instance Attribute Details

#error_clear_time_msec ⇒ Numeric? (readonly)

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.

Returns:

  • (Numeric, nil)

See Also:



2446
2447
2448
 
# File 'media_live/cfn_channel.rb', line 2446

def error_clear_time_msec
  @error_clear_time_msec
end

#failover_conditions ⇒ AWSCDK::IResolvable, ... (readonly)

A list of failover conditions.

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

Returns:

See Also:



2453
2454
2455
 
# File 'media_live/cfn_channel.rb', line 2453

def failover_conditions
  @failover_conditions
end

#input_preference ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2458
2459
2460
 
# File 'media_live/cfn_channel.rb', line 2458

def input_preference
  @input_preference
end

#secondary_input_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2463
2464
2465
 
# File 'media_live/cfn_channel.rb', line 2463

def secondary_input_id
  @secondary_input_id
end

Class Method Details

.jsii_properties ⇒ Object 



2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'media_live/cfn_channel.rb', line 2465

def self.jsii_properties
  {
    :error_clear_time_msec => "errorClearTimeMsec",
    :failover_conditions => "failoverConditions",
    :input_preference => "inputPreference",
    :secondary_input_id => "secondaryInputId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
 
# File 'media_live/cfn_channel.rb', line 2474

def to_jsii
  result = {}
  result.merge!({
    "errorClearTimeMsec" => @error_clear_time_msec,
    "failoverConditions" => @failover_conditions,
    "inputPreference" => @input_preference,
    "secondaryInputId" => @secondary_input_id,
  })
  result.compact
end