aws-cdk-lib.aws_elasticsearch.LoggingOptions

interface LoggingOptions ⚠️

LanguageType name
.NETAmazon.CDK.AWS.Elasticsearch.LoggingOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticsearch#LoggingOptions
Javasoftware.amazon.awscdk.services.elasticsearch.LoggingOptions
Pythonaws_cdk.aws_elasticsearch.LoggingOptions
TypeScript (source)aws-cdk-lib » aws_elasticsearch » LoggingOptions

⚠️ Deprecated: use opensearchservice module instead

Configures log settings for the domain.

Example

const prodDomain = new es.Domain(this, 'Domain', {
  version: es.ElasticsearchVersion.V7_1,
  capacity: {
    masterNodes: 5,
    dataNodes: 20,
  },
  ebs: {
    volumeSize: 20,
  },
  zoneAwareness: {
    availabilityZoneCount: 3,
  },
  logging: {
    slowSearchLogEnabled: true,
    appLogEnabled: true,
    slowIndexLogEnabled: true,
  },
});

Properties

NameTypeDescription
appLogEnabled?⚠️booleanSpecify if Elasticsearch application logging should be set up.
appLogGroup?⚠️ILogGroupLog Elasticsearch application logs to this log group.
auditLogEnabled?⚠️booleanSpecify if Elasticsearch audit logging should be set up.
auditLogGroup?⚠️ILogGroupLog Elasticsearch audit logs to this log group.
slowIndexLogEnabled?⚠️booleanSpecify if slow index logging should be set up.
slowIndexLogGroup?⚠️ILogGroupLog slow indices to this log group.
slowSearchLogEnabled?⚠️booleanSpecify if slow search logging should be set up.
slowSearchLogGroup?⚠️ILogGroupLog slow searches to this log group.

appLogEnabled?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: boolean (optional, default: false)

Specify if Elasticsearch application logging should be set up.

Requires Elasticsearch version 5.1 or later.


appLogGroup?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: ILogGroup (optional, default: a new log group is created if app logging is enabled)

Log Elasticsearch application logs to this log group.


auditLogEnabled?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: boolean (optional, default: false)

Specify if Elasticsearch audit logging should be set up.

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


auditLogGroup?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: ILogGroup (optional, default: a new log group is created if audit logging is enabled)

Log Elasticsearch audit logs to this log group.


slowIndexLogEnabled?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: boolean (optional, default: false)

Specify if slow index logging should be set up.

Requires Elasticsearch version 5.1 or later.


slowIndexLogGroup?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: ILogGroup (optional, default: a new log group is created if slow index logging is enabled)

Log slow indices to this log group.


slowSearchLogEnabled?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: boolean (optional, default: false)

Specify if slow search logging should be set up.

Requires Elasticsearch version 5.1 or later.


slowSearchLogGroup?⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: ILogGroup (optional, default: a new log group is created if slow search logging is enabled)

Log slow searches to this log group.