Class LoggingOptions

(deprecated) Configures log settings for the domain.

Inheritance

object

LoggingOptions

Implements

ILoggingOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class LoggingOptions : ILoggingOptions

Syntax (vb)

Public Class LoggingOptions Implements ILoggingOptions

Remarks

Stability: Deprecated

ExampleMetadata: infused

Examples

var prodDomain = new Domain(this, "Domain", new DomainProps {
                 Version = ElasticsearchVersion.V7_1,
                 Capacity = new CapacityConfig {
                     MasterNodes = 5,
                     DataNodes = 20
                 },
                 Ebs = new EbsOptions {
                     VolumeSize = 20
                 },
                 ZoneAwareness = new ZoneAwarenessConfig {
                     AvailabilityZoneCount = 3
                 },
                 Logging = new LoggingOptions {
                     SlowSearchLogEnabled = true,
                     AppLogEnabled = true,
                     SlowIndexLogEnabled = true
                 }
             });

Synopsis

Constructors

LoggingOptions()

(deprecated) Configures log settings for the domain.

Properties

AppLogEnabled	(deprecated) Specify if Elasticsearch application logging should be set up.
AppLogGroup	(deprecated) Log Elasticsearch application logs to this log group.
AuditLogEnabled	(deprecated) Specify if Elasticsearch audit logging should be set up.
AuditLogGroup	(deprecated) Log Elasticsearch audit logs to this log group.
SlowIndexLogEnabled	(deprecated) Specify if slow index logging should be set up.
SlowIndexLogGroup	(deprecated) Log slow indices to this log group.
SlowSearchLogEnabled	(deprecated) Specify if slow search logging should be set up.
SlowSearchLogGroup	(deprecated) Log slow searches to this log group.

Constructors

LoggingOptions()

(deprecated) Configures log settings for the domain.

public LoggingOptions()

Remarks

Stability: Deprecated

ExampleMetadata: infused

Examples

var prodDomain = new Domain(this, "Domain", new DomainProps {
                 Version = ElasticsearchVersion.V7_1,
                 Capacity = new CapacityConfig {
                     MasterNodes = 5,
                     DataNodes = 20
                 },
                 Ebs = new EbsOptions {
                     VolumeSize = 20
                 },
                 ZoneAwareness = new ZoneAwarenessConfig {
                     AvailabilityZoneCount = 3
                 },
                 Logging = new LoggingOptions {
                     SlowSearchLogEnabled = true,
                     AppLogEnabled = true,
                     SlowIndexLogEnabled = true
                 }
             });

Properties

AppLogEnabled

(deprecated) Specify if Elasticsearch application logging should be set up.

[Obsolete("use opensearchservice module instead")]
public bool? AppLogEnabled { get; set; }

Property Value

bool?

Remarks

Requires Elasticsearch version 5.1 or later.

Default: - false

Stability: Deprecated

AppLogGroup

(deprecated) Log Elasticsearch application logs to this log group.

[Obsolete("use opensearchservice module instead")]
public ILogGroupRef? AppLogGroup { get; set; }

Property Value

ILogGroupRef

Remarks

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

Stability: Deprecated

AuditLogEnabled

(deprecated) Specify if Elasticsearch audit logging should be set up.

[Obsolete("use opensearchservice module instead")]
public bool? AuditLogEnabled { get; set; }

Property Value

bool?

Remarks

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

Default: - false

Stability: Deprecated

AuditLogGroup

(deprecated) Log Elasticsearch audit logs to this log group.

[Obsolete("use opensearchservice module instead")]
public ILogGroupRef? AuditLogGroup { get; set; }

Property Value

ILogGroupRef

Remarks

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

Stability: Deprecated

SlowIndexLogEnabled

(deprecated) Specify if slow index logging should be set up.

[Obsolete("use opensearchservice module instead")]
public bool? SlowIndexLogEnabled { get; set; }

Property Value

bool?

Remarks

Requires Elasticsearch version 5.1 or later.

Default: - false

Stability: Deprecated

SlowIndexLogGroup

(deprecated) Log slow indices to this log group.

[Obsolete("use opensearchservice module instead")]
public ILogGroupRef? SlowIndexLogGroup { get; set; }

Property Value

ILogGroupRef

Remarks

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

Stability: Deprecated

SlowSearchLogEnabled

(deprecated) Specify if slow search logging should be set up.

[Obsolete("use opensearchservice module instead")]
public bool? SlowSearchLogEnabled { get; set; }

Property Value

bool?

Remarks

Requires Elasticsearch version 5.1 or later.

Default: - false

Stability: Deprecated

SlowSearchLogGroup

(deprecated) Log slow searches to this log group.

[Obsolete("use opensearchservice module instead")]
public ILogGroupRef? SlowSearchLogGroup { get; set; }

Property Value

ILogGroupRef

Remarks

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

Stability: Deprecated

Implements

ILoggingOptions