software.amazon.awscdk.services.opensearchservice

Interface LoggingOptions

All Known Implementing Classes:

LoggingOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.859Z")
public interface LoggingOptions

Configures log settings for the domain.

Example:

 Domain prodDomain = Domain.Builder.create(this, "Domain")
         .version(EngineVersion.OPENSEARCH_1_0)
         .capacity(CapacityConfig.builder()
                 .masterNodes(5)
                 .dataNodes(20)
                 .build())
         .ebs(EbsOptions.builder()
                 .volumeSize(20)
                 .build())
         .zoneAwareness(ZoneAwarenessConfig.builder()
                 .availabilityZoneCount(3)
                 .build())
         .logging(LoggingOptions.builder()
                 .slowSearchLogEnabled(true)
                 .appLogEnabled(true)
                 .slowIndexLogEnabled(true)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static LoggingOptions.Builder	builder()
default java.lang.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 java.lang.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 java.lang.Boolean	getSlowIndexLogEnabled() Specify if slow index logging should be set up.
default ILogGroup	getSlowIndexLogGroup() Log slow indices to this log group.
default java.lang.Boolean	getSlowSearchLogEnabled() Specify if slow search logging should be set up.
default ILogGroup	getSlowSearchLogGroup() Log slow searches to this log group.

Method Detail

getAppLogEnabled

default java.lang.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.

Default: - false

getAppLogGroup

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

default java.lang.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

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

default java.lang.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.

Default: - false

getSlowIndexLogGroup

default ILogGroup getSlowIndexLogGroup()

Log slow indices to this log group.

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

getSlowSearchLogEnabled

default java.lang.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.

Default: - false

getSlowSearchLogGroup

default ILogGroup getSlowSearchLogGroup()

Log slow searches to this log group.

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

builder

static LoggingOptions.Builder builder()

Returns:

a LoggingOptions.Builder of LoggingOptions