Class: AWSCDK::StepFunctions::LogOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
step_functions/log_options.rb

Overview

Defines what execution history events are logged and where they are logged.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(destination: nil, include_execution_data: nil, level: nil) ⇒ LogOptions

Returns a new instance of LogOptions.

Parameters:

  • destination (AWSCDK::Interfaces::AWSLogs::ILogGroupRef, nil) (defaults to: nil) —

    The log group where the execution history events will be logged.

  • include_execution_data (Boolean, nil) (defaults to: nil) —

    Determines whether execution data is included in your log.

  • level (AWSCDK::StepFunctions::LogLevel, nil) (defaults to: nil) —

    Defines which category of execution history events are logged.



10
11
12
13
14
15
16
17
 
# File 'step_functions/log_options.rb', line 10

def initialize(destination: nil, include_execution_data: nil, level: nil)
  @destination = destination
  Jsii::Type.check_type(@destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sb2dzLklMb2dHcm91cFJlZiJ9")), "destination") unless @destination.nil?
  @include_execution_data = include_execution_data
  Jsii::Type.check_type(@include_execution_data, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "includeExecutionData") unless @include_execution_data.nil?
  @level = level
  Jsii::Type.check_type(@level, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Mb2dMZXZlbCJ9")), "level") unless @level.nil?
end

Instance Attribute Details

#destination ⇒ AWSCDK::Interfaces::AWSLogs::ILogGroupRef? (readonly)

Note:

Default: No log group. Required if your log level is not set to OFF.

The log group where the execution history events will be logged.

Returns:



23
24
25
 
# File 'step_functions/log_options.rb', line 23

def destination
  @destination
end

#include_execution_data ⇒ Boolean? (readonly)

Note:

Default: false

Determines whether execution data is included in your log.

Returns:

  • (Boolean, nil) 


28
29
30
 
# File 'step_functions/log_options.rb', line 28

def include_execution_data
  @include_execution_data
end

#level ⇒ AWSCDK::StepFunctions::LogLevel? (readonly)

Note:

Default: ERROR

Defines which category of execution history events are logged.

Returns:



33
34
35
 
# File 'step_functions/log_options.rb', line 33

def level
  @level
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
41
 
# File 'step_functions/log_options.rb', line 35

def self.jsii_properties
  {
    :destination => "destination",
    :include_execution_data => "includeExecutionData",
    :level => "level",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'step_functions/log_options.rb', line 43

def to_jsii
  result = {}
  result.merge!({
    "destination" => @destination,
    "includeExecutionData" => @include_execution_data,
    "level" => @level,
  })
  result.compact
end