aws-cdk-lib.PolicyViolatingResource

PolicyViolatingResource Struct

Resource violating a specific rule.

Source

core/lib/validation/report.ts

Type last changed

v2.253.0 · 6 May 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const policyViolatingResource: cdk.PolicyViolatingResource = {
  locations: ['locations'],

  // the properties below are optional
  constructPath: 'constructPath',
  resourceLogicalId: 'resourceLogicalId',
  templatePath: 'templatePath',
};

Properties

constructPath?optionalstringconstruct_path?optionalstrconstructPath?optionalStringConstructPath?optionalstringConstructPath?optional*string#

The construct path of the violating construct.

Default: construct path is derived from the resource logical ID

notes

Use this for violations that originate from constructs rather than CloudFormation resources (e.g. annotations added via Annotations.of() or Validations.of()). When provided, the report will use this path directly instead of deriving it from the resource logical ID. Mutually exclusive with resourceLogicalId.

locationsstring[]locationstyping.List[str]locationsList<String>Locationsstring[]Locations*[]*stringrequired#

The locations in the CloudFormation template that pose the violations.

notes

This is a location in the CloudFormation template, relative to the resource that this violation is about. For example, if the violation is about a property of a resource, this will contain something like Properties.MyProperty. If the violation is about the Stack itself, it will contain something like Parameters.MyParameter.

resourceLogicalId?optionalstringresource_logical_id?optionalstrresourceLogicalId?optionalStringResourceLogicalId?optionalstringResourceLogicalId?optional*string#

The logical ID of the resource in the CloudFormation template.

Default: no resource logical ID

Intended for plugin-sourced violations that operate on CloudFormation templates.

If set, the constructPath will be added later.

templatePath?optionalstringtemplate_path?optionalstrtemplatePath?optionalStringTemplatePath?optionalstringTemplatePath?optional*string#

The path to the CloudFormation template that contains this resource.

Default: no template path