Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.LogPublishingOptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.LogPublishingOptionProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.LogPublishingOptionProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCloudWatchLogsLogGroupArn

@Stability(Stable)
@Nullable
default String getCloudWatchLogsLogGroupArn()

Specifies the CloudWatch log group to publish to.

Required if you enable log publishing.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html#cfn-opensearchservice-domain-logpublishingoption-cloudwatchlogsloggrouparn

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

If true , enables the publishing of logs to CloudWatch.

Default: false .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html#cfn-opensearchservice-domain-logpublishingoption-enabled

builder

@Stability(Stable)
static CfnDomain.LogPublishingOptionProperty.Builder builder()

Returns:

a CfnDomain.LogPublishingOptionProperty.Builder of CfnDomain.LogPublishingOptionProperty