Class LoggingOptions
Configures log settings for the domain.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class LoggingOptions : Object, ILoggingOptions
Syntax (vb)
Public Class LoggingOptions
Inherits Object
Implements ILoggingOptions
Remarks
ExampleMetadata: infused
Examples
var domain = new Domain(this, "Domain", new DomainProps {
Version = EngineVersion.OPENSEARCH_1_0,
EnforceHttps = true,
NodeToNodeEncryption = true,
EncryptionAtRest = new EncryptionAtRestOptions {
Enabled = true
},
FineGrainedAccessControl = new AdvancedSecurityOptions {
MasterUserName = "master-user"
},
Logging = new LoggingOptions {
AuditLogEnabled = true,
SlowSearchLogEnabled = true,
AppLogEnabled = true,
SlowIndexLogEnabled = true
}
});
Synopsis
Constructors
LoggingOptions() |
Properties
AppLogEnabled | Specify if Amazon OpenSearch Service application logging should be set up. |
AppLogGroup | Log Amazon OpenSearch Service application logs to this log group. |
AuditLogEnabled | Specify if Amazon OpenSearch Service audit logging should be set up. |
AuditLogGroup | Log Amazon OpenSearch Service audit logs to this log group. |
SlowIndexLogEnabled | Specify if slow index logging should be set up. |
SlowIndexLogGroup | Log slow indices to this log group. |
SlowSearchLogEnabled | Specify if slow search logging should be set up. |
SlowSearchLogGroup | Log slow searches to this log group. |
Constructors
LoggingOptions()
public LoggingOptions()
Properties
AppLogEnabled
Specify if Amazon OpenSearch Service application logging should be set up.
public Nullable<bool> AppLogEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.
An explicit false
is required when disabling it from true
.
Default: - false
AppLogGroup
Log Amazon OpenSearch Service application logs to this log group.
public ILogGroup AppLogGroup { get; set; }
Property Value
Remarks
Default: - a new log group is created if app logging is enabled
AuditLogEnabled
Specify if Amazon OpenSearch Service audit logging should be set up.
public Nullable<bool> AuditLogEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Requires Elasticsearch version 6.7 or later or OpenSearch version 1.0 or later and fine grained access control to be enabled.
Default: - false
AuditLogGroup
Log Amazon OpenSearch Service audit logs to this log group.
public ILogGroup AuditLogGroup { get; set; }
Property Value
Remarks
Default: - a new log group is created if audit logging is enabled
SlowIndexLogEnabled
Specify if slow index logging should be set up.
public Nullable<bool> SlowIndexLogEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.
An explicit false
is required when disabling it from true
.
Default: - false
SlowIndexLogGroup
Log slow indices to this log group.
public ILogGroup SlowIndexLogGroup { get; set; }
Property Value
Remarks
Default: - a new log group is created if slow index logging is enabled
SlowSearchLogEnabled
Specify if slow search logging should be set up.
public Nullable<bool> SlowSearchLogEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.
An explicit false
is required when disabling it from true
.
Default: - false
SlowSearchLogGroup
Log slow searches to this log group.
public ILogGroup SlowSearchLogGroup { get; set; }
Property Value
Remarks
Default: - a new log group is created if slow search logging is enabled