Class: AWSCDK::MediaTailor::CfnPlaybackConfiguration::AdsInteractionLogProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::MediaTailor::CfnPlaybackConfiguration::AdsInteractionLogProperty

Defined in:

media_tailor/cfn_playback_configuration.rb

Overview

Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).

For more information about ADS logs, inlcuding descriptions of the event types, see MediaTailor ADS logs description and event types in AWS Elemental MediaTailor User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html

Instance Attribute Summary

• #exclude_event_types ⇒ Array<String>^? readonly

  Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration.

• #publish_opt_in_event_types ⇒ Array<String>^? readonly

  Indicates that MediaTailor emits RAW_ADS_RESPONSE logs for playback sessions that are initialized with this configuration.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(exclude_event_types: nil, publish_opt_in_event_types: nil) ⇒ AdsInteractionLogProperty constructor

  A new instance of AdsInteractionLogProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(exclude_event_types: nil, publish_opt_in_event_types: nil) ⇒ AdsInteractionLogProperty

Returns a new instance of AdsInteractionLogProperty.

Parameters:

• exclude_event_types (Array<String>, nil) (defaults to: nil) —

  Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration.

• publish_opt_in_event_types (Array<String>, nil) (defaults to: nil) —

  Indicates that MediaTailor emits RAW_ADS_RESPONSE logs for playback sessions that are initialized with this configuration.

# File 'media_tailor/cfn_playback_configuration.rb', line 918

def initialize(exclude_event_types: nil, publish_opt_in_event_types: nil)
  @exclude_event_types = exclude_event_types
  Jsii::Type.check_type(@exclude_event_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "excludeEventTypes") unless @exclude_event_types.nil?
  @publish_opt_in_event_types = publish_opt_in_event_types
  Jsii::Type.check_type(@publish_opt_in_event_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "publishOptInEventTypes") unless @publish_opt_in_event_types.nil?
end

Instance Attribute Details

#exclude_event_types ⇒ Array<String>^? (readonly)

Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html#cfn-mediatailor-playbackconfiguration-adsinteractionlog-excludeeventtypes

# File 'media_tailor/cfn_playback_configuration.rb', line 929

def exclude_event_types
  @exclude_event_types
end

#publish_opt_in_event_types ⇒ Array<String>^? (readonly)

Indicates that MediaTailor emits RAW_ADS_RESPONSE logs for playback sessions that are initialized with this configuration.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html#cfn-mediatailor-playbackconfiguration-adsinteractionlog-publishoptineventtypes

# File 'media_tailor/cfn_playback_configuration.rb', line 934

def publish_opt_in_event_types
  @publish_opt_in_event_types
end

Class Method Details

.jsii_properties ⇒ Object

# File 'media_tailor/cfn_playback_configuration.rb', line 936

def self.jsii_properties
  {
    :exclude_event_types => "excludeEventTypes",
    :publish_opt_in_event_types => "publishOptInEventTypes",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'media_tailor/cfn_playback_configuration.rb', line 943

def to_jsii
  result = {}
  result.merge!({
    "excludeEventTypes" => @exclude_event_types,
    "publishOptInEventTypes" => @publish_opt_in_event_types,
  })
  result.compact
end