interface SuppressedViolationJson

Language	Type name
.NET	Amazon.CDK.CloudAssembly.Schema.SuppressedViolationJson
Java	software.amazon.awscdk.cloudassembly.schema.SuppressedViolationJson
Python	aws_cdk.cloud_assembly_schema.SuppressedViolationJson
TypeScript	@aws-cdk/cloud-assembly-schema » SuppressedViolationJson

Implements PolicyViolationJson

A violation that was acknowledged/suppressed and excluded from the active violation set.

Example

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

Name	Type	Description
acknowledgedId	string	The acknowledgement ID that caused this violation to be suppressed.
description	string	A description of the violation.
ruleName	string	The name of the rule that was violated.
severity	string	The severity of the violation.
violatingConstructs	ViolatingConstructJson[]	Constructs that violated the rule.
acknowledgedAt?	string	The construct path where the acknowledgement was declared.
acknowledgedStackTrace?	string	Stack trace showing where the acknowledgement was declared.
customSeverity?	string	If the plugin wants to report using a non-standard severity, put it here.
reason?	string	The reason given for the acknowledgement, if provided.
ruleMetadata?	{ [string]: string }	Additional rule-specific metadata.
suggestedFix?	string	How to fix the violation.

---

acknowledgedId

Type: string

The acknowledgement ID that caused this violation to be suppressed.

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

---

description

Type: string

A description of the violation.

---

ruleName

Type: string

The name of the rule that was violated.

---

severity

Type: string

The severity of the violation.

---

violatingConstructs

Type: ViolatingConstructJson[]

Constructs that violated the rule.

---

acknowledgedAt?

Type: string (optional, default: unknown)

The construct path where the acknowledgement was declared.

---

acknowledgedStackTrace?

Type: string (optional, default: no stack trace)

Stack trace showing where the acknowledgement was declared.

A \n-delimited string of stack frames.

---

customSeverity?

Type: string (optional)

If the plugin wants to report using a non-standard severity, put it here.

---

reason?

Type: string (optional, default: no reason given)

The reason given for the acknowledgement, if provided.

---

ruleMetadata?

Type: { [string]: string } (optional, default: no metadata)

Additional rule-specific metadata.

---

suggestedFix?

Type: string (optional, default: no fix provided)

How to fix the violation.