software.amazon.awscdk.cxapi

Class CloudAssembly

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cxapi.CloudAssembly

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.896Z")
 @Stability(value=Stable)
public class CloudAssembly
extends software.amazon.jsii.JsiiObject

Represents a deployable cloud application.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cxapi.*;
 CloudAssembly cloudAssembly = CloudAssembly.Builder.create("directory")
         .skipEnumCheck(false)
         .skipVersionCheck(false)
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudAssembly(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CloudAssembly(software.amazon.jsii.JsiiObjectRef objRef)
	CloudAssembly(String directory) Reads a cloud assembly from the specified directory.
	CloudAssembly(String directory, LoadManifestOptions loadOptions) Reads a cloud assembly from the specified directory.

Method Summary

Modifier and Type	Method and Description
List<CloudArtifact>	getArtifacts() All artifacts included in this assembly.
String	getDirectory() The root directory of the cloud assembly.
AssemblyManifest	getManifest() The raw assembly manifest.
List<NestedCloudAssemblyArtifact>	getNestedAssemblies() The nested assembly artifacts in this assembly.
CloudAssembly	getNestedAssembly(String artifactId) Returns a nested assembly.
NestedCloudAssemblyArtifact	getNestedAssemblyArtifact(String artifactId) Returns a nested assembly artifact.
RuntimeInfo	getRuntime() Runtime information such as module versions used to synthesize this assembly.
CloudFormationStackArtifact	getStackArtifact(String artifactId) Returns a CloudFormation stack artifact from this assembly.
CloudFormationStackArtifact	getStackByName(String stackName) Returns a CloudFormation stack artifact from this assembly.
List<CloudFormationStackArtifact>	getStacks()
List<CloudFormationStackArtifact>	getStacksRecursively() Returns all the stacks, including the ones in nested assemblies.
String	getVersion() The schema version of the assembly manifest.
TreeCloudArtifact	tree() Returns the tree metadata artifact from this assembly.
CloudArtifact	tryGetArtifact(String id) Attempts to find an artifact with a specific identity.

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

CloudAssembly

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

CloudAssembly

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

CloudAssembly

@Stability(value=Stable)
public CloudAssembly(@NotNull
                                              String directory,
                                              @Nullable
                                              LoadManifestOptions loadOptions)

Reads a cloud assembly from the specified directory.

Parameters:

directory - The root directory of the assembly. This parameter is required.

loadOptions -

CloudAssembly

@Stability(value=Stable)
public CloudAssembly(@NotNull
                                              String directory)

Reads a cloud assembly from the specified directory.

Parameters:

directory - The root directory of the assembly. This parameter is required.

Method Detail

getNestedAssembly

@Stability(value=Stable)
 @NotNull
public CloudAssembly getNestedAssembly(@NotNull
                                                                          String artifactId)

Returns a nested assembly.

Parameters:

artifactId - The artifact ID of the nested assembly. This parameter is required.

getNestedAssemblyArtifact

@Stability(value=Stable)
 @NotNull
public NestedCloudAssemblyArtifact getNestedAssemblyArtifact(@NotNull
                                                                                                String artifactId)

Returns a nested assembly artifact.

Parameters:

artifactId - The artifact ID of the nested assembly. This parameter is required.

getStackArtifact

@Stability(value=Stable)
 @NotNull
public CloudFormationStackArtifact getStackArtifact(@NotNull
                                                                                       String artifactId)

Returns a CloudFormation stack artifact from this assembly.

Parameters:

artifactId - the artifact id of the stack (can be obtained through `stack.artifactId`). This parameter is required.

Returns:

a `CloudFormationStackArtifact` object.

getStackByName

@Stability(value=Stable)
 @NotNull
public CloudFormationStackArtifact getStackByName(@NotNull
                                                                                     String stackName)

Returns a CloudFormation stack artifact from this assembly.

Will only search the current assembly.

Parameters:

stackName - the name of the CloudFormation stack. This parameter is required.

Returns:

a `CloudFormationStackArtifact` object.

tree

@Stability(value=Stable)
 @Nullable
public TreeCloudArtifact tree()

Returns the tree metadata artifact from this assembly.

Returns:

a `TreeCloudArtifact` object if there is one defined in the manifest, `undefined` otherwise.

tryGetArtifact

@Stability(value=Stable)
 @Nullable
public CloudArtifact tryGetArtifact(@NotNull
                                                                        String id)

Attempts to find an artifact with a specific identity.

Parameters:

id - The artifact ID. This parameter is required.

Returns:

A `CloudArtifact` object or `undefined` if the artifact does not exist in this assembly.

getArtifacts

@Stability(value=Stable)
 @NotNull
public List<CloudArtifact> getArtifacts()

All artifacts included in this assembly.

getDirectory

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

The root directory of the cloud assembly.

getManifest

@Stability(value=Stable)
 @NotNull
public AssemblyManifest getManifest()

The raw assembly manifest.

getNestedAssemblies

@Stability(value=Stable)
 @NotNull
public List<NestedCloudAssemblyArtifact> getNestedAssemblies()

The nested assembly artifacts in this assembly.

getRuntime

@Stability(value=Stable)
 @NotNull
public RuntimeInfo getRuntime()

Runtime information such as module versions used to synthesize this assembly.

getStacks

@Stability(value=Stable)
 @NotNull
public List<CloudFormationStackArtifact> getStacks()

Returns:

all the CloudFormation stack artifacts that are included in this assembly.

getStacksRecursively

@Stability(value=Stable)
 @NotNull
public List<CloudFormationStackArtifact> getStacksRecursively()

Returns all the stacks, including the ones in nested assemblies.

getVersion

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

The schema version of the assembly manifest.