Class: AWSCDK::MediaConnect::CfnFlow::FailoverConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_connect/cfn_flow.rb

Overview

The settings for source failover.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(failover_mode: nil, recovery_window: nil, source_priority: nil, state: nil) ⇒ FailoverConfigProperty

Returns a new instance of FailoverConfigProperty.

Parameters:

  • failover_mode (String, nil) (defaults to: nil)

    The type of failover you choose for this flow.

  • recovery_window (Numeric, nil) (defaults to: nil)

    Search window time to look for dash-7 packets.

  • source_priority (AWSCDK::IResolvable, AWSCDK::MediaConnect::CfnFlow::SourcePriorityProperty, nil) (defaults to: nil)

    The priority you want to assign to a source.

  • state (String, nil) (defaults to: nil)

    The state of source failover on the flow.



974
975
976
977
978
979
980
981
982
983
# File 'media_connect/cfn_flow.rb', line 974

def initialize(failover_mode: nil, recovery_window: nil, source_priority: nil, state: nil)
  @failover_mode = failover_mode
  Jsii::Type.check_type(@failover_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "failoverMode") unless @failover_mode.nil?
  @recovery_window = recovery_window
  Jsii::Type.check_type(@recovery_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "recoveryWindow") unless @recovery_window.nil?
  @source_priority = source_priority.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlow::SourcePriorityProperty.new(**source_priority.transform_keys(&:to_sym)) : source_priority
  Jsii::Type.check_type(@source_priority, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvdy5Tb3VyY2VQcmlvcml0eVByb3BlcnR5In1dfX0=")), "sourcePriority") unless @source_priority.nil?
  @state = state
  Jsii::Type.check_type(@state, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "state") unless @state.nil?
end

Instance Attribute Details

#failover_modeString? (readonly)

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.



991
992
993
# File 'media_connect/cfn_flow.rb', line 991

def failover_mode
  @failover_mode
end

#recovery_windowNumeric? (readonly)

Search window time to look for dash-7 packets.



996
997
998
# File 'media_connect/cfn_flow.rb', line 996

def recovery_window
  @recovery_window
end

#source_priorityAWSCDK::IResolvable, ... (readonly)

The priority you want to assign to a source.

You can have a primary stream and a backup stream or two equally prioritized streams.



1003
1004
1005
# File 'media_connect/cfn_flow.rb', line 1003

def source_priority
  @source_priority
end

#stateString? (readonly)

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.



1010
1011
1012
# File 'media_connect/cfn_flow.rb', line 1010

def state
  @state
end

Class Method Details

.jsii_propertiesObject



1012
1013
1014
1015
1016
1017
1018
1019
# File 'media_connect/cfn_flow.rb', line 1012

def self.jsii_properties
  {
    :failover_mode => "failoverMode",
    :recovery_window => "recoveryWindow",
    :source_priority => "sourcePriority",
    :state => "state",
  }
end

Instance Method Details

#to_jsiiObject



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
# File 'media_connect/cfn_flow.rb', line 1021

def to_jsii
  result = {}
  result.merge!({
    "failoverMode" => @failover_mode,
    "recoveryWindow" => @recovery_window,
    "sourcePriority" => @source_priority,
    "state" => @state,
  })
  result.compact
end