software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.LogPublishingOptionProperty

All Known Implementing Classes:

CfnDomain.LogPublishingOptionProperty.Jsii$Proxy

Enclosing class:

CfnDomain

public static interface CfnDomain.LogPublishingOptionProperty

Specifies whether the OpenSearch Service domain publishes application, search slow logs, or index slow logs to Amazon CloudWatch.

Each option must be an object of name SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , or AUDIT_LOGS depending on the type of logs you want to publish. For the full syntax, see the examples .

Before you enable log publishing, you need to create a CloudWatch log group and provide OpenSearch Service the correct permissions to write to it. To learn more, see Enabling log publishing ( AWS CloudFormation) .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchservice.*;
 LogPublishingOptionProperty logPublishingOptionProperty = LogPublishingOptionProperty.builder()
         .cloudWatchLogsLogGroupArn("cloudWatchLogsLogGroupArn")
         .enabled(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDomain.LogPublishingOptionProperty.Builder A builder for CfnDomain.LogPublishingOptionProperty
static class	CfnDomain.LogPublishingOptionProperty.Jsii$Proxy An implementation for CfnDomain.LogPublishingOptionProperty

Method Summary

Modifier and Type	Method and Description
static CfnDomain.LogPublishingOptionProperty.Builder	builder()
default java.lang.String	getCloudWatchLogsLogGroupArn() Specifies the CloudWatch log group to publish to.
default java.lang.Object	getEnabled() If `true` , enables the publishing of logs to CloudWatch.

Method Detail

getCloudWatchLogsLogGroupArn

default java.lang.String getCloudWatchLogsLogGroupArn()

Specifies the CloudWatch log group to publish to.

Required if you enable log publishing.

getEnabled

default java.lang.Object getEnabled()

If `true` , enables the publishing of logs to CloudWatch.

Default: false .

builder

static CfnDomain.LogPublishingOptionProperty.Builder builder()

Returns:

a CfnDomain.LogPublishingOptionProperty.Builder of CfnDomain.LogPublishingOptionProperty