Interface SuppressedViolationJson
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable,PolicyViolationJson
- All Known Implementing Classes:
SuppressedViolationJson.Jsii$Proxy
@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
date="2026-07-02T13:32:49.628Z")
@Stability(Stable)
public interface SuppressedViolationJson
extends software.amazon.jsii.JsiiSerializable, PolicyViolationJson
A violation that was acknowledged/suppressed and excluded from the active violation set.
Example:
import software.amazon.awscdk.cloudassembly.schema.SuppressedViolationJson;
SuppressedViolationJson suppressed = SuppressedViolationJson.builder()
.ruleName("no-public-access")
.description("S3 bucket should not allow public access")
.severity("warning")
.violatingConstructs(List.of(ViolatingConstructJson.builder().constructPath("MyStack/MyBucket").build()))
.acknowledgedId("my-plugin::no-public-access")
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forSuppressedViolationJsonstatic final classAn implementation forSuppressedViolationJson -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe construct path where the acknowledgement was declared.The acknowledgement ID that caused this violation to be suppressed.default StringStack trace showing where the acknowledgement was declared.default StringThe reason given for the acknowledgement, if provided.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.cloud_assembly_schema.PolicyViolationJson
getCustomSeverity, getDescription, getRuleMetadata, getRuleName, getSeverity, getSuggestedFix, getViolatingConstructs
-
Method Details
-
getAcknowledgedId
The acknowledgement ID that caused this violation to be suppressed.Format:
<plugin-name>::<rule-name>(spaces replaced with hyphens). -
getAcknowledgedAt
The construct path where the acknowledgement was declared.Default: - unknown
-
getAcknowledgedStackTrace
Stack trace showing where the acknowledgement was declared.A
\n-delimited string of stack frames.Default: - no stack trace
-
getReason
The reason given for the acknowledgement, if provided.Default: - no reason given
-
builder
- Returns:
- a
SuppressedViolationJson.BuilderofSuppressedViolationJson
-