From 879f6b1e1fe80434f465b1f9ac930dad0452dcdb Mon Sep 17 00:00:00 2001
From: Gavin Zhang <yuanhaoz@amazon.com>
Date: Wed, 6 Mar 2024 10:30:07 -0800
Subject: [PATCH] add default documentation

---
 packages/aws-cdk-lib/aws-events-targets/README.md  | 14 ++++++++++++++
 .../lib/log-group-resource-policy.ts               |  2 ++
 2 files changed, 16 insertions(+)

diff --git a/packages/aws-cdk-lib/aws-events-targets/README.md b/packages/aws-cdk-lib/aws-events-targets/README.md
index 781e257857cd4..41274bbe3b923 100644
--- a/packages/aws-cdk-lib/aws-events-targets/README.md
+++ b/packages/aws-cdk-lib/aws-events-targets/README.md
@@ -120,6 +120,20 @@ rule.addTarget(new targets.CloudWatchLogGroup(logGroup, {
 }));
 ```
 
+The cloudwatch log event target will create an AWS custom resource internally which will default
+to set `installLatestAwsSdk` to `true`. This may be problematic for CN partition deployment. To
+workaround this issue, set `installLatestAwsSdk` to `false`.
+
+```ts
+import * as logs from 'aws-cdk-lib/aws-logs';
+declare const logGroup: logs.LogGroup;
+declare const rule: events.Rule;
+
+rule.addTarget(new targets.CloudWatchLogGroup(logGroup, {
+  installLatestAwsSdk: false,
+}));
+```
+
 ## Start a CodeBuild build
 
 Use the `CodeBuildProject` target to trigger a CodeBuild project.
diff --git a/packages/aws-cdk-lib/aws-events-targets/lib/log-group-resource-policy.ts b/packages/aws-cdk-lib/aws-events-targets/lib/log-group-resource-policy.ts
index 3185ce2752624..710cd70b6e207 100644
--- a/packages/aws-cdk-lib/aws-events-targets/lib/log-group-resource-policy.ts
+++ b/packages/aws-cdk-lib/aws-events-targets/lib/log-group-resource-policy.ts
@@ -17,6 +17,8 @@ export interface LogGroupResourcePolicyProps {
   readonly policyStatements: [iam.PolicyStatement];
   /**
    * Whether to install latest AWS SDK for the custom resource
+   *
+   * @default - install latest AWS SDK
    */
   readonly installLatestAwsSdk?: boolean;
 }