Skip to content

Commit a7f6b2d

Browse files
authored
chore(opensearch): improve the doc about disabling the logging (#29202)
### 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*
1 parent a4ebe8e commit a7f6b2d

File tree

1 file changed

+3
-0
lines changed
  • packages/aws-cdk-lib/aws-opensearchservice/lib

1 file changed

+3
-0
lines changed

packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts

+3
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@ export interface LoggingOptions {
172172
/**
173173
* Specify if slow search logging should be set up.
174174
* Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.
175+
* An explicit `false` is required when disabling it from `true`.
175176
*
176177
* @default - false
177178
*/
@@ -187,6 +188,7 @@ export interface LoggingOptions {
187188
/**
188189
* Specify if slow index logging should be set up.
189190
* Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.
191+
* An explicit `false` is required when disabling it from `true`.
190192
*
191193
* @default - false
192194
*/
@@ -202,6 +204,7 @@ export interface LoggingOptions {
202204
/**
203205
* Specify if Amazon OpenSearch Service application logging should be set up.
204206
* Requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later.
207+
* An explicit `false` is required when disabling it from `true`.
205208
*
206209
* @default - false
207210
*/

0 commit comments

Comments
 (0)