aws-cdk-lib.aws_opensearchservice.CfnDomain.LogPublishingOptionProperty

interface LogPublishingOptionProperty

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchService.CfnDomain.LogPublishingOptionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CfnDomain_LogPublishingOptionProperty
Javasoftware.amazon.awscdk.services.opensearchservice.CfnDomain.LogPublishingOptionProperty
Pythonaws_cdk.aws_opensearchservice.CfnDomain.LogPublishingOptionProperty
TypeScript aws-cdk-lib » aws_opensearchservice » 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 { aws_opensearchservice as opensearchservice } from 'aws-cdk-lib';
const logPublishingOptionProperty: opensearchservice.CfnDomain.LogPublishingOptionProperty = {
  cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',
  enabled: false,
};

Properties

NameTypeDescription
cloudWatchLogsLogGroupArn?stringSpecifies the CloudWatch log group to publish to.
enabled?boolean | IResolvableIf true , enables the publishing of logs to CloudWatch.

cloudWatchLogsLogGroupArn?

Type: string (optional)

Specifies the CloudWatch log group to publish to.

Required if you enable log publishing.


enabled?

Type: boolean | IResolvable (optional)

If true , enables the publishing of logs to CloudWatch.

Default: false .