interface LoggingOptions

Language	Type name
.NET	Amazon.CDK.AWS.OpenSearchService.LoggingOptions
Java	software.amazon.awscdk.services.opensearchservice.LoggingOptions
Python	aws_cdk.aws_opensearchservice.LoggingOptions
TypeScript (source)	@aws-cdk/aws-opensearchservice » LoggingOptions

Configures log settings for the domain.

Example

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

Properties

Name	Type	Description
appLogEnabled?	boolean	Specify if Amazon OpenSearch Service application logging should be set up.
appLogGroup?	ILogGroup	Log Amazon OpenSearch Service application logs to this log group.
auditLogEnabled?	boolean	Specify if Amazon OpenSearch Service audit logging should be set up.
auditLogGroup?	ILogGroup	Log Amazon OpenSearch Service audit logs to this log group.
slowIndexLogEnabled?	boolean	Specify if slow index logging should be set up.
slowIndexLogGroup?	ILogGroup	Log slow indices to this log group.
slowSearchLogEnabled?	boolean	Specify if slow search logging should be set up.
slowSearchLogGroup?	ILogGroup	Log slow searches to this log group.

---

appLogEnabled?

Type: boolean (optional, default: 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.

---

appLogGroup?

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

Log Amazon OpenSearch Service application logs to this log group.

---

auditLogEnabled?

Type: boolean (optional, default: 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.

---

auditLogGroup?

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

Log Amazon OpenSearch Service audit logs to this log group.

---

slowIndexLogEnabled?

Type: boolean (optional, default: false)

Specify if slow index logging should be set up.

Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.

---

slowIndexLogGroup?

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

Log slow indices to this log group.

---

slowSearchLogEnabled?

Type: boolean (optional, default: false)

Specify if slow search logging should be set up.

Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.

---

slowSearchLogGroup?

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

Log slow searches to this log group.