AWS CDK Reference

Appearance

v2.274.0

LoggingOptions Struct ​

Configures log settings for the domain.

Source
aws-opensearchservice/lib/domain.ts
Type last changed
v2.235.0 · 15 Jan 2026

Example ​

ts
const domain = new Domain(this, 'Domain', {
  version: EngineVersion.OPENSEARCH_1_0,
  enforceHttps: true,
  nodeToNodeEncryption: true,
  encryptionAtRest: {
    enabled: true,
  },
  fineGrainedAccessControl: {
    masterUserName: 'master-user',
  },
  logging: {
    auditLogEnabled: true,
    slowSearchLogEnabled: true,
    appLogEnabled: true,
    slowIndexLogEnabled: true,
  },
});

Properties ​

appLogEnabledbooleanapp_log_enabledboolappLogEnabledBooleanAppLogEnabledboolAppLogEnabled*bool= 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.

appLogGroupILogGroupRefapp_log_groupILogGroupRefappLogGroupILogGroupRefAppLogGroupILogGroupRefAppLogGroupILogGroupRef= a new log group is created if ap…#
Log Amazon OpenSearch Service application logs to this log group.
default

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

auditLogEnabledbooleanaudit_log_enabledboolauditLogEnabledBooleanAuditLogEnabledboolAuditLogEnabled*bool= 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.

auditLogGroupILogGroupRefaudit_log_groupILogGroupRefauditLogGroupILogGroupRefAuditLogGroupILogGroupRefAuditLogGroupILogGroupRef= a new log group is created if au…#
Log Amazon OpenSearch Service audit logs to this log group.
default

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

slowIndexLogEnabledbooleanslow_index_log_enabledboolslowIndexLogEnabledBooleanSlowIndexLogEnabledboolSlowIndexLogEnabled*bool= 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.

slowIndexLogGroupILogGroupRefslow_index_log_groupILogGroupRefslowIndexLogGroupILogGroupRefSlowIndexLogGroupILogGroupRefSlowIndexLogGroupILogGroupRef= a new log group is created if sl…#
Log slow indices to this log group.
default

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

slowSearchLogEnabledbooleanslow_search_log_enabledboolslowSearchLogEnabledBooleanSlowSearchLogEnabledboolSlowSearchLogEnabled*bool= 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.

slowSearchLogGroupILogGroupRefslow_search_log_groupILogGroupRefslowSearchLogGroupILogGroupRefSlowSearchLogGroupILogGroupRefSlowSearchLogGroupILogGroupRef= a new log group is created if sl…#
Log slow searches to this log group.
default

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