cdk-insights 0.11.2 → 0.11.3
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 +52 -0
- package/dist/config/featureGating.d.ts +0 -1
- package/dist/entry.js +30 -33
- package/dist/index.js +35 -38
- package/package.json +1 -1
- package/dist/analysis/runAnalysis.d.ts +0 -2
package/README.md
CHANGED
|
@@ -142,6 +142,58 @@ CDK Insights offers flexible tiers:
|
|
|
142
142
|
|
|
143
143
|
---
|
|
144
144
|
|
|
145
|
+
## 🔧 Troubleshooting
|
|
146
|
+
|
|
147
|
+
### Cache Management
|
|
148
|
+
|
|
149
|
+
CDK Insights caches analysis results to speed up subsequent runs:
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
# Clear all caches (analysis + auth tokens)
|
|
153
|
+
npx cdk-insights clear-cache
|
|
154
|
+
|
|
155
|
+
# Check cache status
|
|
156
|
+
npx cdk-insights cache-status
|
|
157
|
+
|
|
158
|
+
# Run analysis without using cache
|
|
159
|
+
npx cdk-insights scan --no-cache
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Authentication Issues
|
|
163
|
+
|
|
164
|
+
If you encounter license validation errors:
|
|
165
|
+
|
|
166
|
+
1. Check your license key is correctly set: `echo $CDK_INSIGHTS_LICENSE_KEY`
|
|
167
|
+
2. Clear the auth cache: `npx cdk-insights clear-cache`
|
|
168
|
+
3. Verify your internet connection
|
|
169
|
+
|
|
170
|
+
### Sensitive Data Detection
|
|
171
|
+
|
|
172
|
+
CDK Insights detects potentially sensitive data in your CloudFormation templates:
|
|
173
|
+
|
|
174
|
+
```bash
|
|
175
|
+
# Fail on sensitive data detection (default)
|
|
176
|
+
npx cdk-insights scan --fail-on-critical
|
|
177
|
+
|
|
178
|
+
# Warn but continue on sensitive data
|
|
179
|
+
npx cdk-insights scan --warn-sensitive
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Configure detection in `.cdk-insights.json`:
|
|
183
|
+
|
|
184
|
+
```json
|
|
185
|
+
{
|
|
186
|
+
"sensitiveDataDetection": {
|
|
187
|
+
"enabled": true,
|
|
188
|
+
"warnOnly": false,
|
|
189
|
+
"allowPatterns": ["^test-"],
|
|
190
|
+
"ignoreProperties": ["Description"]
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
145
197
|
## 📚 Links & Resources
|
|
146
198
|
|
|
147
199
|
- [GitHub Repository & Issues](https://github.com/TheLeePriest/cdk-insights)
|
|
@@ -21,5 +21,4 @@ export declare const createFeatureGating: (config?: FeatureConfig) => FeatureGat
|
|
|
21
21
|
export declare const featureGating: FeatureGatingFunction;
|
|
22
22
|
export declare const requireFeature: (feature: FeatureName, tier: Tier, context?: string) => void;
|
|
23
23
|
export declare const getFeatureUpgradeMessage: (feature: FeatureName, tier: Tier, context?: string) => string;
|
|
24
|
-
export declare const logFeatureAccess: (feature: FeatureName, tier: Tier, enabled: boolean, context?: string) => void;
|
|
25
24
|
export {};
|