Class: AWSCDK::OpenSearchService::LoggingOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
open_search_service/logging_options.rb

Overview

Configures log settings for the domain.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_log_enabled: nil, app_log_group: nil, audit_log_enabled: nil, audit_log_group: nil, slow_index_log_enabled: nil, slow_index_log_group: nil, slow_search_log_enabled: nil, slow_search_log_group: nil) ⇒ LoggingOptions

Returns a new instance of LoggingOptions.

Parameters:

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

    Specify if Amazon OpenSearch Service application logging should be set up.

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

    Log Amazon OpenSearch Service application logs to this log group.

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

    Specify if Amazon OpenSearch Service audit logging should be set up.

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

    Log Amazon OpenSearch Service audit logs to this log group.

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

    Specify if slow index logging should be set up.

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

    Log slow indices to this log group.

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

    Specify if slow search logging should be set up.

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

    Log slow searches to this log group.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'open_search_service/logging_options.rb', line 15

def initialize(app_log_enabled: nil, app_log_group: nil, audit_log_enabled: nil, audit_log_group: nil, slow_index_log_enabled: nil, slow_index_log_group: nil, slow_search_log_enabled: nil, slow_search_log_group: nil)
  @app_log_enabled = app_log_enabled
  Jsii::Type.check_type(@app_log_enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "appLogEnabled") unless @app_log_enabled.nil?
  @app_log_group = app_log_group
  Jsii::Type.check_type(@app_log_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sb2dzLklMb2dHcm91cFJlZiJ9")), "appLogGroup") unless @app_log_group.nil?
  @audit_log_enabled = audit_log_enabled
  Jsii::Type.check_type(@audit_log_enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "auditLogEnabled") unless @audit_log_enabled.nil?
  @audit_log_group = audit_log_group
  Jsii::Type.check_type(@audit_log_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sb2dzLklMb2dHcm91cFJlZiJ9")), "auditLogGroup") unless @audit_log_group.nil?
  @slow_index_log_enabled = slow_index_log_enabled
  Jsii::Type.check_type(@slow_index_log_enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "slowIndexLogEnabled") unless @slow_index_log_enabled.nil?
  @slow_index_log_group = slow_index_log_group
  Jsii::Type.check_type(@slow_index_log_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sb2dzLklMb2dHcm91cFJlZiJ9")), "slowIndexLogGroup") unless @slow_index_log_group.nil?
  @slow_search_log_enabled = slow_search_log_enabled
  Jsii::Type.check_type(@slow_search_log_enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "slowSearchLogEnabled") unless @slow_search_log_enabled.nil?
  @slow_search_log_group = slow_search_log_group
  Jsii::Type.check_type(@slow_search_log_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sb2dzLklMb2dHcm91cFJlZiJ9")), "slowSearchLogGroup") unless @slow_search_log_group.nil?
end

Instance Attribute Details

#app_log_enabled ⇒ Boolean? (readonly)

Note:

Default: - false

Specify if Amazon OpenSearch Service application logging should be set up.

Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later. An explicit false is required when disabling it from true.

Returns:

  • (Boolean, nil) 


41
42
43
 
# File 'open_search_service/logging_options.rb', line 41

def app_log_enabled
  @app_log_enabled
end

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

Note:

Default: - a new log group is created if app logging is enabled

Log Amazon OpenSearch Service application logs to this log group.

Returns:



46
47
48
 
# File 'open_search_service/logging_options.rb', line 46

def app_log_group
  @app_log_group
end

#audit_log_enabled ⇒ Boolean? (readonly)

Note:

Default: - false

Specify if Amazon OpenSearch Service audit logging should be set up.

Requires Elasticsearch version 6.7 or later or OpenSearch version 1.0 or later and fine grained access control to be enabled.

Returns:

  • (Boolean, nil) 


53
54
55
 
# File 'open_search_service/logging_options.rb', line 53

def audit_log_enabled
  @audit_log_enabled
end

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

Note:

Default: - a new log group is created if audit logging is enabled

Log Amazon OpenSearch Service audit logs to this log group.

Returns:



58
59
60
 
# File 'open_search_service/logging_options.rb', line 58

def audit_log_group
  @audit_log_group
end

#slow_index_log_enabled ⇒ Boolean? (readonly)

Note:

Default: - false

Specify if slow index logging should be set up.

Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later. An explicit false is required when disabling it from true.

Returns:

  • (Boolean, nil) 


66
67
68
 
# File 'open_search_service/logging_options.rb', line 66

def slow_index_log_enabled
  @slow_index_log_enabled
end

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

Note:

Default: - a new log group is created if slow index logging is enabled

Log slow indices to this log group.

Returns:



71
72
73
 
# File 'open_search_service/logging_options.rb', line 71

def slow_index_log_group
  @slow_index_log_group
end

#slow_search_log_enabled ⇒ Boolean? (readonly)

Note:

Default: - false

Specify if slow search logging should be set up.

Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later. An explicit false is required when disabling it from true.

Returns:

  • (Boolean, nil) 


79
80
81
 
# File 'open_search_service/logging_options.rb', line 79

def slow_search_log_enabled
  @slow_search_log_enabled
end

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

Note:

Default: - a new log group is created if slow search logging is enabled

Log slow searches to this log group.

Returns:



84
85
86
 
# File 'open_search_service/logging_options.rb', line 84

def slow_search_log_group
  @slow_search_log_group
end

Class Method Details

.jsii_properties ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'open_search_service/logging_options.rb', line 86

def self.jsii_properties
  {
    :app_log_enabled => "appLogEnabled",
    :app_log_group => "appLogGroup",
    :audit_log_enabled => "auditLogEnabled",
    :audit_log_group => "auditLogGroup",
    :slow_index_log_enabled => "slowIndexLogEnabled",
    :slow_index_log_group => "slowIndexLogGroup",
    :slow_search_log_enabled => "slowSearchLogEnabled",
    :slow_search_log_group => "slowSearchLogGroup",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'open_search_service/logging_options.rb', line 99

def to_jsii
  result = {}
  result.merge!({
    "appLogEnabled" => @app_log_enabled,
    "appLogGroup" => @app_log_group,
    "auditLogEnabled" => @audit_log_enabled,
    "auditLogGroup" => @audit_log_group,
    "slowIndexLogEnabled" => @slow_index_log_enabled,
    "slowIndexLogGroup" => @slow_index_log_group,
    "slowSearchLogEnabled" => @slow_search_log_enabled,
    "slowSearchLogGroup" => @slow_search_log_group,
  })
  result.compact
end