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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.902Z")
 @Stability(value=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.cloudassembly.schema.*;
 import software.amazon.awscdk.cxapi.*;
 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
                 .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 and Description
static 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 and 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 and Description
String	getFile()

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 Detail

TreeCloudArtifact

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

TreeCloudArtifact

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

TreeCloudArtifact

@Stability(value=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 Detail

getFile

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