interface PolicyViolatingResource
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.PolicyViolatingResource |
 Go | github.com/aws/aws-cdk-go/awscdk/v2#PolicyViolatingResource |
 Java | software.amazon.awscdk.PolicyViolatingResource |
 Python | aws_cdk.PolicyViolatingResource |
 TypeScript (source) | aws-cdk-lib » PolicyViolatingResource |
Resource violating a specific rule.
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
| Name | Type | Description |
|---|---|---|
| locations | string[] | The locations in the CloudFormation template that pose the violations. |
| construct | string | The construct path of the violating construct. |
| resource | string | The logical ID of the resource in the CloudFormation template. |
| template | string | The path to the CloudFormation template that contains this resource. |
locations
Type:
string[]
The locations in the CloudFormation template that pose the violations.
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.
constructPath?
Type:
string
(optional, default: construct path is derived from the resource logical ID)
The construct path of the violating construct.
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.
resourceLogicalId?
Type:
string
(optional, default: no resource logical ID)
The logical ID of the resource in the CloudFormation template.
Intended for plugin-sourced violations that operate on CloudFormation templates.
If set, the constructPath will be added later.
templatePath?
Type:
string
(optional, default: no template path)
The path to the CloudFormation template that contains this resource.