SuppressedViolationJson Struct
A violation that was acknowledged/suppressed and excluded from the active violation set.
Example
ts
import { SuppressedViolationJson } from '@aws-cdk/cloud-assembly-schema';
const suppressed: SuppressedViolationJson = {
ruleName: 'no-public-access',
description: 'S3 bucket should not allow public access',
severity: 'warning',
violatingConstructs: [{ constructPath: 'MyStack/MyBucket' }],
acknowledgedId: 'my-plugin::no-public-access',
};
Properties
acknowledgedAtoptionalstringacknowledged_atoptionalstracknowledgedAtoptionalStringAcknowledgedAtoptionalstringAcknowledgedAtoptional*string= unknown#The construct path where the acknowledgement was declared.
acknowledgedIdstringacknowledged_idstracknowledgedIdStringAcknowledgedIdstringAcknowledgedId*stringrequired#The acknowledgement ID that caused this violation to be suppressed.
Format: <plugin-name>::<rule-name> (spaces replaced with hyphens).
acknowledgedStackTraceoptionalstringacknowledged_stack_traceoptionalstracknowledgedStackTraceoptionalStringAcknowledgedStackTraceoptionalstringAcknowledgedStackTraceoptional*string#Stack trace showing where the acknowledgement was declared.
Default: no stack trace
A \n-delimited string of stack frames.
customSeverityoptionalstringcustom_severityoptionalstrcustomSeverityoptionalStringCustomSeverityoptionalstringCustomSeverityoptional*string#If the plugin wants to report using a non-standard severity, put it here.
A description of the violation.
The reason given for the acknowledgement, if provided.
Default: no reason given
ruleMetadataoptional{ [key: string]: string }rule_metadataoptionaltyping.Mapping[str, str]ruleMetadataoptionalMap<String, String>RuleMetadataoptionalIDictionary<string, string>RuleMetadataoptional*map[string]*string#Additional rule-specific metadata.
Default: no metadata
The name of the rule that was violated.
This may include a namespace: '<namespace>::<rule-name>'. If it does not, the plugin name will be used as the namespace.
The namespace must be included when acknowledging the violation.
The severity of the violation.
suggestedFixoptionalstringsuggested_fixoptionalstrsuggestedFixoptionalStringSuggestedFixoptionalstringSuggestedFixoptional*string#How to fix the violation.
Default: no fix provided
violatingConstructsViolatingConstructJson[]violating_constructstyping.List[ViolatingConstructJson]violatingConstructsList<ViolatingConstructJson>ViolatingConstructsViolatingConstructJson[]ViolatingConstructs*[]ViolatingConstructJsonrequired#Constructs that violated the rule.