Class: AWSCDK::CloudFront::RealtimeLogConfigProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_front/realtime_log_config_props.rb

Overview

Properties for defining a RealtimeLogConfig resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(end_points:, fields:, sampling_rate:, realtime_log_config_name: nil) ⇒ RealtimeLogConfigProps

Returns a new instance of RealtimeLogConfigProps.

Parameters:

  • end_points (Array<AWSCDK::CloudFront::Endpoint>) —

    Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

  • fields (Array<String>) —

    A list of fields that are included in each real-time log record.

  • sampling_rate (Numeric) —

    The sampling rate for this real-time log configuration.

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

    The unique name of this real-time log configuration.



11
12
13
14
15
16
17
18
19
20
 
# File 'cloud_front/realtime_log_config_props.rb', line 11

def initialize(end_points:, fields:, sampling_rate:, realtime_log_config_name: nil)
  @end_points = end_points
  Jsii::Type.check_type(@end_points, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZGZyb250LkVuZHBvaW50In0sImtpbmQiOiJhcnJheSJ9fQ==")), "endPoints")
  @fields = fields
  Jsii::Type.check_type(@fields, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "fields")
  @sampling_rate = sampling_rate
  Jsii::Type.check_type(@sampling_rate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "samplingRate")
  @realtime_log_config_name = realtime_log_config_name
  Jsii::Type.check_type(@realtime_log_config_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "realtimeLogConfigName") unless @realtime_log_config_name.nil?
end

Instance Attribute Details

#end_points ⇒ Array<AWSCDK::CloudFront::Endpoint> (readonly)

Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

Returns:



25
26
27
 
# File 'cloud_front/realtime_log_config_props.rb', line 25

def end_points
  @end_points
end

#fields ⇒ Array<String> (readonly)

A list of fields that are included in each real-time log record.

Returns:

  • (Array<String>)

See Also:



30
31
32
 
# File 'cloud_front/realtime_log_config_props.rb', line 30

def fields
  @fields
end

#realtime_log_config_name ⇒ String? (readonly)

Note:

Default: - the unique construct ID

The unique name of this real-time log configuration.

Returns:

  • (String, nil) 


39
40
41
 
# File 'cloud_front/realtime_log_config_props.rb', line 39

def realtime_log_config_name
  @realtime_log_config_name
end

#sampling_rate ⇒ Numeric (readonly)

The sampling rate for this real-time log configuration.

Returns:

  • (Numeric) 


34
35
36
 
# File 'cloud_front/realtime_log_config_props.rb', line 34

def sampling_rate
  @sampling_rate
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'cloud_front/realtime_log_config_props.rb', line 41

def self.jsii_properties
  {
    :end_points => "endPoints",
    :fields => "fields",
    :sampling_rate => "samplingRate",
    :realtime_log_config_name => "realtimeLogConfigName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



50
51
52
53
54
55
56
57
58
59
 
# File 'cloud_front/realtime_log_config_props.rb', line 50

def to_jsii
  result = {}
  result.merge!({
    "endPoints" => @end_points,
    "fields" => @fields,
    "samplingRate" => @sampling_rate,
    "realtimeLogConfigName" => @realtime_log_config_name,
  })
  result.compact
end