Package software.amazon.awscdk.cxapi

Class NestedCloudAssemblyArtifact

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cxapi.CloudArtifact

software.amazon.awscdk.cxapi.NestedCloudAssemblyArtifact

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:37.514Z")
@Stability(Stable)
public class NestedCloudAssemblyArtifact
extends CloudArtifact

Asset manifest is a description of a set of assets which need to be built and published.

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.*;
 CloudAssembly cloudAssembly;
 NestedCloudAssemblyArtifact nestedCloudAssemblyArtifact = NestedCloudAssemblyArtifact.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
                 .assumeRoleArn("assumeRoleArn")
                 .assumeRoleExternalId("assumeRoleExternalId")
                 .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
                 .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn")
                 .lookupRole(BootstrapRole.builder()
                         .arn("arn")
                         // the properties below are optional
                         .assumeRoleExternalId("assumeRoleExternalId")
                         .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
                         .requiresBootstrapStackVersion(123)
                         .build())
                 .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	NestedCloudAssemblyArtifact.Builder	A fluent builder for NestedCloudAssemblyArtifact.

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getDirectoryName()	The relative directory name of the asset manifest.
String	getDisplayName()	Display name.
String	getFullPath()	Full path to the nested assembly directory.
CloudAssembly	getNestedAssembly()	The nested Assembly.
static Boolean	isNestedCloudAssemblyArtifact(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

NestedCloudAssemblyArtifact

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

NestedCloudAssemblyArtifact

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

NestedCloudAssemblyArtifact

@Stability(Stable)
public NestedCloudAssemblyArtifact(@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

isNestedCloudAssemblyArtifact

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

Checks if art is an instance of this class.

Use this method instead of instanceof to properly detect NestedCloudAssemblyArtifact 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 NestedCloudAssemblyArtifact 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.

getDirectoryName

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

The relative directory name of the asset manifest.

getDisplayName

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

Display name.

getFullPath

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

Full path to the nested assembly directory.

getNestedAssembly

@Stability(Stable)
@NotNull
public CloudAssembly getNestedAssembly()

The nested Assembly.