Skip to content

Commit 6761f56

Browse files
authored
fix(cx-api): adding missing readme (#33867)
### Issue # Closes #33866 ### Reason for this change #33729 missing readme update for cx-api ### Description of changes added readme https://github.com/aws/aws-cdk/blob/eae1d4fcc500ed39973a2d796c161171894eeb41/packages/aws-cdk-lib/cx-api/README.md?plain=1#L662-L681 ### 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 8e4374f commit 6761f56

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

packages/aws-cdk-lib/cx-api/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -658,3 +658,24 @@ _cdk.json_
658658
}
659659
}
660660
```
661+
662+
* `@aws-cdk/aws-events:requireEventBusPolicySid`
663+
664+
When this flag is enabled:
665+
- Resource policies will be created with Statement IDs for service principals
666+
- The operation will succeed as expected
667+
668+
When this flag is disabled:
669+
- A warning will be emitted
670+
- The grant operation will be dropped
671+
- No permissions will be added
672+
673+
_cdk.json_
674+
675+
```json
676+
{
677+
"context": {
678+
"@aws-cdk/aws-events:requireEventBusPolicySid": true
679+
}
680+
}
681+
```

packages/aws-cdk-lib/cx-api/lib/features.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1431,6 +1431,7 @@ export const FLAGS: Record<string, FlagInfo> = {
14311431
compatibilityWithOldBehaviorMd: 'Disable the feature flag to add the root account principal back',
14321432
},
14331433

1434+
//////////////////////////////////////////////////////////////////////
14341435
[EVENTBUS_POLICY_SID_REQUIRED]: {
14351436
type: FlagType.BugFix,
14361437
summary: 'When enabled, grantPutEventsTo() will use resource policies with Statement IDs for service principals.',

0 commit comments

Comments
 (0)