Package software.amazon.awscdk.cloudassembly.schema

Interface SuppressedViolationJson

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, PolicyViolationJson

All Known Implementing Classes:

SuppressedViolationJson.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-07-30T08:06:26.720Z")
@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 Classes

Modifier and Type	Interface	Description
static class	SuppressedViolationJson.Builder	A builder for SuppressedViolationJson
static class	SuppressedViolationJson.Jsii$Proxy	An implementation for SuppressedViolationJson

Method Summary

Modifier and Type	Method	Description
static SuppressedViolationJson.Builder	builder()
default String	getAcknowledgedAt()	The construct path where the acknowledgement was declared.
String	getAcknowledgedId()	The acknowledgement ID that caused this violation to be suppressed.
default String	getAcknowledgedStackTrace()	Stack trace showing where the acknowledgement was declared.
default String	getReason()	The reason given for the acknowledgement, if provided.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.cloudassembly.schema.PolicyViolationJson

getCustomSeverity, getDescription, getRuleMetadata, getRuleName, getSeverity, getSuggestedFix, getViolatingConstructs

Method Detail

getAcknowledgedId

@Stability(Stable)
@NotNull
String getAcknowledgedId()

The acknowledgement ID that caused this violation to be suppressed.

Format: <plugin-name>::<rule-name> (spaces replaced with hyphens).

getAcknowledgedAt

@Stability(Stable)
@Nullable
default String getAcknowledgedAt()

The construct path where the acknowledgement was declared.

Default: - unknown

getAcknowledgedStackTrace

@Stability(Stable)
@Nullable
default String getAcknowledgedStackTrace()

Stack trace showing where the acknowledgement was declared.

A \n-delimited string of stack frames.

Default: - no stack trace

getReason

@Stability(Stable)
@Nullable
default String getReason()

The reason given for the acknowledgement, if provided.

Default: - no reason given

builder

@Stability(Stable)
static SuppressedViolationJson.Builder builder()

Returns:

a SuppressedViolationJson.Builder of SuppressedViolationJson