Interface PolicyViolationBeta1

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PolicyViolationBeta1.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-19T18:25:42.936Z")
@Stability(Stable)
public interface PolicyViolationBeta1
extends software.amazon.jsii.JsiiSerializable

Violation produced by the validation plugin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 PolicyViolationBeta1 policyViolationBeta1 = PolicyViolationBeta1.builder()
         .description("description")
         .ruleName("ruleName")
         .violatingResources(List.of(PolicyViolatingResourceBeta1.builder()
                 .locations(List.of("locations"))
                 .resourceLogicalId("resourceLogicalId")
                 .templatePath("templatePath")
                 .build()))
         // the properties below are optional
         .fix("fix")
         .ruleMetadata(Map.of(
                 "ruleMetadataKey", "ruleMetadata"))
         .severity("severity")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PolicyViolationBeta1.Builder	builder()
String	getDescription()	The description of the violation.
default String	getFix()	How to fix the violation.
default Map<String,String>	getRuleMetadata()	Additional metadata to include with the rule results.
String	getRuleName()	The name of the rule.
default String	getSeverity()	The severity of the violation, only used for reporting purposes.
List<PolicyViolatingResourceBeta1>	getViolatingResources()	The resources violating this rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

The description of the violation.

getRuleName

@Stability(Stable)
@NotNull
String getRuleName()

The name of the rule.

getViolatingResources

@Stability(Stable)
@NotNull
List<PolicyViolatingResourceBeta1> getViolatingResources()

The resources violating this rule.

getFix

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

How to fix the violation.

Default: - no fix is provided

getRuleMetadata

@Stability(Stable)
@Nullable
default Map<String,String> getRuleMetadata()

Additional metadata to include with the rule results.

This can be used to provide additional information that is plugin specific. The data provided here will be rendered as is.

Default: - no rule metadata

getSeverity

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

The severity of the violation, only used for reporting purposes.

This is useful for helping the user discriminate between warnings, errors, information, etc.

Default: - no severity

builder

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

Returns:

a PolicyViolationBeta1.Builder of PolicyViolationBeta1