LoggingOptions

class aws_cdk.aws_opensearchservice.LoggingOptions(*, app_log_enabled=None, app_log_group=None, audit_log_enabled=None, audit_log_group=None, slow_index_log_enabled=None, slow_index_log_group=None, slow_search_log_enabled=None, slow_search_log_group=None)

Bases: object

Configures log settings for the domain.

Parameters
  • app_log_enabled (Optional[bool]) – 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. Default: - false

  • app_log_group (Optional[ILogGroup]) – Log Amazon OpenSearch Service application logs to this log group. Default: - a new log group is created if app logging is enabled

  • audit_log_enabled (Optional[bool]) – 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. Default: - false

  • audit_log_group (Optional[ILogGroup]) – Log Amazon OpenSearch Service audit logs to this log group. Default: - a new log group is created if audit logging is enabled

  • slow_index_log_enabled (Optional[bool]) – Specify if slow index logging should be set up. Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later. Default: - false

  • slow_index_log_group (Optional[ILogGroup]) – Log slow indices to this log group. Default: - a new log group is created if slow index logging is enabled

  • slow_search_log_enabled (Optional[bool]) – Specify if slow search logging should be set up. Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later. Default: - false

  • slow_search_log_group (Optional[ILogGroup]) – Log slow searches to this log group. Default: - a new log group is created if slow search logging is enabled

ExampleMetadata

infused

Example:

prod_domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    capacity=opensearch.CapacityConfig(
        master_nodes=5,
        data_nodes=20
    ),
    ebs=opensearch.EbsOptions(
        volume_size=20
    ),
    zone_awareness=opensearch.ZoneAwarenessConfig(
        availability_zone_count=3
    ),
    logging=opensearch.LoggingOptions(
        slow_search_log_enabled=True,
        app_log_enabled=True,
        slow_index_log_enabled=True
    )
)

Attributes

app_log_enabled

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.

Default
  • false

Return type

Optional[bool]

app_log_group

Log Amazon OpenSearch Service application logs to this log group.

Default
  • a new log group is created if app logging is enabled

Return type

Optional[ILogGroup]

audit_log_enabled

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.

Default
  • false

Return type

Optional[bool]

audit_log_group

Log Amazon OpenSearch Service audit logs to this log group.

Default
  • a new log group is created if audit logging is enabled

Return type

Optional[ILogGroup]

slow_index_log_enabled

Specify if slow index logging should be set up.

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

Default
  • false

Return type

Optional[bool]

slow_index_log_group

Log slow indices to this log group.

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

Return type

Optional[ILogGroup]

slow_search_log_enabled

Specify if slow search logging should be set up.

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

Default
  • false

Return type

Optional[bool]

slow_search_log_group

Log slow searches to this log group.

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

Return type

Optional[ILogGroup]