Package software.amazon.awscdk.cloudassembly.schema

Interface CloudFormationResourceJson

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudFormationResourceJson.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-07-30T08:06:26.687Z")
@Stability(Stable)
public interface CloudFormationResourceJson
extends software.amazon.jsii.JsiiSerializable

A node in the construct creation stack trace.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloudassembly.schema.*;
 CloudFormationResourceJson cloudFormationResourceJson = CloudFormationResourceJson.builder()
         .logicalId("logicalId")
         .templatePath("templatePath")
         // the properties below are optional
         .propertyPaths(List.of("propertyPaths"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CloudFormationResourceJson.Builder	builder()
String	getLogicalId()	The logical ID of the resource in the CloudFormation template.
default List<String>	getPropertyPaths()	Properties within the construct where the violation was detected.
String	getTemplatePath()	The path to the CloudFormation template containing this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLogicalId

@Stability(Stable)
@NotNull
String getLogicalId()

The logical ID of the resource in the CloudFormation template.

getTemplatePath

@Stability(Stable)
@NotNull
String getTemplatePath()

The path to the CloudFormation template containing this resource.

This path is relative to the Cloud Assembly root directory.

getPropertyPaths

@Stability(Stable)
@Nullable
default List<String> getPropertyPaths()

Properties within the construct where the violation was detected.

Either a single component, in which case it regards a top-level property name, or a JSON path (starting with $.) to indicate a deeper property.

Default: - no locations

builder

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

Returns:

a CloudFormationResourceJson.Builder of CloudFormationResourceJson