Interface ILoggingOptions

Configures log settings for the domain.

Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ILoggingOptions
Syntax (vb)
Public Interface 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

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.

Properties

AppLogEnabled

Specify if Amazon OpenSearch Service application logging should be set up.

virtual Nullable<bool> AppLogEnabled { get; }
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.

virtual ILogGroup AppLogGroup { get; }
Property Value

ILogGroup

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.

virtual Nullable<bool> AuditLogEnabled { get; }
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.

virtual ILogGroup AuditLogGroup { get; }
Property Value

ILogGroup

Remarks

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

SlowIndexLogEnabled

Specify if slow index logging should be set up.

virtual Nullable<bool> SlowIndexLogEnabled { get; }
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.

virtual ILogGroup SlowIndexLogGroup { get; }
Property Value

ILogGroup

Remarks

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

SlowSearchLogEnabled

Specify if slow search logging should be set up.

virtual Nullable<bool> SlowSearchLogEnabled { get; }
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.

virtual ILogGroup SlowSearchLogGroup { get; }
Property Value

ILogGroup

Remarks

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