Package software.amazon.awscdk.services.opensearchservice

Interface LoggingOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LoggingOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:42.889Z")
@Stability(Stable)
public interface LoggingOptions
extends software.amazon.jsii.JsiiSerializable

Configures log settings for the domain.

Example:

 Domain domain = Domain.Builder.create(this, "Domain")
         .version(EngineVersion.OPENSEARCH_1_0)
         .enforceHttps(true)
         .nodeToNodeEncryption(true)
         .encryptionAtRest(EncryptionAtRestOptions.builder()
                 .enabled(true)
                 .build())
         .fineGrainedAccessControl(AdvancedSecurityOptions.builder()
                 .masterUserName("master-user")
                 .build())
         .logging(LoggingOptions.builder()
                 .auditLogEnabled(true)
                 .slowSearchLogEnabled(true)
                 .appLogEnabled(true)
                 .slowIndexLogEnabled(true)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LoggingOptions.Builder	A builder for LoggingOptions
static final class	LoggingOptions.Jsii$Proxy	An implementation for LoggingOptions

Method Summary

Modifier and Type	Method	Description
static LoggingOptions.Builder	builder()
default Boolean	getAppLogEnabled()	Specify if Amazon OpenSearch Service application logging should be set up.
default ILogGroup	getAppLogGroup()	Log Amazon OpenSearch Service application logs to this log group.
default Boolean	getAuditLogEnabled()	Specify if Amazon OpenSearch Service audit logging should be set up.
default ILogGroup	getAuditLogGroup()	Log Amazon OpenSearch Service audit logs to this log group.
default Boolean	getSlowIndexLogEnabled()	Specify if slow index logging should be set up.
default ILogGroup	getSlowIndexLogGroup()	Log slow indices to this log group.
default Boolean	getSlowSearchLogEnabled()	Specify if slow search logging should be set up.
default ILogGroup	getSlowSearchLogGroup()	Log slow searches to this log group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppLogEnabled

@Stability(Stable)
@Nullable
default Boolean getAppLogEnabled()

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.

Default: - false

getAppLogGroup

@Stability(Stable)
@Nullable
default ILogGroup getAppLogGroup()

Log Amazon OpenSearch Service application logs to this log group.

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

getAuditLogEnabled

@Stability(Stable)
@Nullable
default Boolean getAuditLogEnabled()

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.

Default: - false

getAuditLogGroup

@Stability(Stable)
@Nullable
default ILogGroup getAuditLogGroup()

Log Amazon OpenSearch Service audit logs to this log group.

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

getSlowIndexLogEnabled

@Stability(Stable)
@Nullable
default Boolean getSlowIndexLogEnabled()

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.

Default: - false

getSlowIndexLogGroup

@Stability(Stable)
@Nullable
default ILogGroup getSlowIndexLogGroup()

Log slow indices to this log group.

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

getSlowSearchLogEnabled

@Stability(Stable)
@Nullable
default Boolean getSlowSearchLogEnabled()

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.

Default: - false

getSlowSearchLogGroup

@Stability(Stable)
@Nullable
default ILogGroup getSlowSearchLogGroup()

Log slow searches to this log group.

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

builder

@Stability(Stable)
static LoggingOptions.Builder builder()

Returns:

a LoggingOptions.Builder of LoggingOptions