Package 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.96.0 (build 921e240)", date="2024-04-10T22:22:36.783Z") @Stability(Stable) public class CloudAssemblyBuilder extends software.amazon.jsii.JsiiObject
Can be used to build a cloud assembly.

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.*;
 CloudAssemblyBuilder cloudAssemblyBuilder_;
 CloudAssemblyBuilder cloudAssemblyBuilder = CloudAssemblyBuilder.Builder.create("outdir")
         .assetOutdir("assetOutdir")
         .parentBuilder(cloudAssemblyBuilder_)
         .build();

  • Constructor Details

    • CloudAssemblyBuilder

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

    • CloudAssemblyBuilder

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

    • CloudAssemblyBuilder

      @Stability(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(Stable) public CloudAssemblyBuilder(@Nullable String outdir)
      Initializes a cloud assembly builder.

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

    • CloudAssemblyBuilder

      @Stability(Stable) public CloudAssemblyBuilder()
      Initializes a cloud assembly builder.

  • Method Details

    • addArtifact

      @Stability(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(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(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(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(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.

    • delete

      @Stability(Stable) public void delete()
      Delete the cloud assembly directory.

    • getAssetOutdir

      @Stability(Stable) @NotNull public String getAssetOutdir()
      The directory where assets of this Cloud Assembly should be stored.

    • getOutdir

      @Stability(Stable) @NotNull public String getOutdir()
      The root directory of the resulting cloud assembly.