Skip to content

Commit

Permalink
chore(opensearch): improve the doc about disabling the logging (#29202)
Browse files Browse the repository at this point in the history
### Issue # (if applicable)

Closes #29200

### Reason for this change

Disabling the logging from the enabled status requires an explicit `false`. This PR adds the description in the doc.

### Description of changes



### Description of how you validated changes



### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
pahud authored Feb 21, 2024
1 parent a4ebe8e commit a7f6b2d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ export interface LoggingOptions {
/**
* Specify if slow search logging should be set up.
* Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.
* An explicit `false` is required when disabling it from `true`.
*
* @default - false
*/
Expand All @@ -187,6 +188,7 @@ export interface LoggingOptions {
/**
* Specify if slow index logging should be set up.
* Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.
* An explicit `false` is required when disabling it from `true`.
*
* @default - false
*/
Expand All @@ -202,6 +204,7 @@ export interface LoggingOptions {
/**
* 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.
* An explicit `false` is required when disabling it from `true`.
*
* @default - false
*/
Expand Down

0 comments on commit a7f6b2d

Please sign in to comment.