PolicyViolatingResource Struct
Resource violating a specific rule.
| Source | core/lib/validation/report.ts |
|---|---|
| Type last changed |
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',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
policy_violating_resource = cdk.PolicyViolatingResource(
locations=["locations"],
# the properties below are optional
construct_path="constructPath",
resource_logical_id="resourceLogicalId",
template_path="templatePath"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
PolicyViolatingResource policyViolatingResource = PolicyViolatingResource.builder()
.locations(List.of("locations"))
// the properties below are optional
.constructPath("constructPath")
.resourceLogicalId("resourceLogicalId")
.templatePath("templatePath")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
var policyViolatingResource = new PolicyViolatingResource {
Locations = new [] { "locations" },
// the properties below are optional
ConstructPath = "constructPath",
ResourceLogicalId = "resourceLogicalId",
TemplatePath = "templatePath"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
policyViolatingResource := &PolicyViolatingResource{
Locations: []*string{
jsii.String("locations"),
},
// the properties below are optional
ConstructPath: jsii.String("constructPath"),
ResourceLogicalId: jsii.String("resourceLogicalId"),
TemplatePath: jsii.String("templatePath"),
}
Properties
constructPathoptionalstringconstruct_pathoptionalstrconstructPathoptionalStringConstructPathoptionalstringConstructPathoptional*string #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*[]*string required #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.
resourceLogicalIdoptionalstringresource_logical_idoptionalstrresourceLogicalIdoptionalStringResourceLogicalIdoptionalstringResourceLogicalIdoptional*string #Default: no resource logical ID
Intended for plugin-sourced violations that operate on CloudFormation templates.
If set, the constructPath will be added later.
templatePathoptionalstringtemplate_pathoptionalstrtemplatePathoptionalStringTemplatePathoptionalstringTemplatePathoptional*string #Default: no template path