AWS CDK Reference

Appearance

v2.275.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 ​

appLogEnabledoptionalbooleanapp_log_enabledoptionalboolappLogEnabledoptionalBooleanAppLogEnabledoptionalboolAppLogEnabledoptional*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.

appLogGroupoptionalILogGroupRefapp_log_groupoptionalILogGroupRefappLogGroupoptionalILogGroupRefAppLogGroupoptionalILogGroupRefAppLogGroupoptionalILogGroupRef#
Log Amazon OpenSearch Service application logs to this log group.

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

auditLogEnabledoptionalbooleanaudit_log_enabledoptionalboolauditLogEnabledoptionalBooleanAuditLogEnabledoptionalboolAuditLogEnabledoptional*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.

auditLogGroupoptionalILogGroupRefaudit_log_groupoptionalILogGroupRefauditLogGroupoptionalILogGroupRefAuditLogGroupoptionalILogGroupRefAuditLogGroupoptionalILogGroupRef#
Log Amazon OpenSearch Service audit logs to this log group.

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

slowIndexLogEnabledoptionalbooleanslow_index_log_enabledoptionalboolslowIndexLogEnabledoptionalBooleanSlowIndexLogEnabledoptionalboolSlowIndexLogEnabledoptional*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.

slowIndexLogGroupoptionalILogGroupRefslow_index_log_groupoptionalILogGroupRefslowIndexLogGroupoptionalILogGroupRefSlowIndexLogGroupoptionalILogGroupRefSlowIndexLogGroupoptionalILogGroupRef#
Log slow indices to this log group.

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

slowSearchLogEnabledoptionalbooleanslow_search_log_enabledoptionalboolslowSearchLogEnabledoptionalBooleanSlowSearchLogEnabledoptionalboolSlowSearchLogEnabledoptional*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.

slowSearchLogGroupoptionalILogGroupRefslow_search_log_groupoptionalILogGroupRefslowSearchLogGroupoptionalILogGroupRefSlowSearchLogGroupoptionalILogGroupRefSlowSearchLogGroupoptionalILogGroupRef#
Log slow searches to this log group.

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