cdk-insights 1.3.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -0
- package/dist/entry.js +186 -186
- package/dist/helpers/parseManifestMetadata/parseManifestMetadata.d.ts +2 -1
- package/dist/helpers/synthesizeCdkStacks/synthesizeCdkStacks.d.ts +7 -1
- package/dist/index.d.ts +3 -2
- package/dist/index.js +127 -127
- package/dist/types/analysis.types.d.ts +17 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -160,6 +160,32 @@ Aspects.of(app).add(new CdkInsightsAspect());
|
|
|
160
160
|
app.synth();
|
|
161
161
|
```
|
|
162
162
|
|
|
163
|
+
### Suppressing Findings
|
|
164
|
+
|
|
165
|
+
Two channels, both feed into the same scan output, SARIF, severity counts, and PR comments:
|
|
166
|
+
|
|
167
|
+
**Project-wide** — add `ignoreRules` and `ignorePaths` to `.cdk-insights.json`. Trailing `*` wildcards supported.
|
|
168
|
+
|
|
169
|
+
```json
|
|
170
|
+
{
|
|
171
|
+
"ignoreRules": ["CDK-INSIGHTS-SENSITIVE-*"],
|
|
172
|
+
"ignorePaths": ["MyStack/MarketingSite/*"]
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
**Inline** (CDK ≥ 2.252.0) — acknowledge a finding next to the construct that triggered it, with a reason captured for audit:
|
|
177
|
+
|
|
178
|
+
```ts
|
|
179
|
+
import { Validations } from 'aws-cdk-lib';
|
|
180
|
+
|
|
181
|
+
Validations.of(myBucket).acknowledge({
|
|
182
|
+
id: 'cdk-insights::s3-bucket-public-access',
|
|
183
|
+
reason: 'Public-by-design marketing site',
|
|
184
|
+
});
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
Acknowledgements cascade to descendant constructs, so scope them as narrowly as the situation allows. See [Suppressing Findings](https://github.com/instancelabs/cdk-insights/blob/main/docs/configuration.md#suppressing-findings) for details.
|
|
188
|
+
|
|
163
189
|
---
|
|
164
190
|
|
|
165
191
|
## 💰 Pricing
|