Package software.amazon.awscdk.cxapi

Class TreeCloudArtifact

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cxapi.CloudArtifact

software.amazon.awscdk.cxapi.TreeCloudArtifact

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:32.335Z")
@Stability(Stable)
public class TreeCloudArtifact
extends CloudArtifact

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloud_assembly_schema.*;
 import software.amazon.awscdk.cxapi.*;
 Object assumeRoleAdditionalOptions;
 CloudAssembly cloudAssembly;
 TreeCloudArtifact treeCloudArtifact = TreeCloudArtifact.Builder.create(cloudAssembly, "name")
         .type(ArtifactType.NONE)
         // the properties below are optional
         .dependencies(List.of("dependencies"))
         .displayName("displayName")
         .environment("environment")
         .metadata(Map.of(
                 "metadataKey", List.of(MetadataEntry.builder()
                         .type("type")
                         // the properties below are optional
                         .data("data")
                         .trace(List.of("trace"))
                         .build())))
         .properties(AwsCloudFormationStackProperties.builder()
                 .templateFile("templateFile")
                 // the properties below are optional
                 .assumeRoleAdditionalOptions(Map.of(
                         "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
                 .assumeRoleArn("assumeRoleArn")
                 .assumeRoleExternalId("assumeRoleExternalId")
                 .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
                 .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn")
                 .lookupRole(BootstrapRole.builder()
                         .arn("arn")
                         // the properties below are optional
                         .assumeRoleAdditionalOptions(Map.of(
                                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
                         .assumeRoleExternalId("assumeRoleExternalId")
                         .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
                         .requiresBootstrapStackVersion(123)
                         .build())
                 .notificationArns(List.of("notificationArns"))
                 .parameters(Map.of(
                         "parametersKey", "parameters"))
                 .requiresBootstrapStackVersion(123)
                 .stackName("stackName")
                 .stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl")
                 .tags(Map.of(
                         "tagsKey", "tags"))
                 .terminationProtection(false)
                 .validateOnSynth(false)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TreeCloudArtifact.Builder	A fluent builder for TreeCloudArtifact.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	TreeCloudArtifact(CloudAssembly assembly, String name, ArtifactManifest artifact)
protected	TreeCloudArtifact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TreeCloudArtifact(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getFile()
static Boolean	isTreeCloudArtifact(Object art)	Checks if art is an instance of this class.

Methods inherited from class software.amazon.awscdk.cxapi.CloudArtifact

findMetadataByType, fromManifest, getAssembly, getDependencies, getHierarchicalId, getId, getManifest, getMessages

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

TreeCloudArtifact

protected TreeCloudArtifact(software.amazon.jsii.JsiiObjectRef objRef)

TreeCloudArtifact

protected TreeCloudArtifact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

TreeCloudArtifact

@Stability(Stable)
public TreeCloudArtifact(@NotNull
 CloudAssembly assembly,
 @NotNull
 String name,
 @NotNull
 ArtifactManifest artifact)

Parameters:

assembly - This parameter is required.

name - This parameter is required.

artifact - This parameter is required.

Method Details

isTreeCloudArtifact

@Stability(Stable)
@NotNull
public static Boolean isTreeCloudArtifact(@NotNull
 Object art)

Checks if art is an instance of this class.

Use this method instead of instanceof to properly detect TreeCloudArtifact instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the cx-api library on disk are seen as independent, completely different libraries. As a consequence, the class TreeCloudArtifact in each copy of the cx-api library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the cx-api library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

art - This parameter is required.

getFile

@Stability(Stable)
@NotNull
public String getFile()