software.amazon.awscdk.cxapi

Class CloudAssemblyBuilder

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cxapi.CloudAssemblyBuilder

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

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

Can be used to build a cloud assembly.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cxapi.*;
 CloudAssemblyBuilder cloudAssemblyBuilder;
 CloudAssemblyBuilder cloudAssemblyBuilder = CloudAssemblyBuilder.Builder.create("outdir")
         .assetOutdir("assetOutdir")
         .parentBuilder(cloudAssemblyBuilder)
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	CloudAssemblyBuilder() Initializes a cloud assembly builder.
protected	CloudAssemblyBuilder(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CloudAssemblyBuilder(software.amazon.jsii.JsiiObjectRef objRef)
	CloudAssemblyBuilder(String outdir) Initializes a cloud assembly builder.
	CloudAssemblyBuilder(String outdir, CloudAssemblyBuilderProps props) Initializes a cloud assembly builder.

Method Summary

Modifier and Type	Method and Description
void	addArtifact(String id, ArtifactManifest manifest) Adds an artifact into the cloud assembly.
void	addMissing(MissingContext missing) Reports that some context is missing in order for this cloud assembly to be fully synthesized.
CloudAssembly	buildAssembly() Finalizes the cloud assembly into the output directory returns a `CloudAssembly` object that can be used to inspect the assembly.
CloudAssembly	buildAssembly(AssemblyBuildOptions options) Finalizes the cloud assembly into the output directory returns a `CloudAssembly` object that can be used to inspect the assembly.
CloudAssemblyBuilder	createNestedAssembly(String artifactId, String displayName) Creates a nested cloud assembly.
String	getAssetOutdir() The directory where assets of this Cloud Assembly should be stored.
String	getOutdir() The root directory of the resulting cloud assembly.

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

CloudAssemblyBuilder

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

CloudAssemblyBuilder

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

CloudAssemblyBuilder

@Stability(value=Stable)
public CloudAssemblyBuilder(@Nullable
                                                     String outdir,
                                                     @Nullable
                                                     CloudAssemblyBuilderProps props)

Initializes a cloud assembly builder.

Parameters:

outdir - The output directory, uses temporary directory if undefined.

props -

CloudAssemblyBuilder

@Stability(value=Stable)
public CloudAssemblyBuilder(@Nullable
                                                     String outdir)

Initializes a cloud assembly builder.

Parameters:

outdir - The output directory, uses temporary directory if undefined.

CloudAssemblyBuilder

@Stability(value=Stable)
public CloudAssemblyBuilder()

Initializes a cloud assembly builder.

Method Detail

addArtifact

@Stability(value=Stable)
public void addArtifact(@NotNull
                                                 String id,
                                                 @NotNull
                                                 ArtifactManifest manifest)

Adds an artifact into the cloud assembly.

Parameters:

id - The ID of the artifact. This parameter is required.

manifest - The artifact manifest. This parameter is required.

addMissing

@Stability(value=Stable)
public void addMissing(@NotNull
                                                MissingContext missing)

Reports that some context is missing in order for this cloud assembly to be fully synthesized.

Parameters:

missing - Missing context information. This parameter is required.

buildAssembly

@Stability(value=Stable)
 @NotNull
public CloudAssembly buildAssembly(@Nullable
                                                                      AssemblyBuildOptions options)

Finalizes the cloud assembly into the output directory returns a `CloudAssembly` object that can be used to inspect the assembly.

Parameters:

options -

buildAssembly

@Stability(value=Stable)
 @NotNull
public CloudAssembly buildAssembly()

Finalizes the cloud assembly into the output directory returns a `CloudAssembly` object that can be used to inspect the assembly.

createNestedAssembly

@Stability(value=Stable)
 @NotNull
public CloudAssemblyBuilder createNestedAssembly(@NotNull
                                                                                    String artifactId,
                                                                                    @NotNull
                                                                                    String displayName)

Creates a nested cloud assembly.

Parameters:

artifactId - This parameter is required.

displayName - This parameter is required.

getAssetOutdir

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

The directory where assets of this Cloud Assembly should be stored.

getOutdir

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

The root directory of the resulting cloud assembly.