CloudAssemblyBuilder Class
Can be used to build a cloud assembly.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cx_api } from 'aws-cdk-lib';
declare const cloudAssemblyBuilder_: cx_api.CloudAssemblyBuilder;
const cloudAssemblyBuilder = new cx_api.CloudAssemblyBuilder(/* all optional props */ 'outdir', /* all optional props */ {
assetOutdir: 'assetOutdir',
parentBuilder: cloudAssemblyBuilder_,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import cx_api
# cloud_assembly_builder_: cx_api.CloudAssemblyBuilder
cloud_assembly_builder = cx_api.CloudAssemblyBuilder("outdir",
asset_outdir="assetOutdir",
parent_builder=cloud_assembly_builder_
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CXAPI;
CloudAssemblyBuilder cloudAssemblyBuilder_;
var cloudAssemblyBuilder = new CloudAssemblyBuilder("outdir", new CloudAssemblyBuilderProps {
AssetOutdir = "assetOutdir",
ParentBuilder = cloudAssemblyBuilder_
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var cloudAssemblyBuilder_ CloudAssemblyBuilder
cloudAssemblyBuilder := awscdk.Cx_api.NewCloudAssemblyBuilder(jsii.String("outdir"), &CloudAssemblyBuilderProps{
AssetOutdir: jsii.String("assetOutdir"),
ParentBuilder: cloudAssemblyBuilder_,
})
Initializer
ts
new CloudAssemblyBuilder(outdir?: string, props?: CloudAssemblyBuilderProps)
python
CloudAssemblyBuilder(outdir: typing.Optional[str] = None, props: typing.Optional[CloudAssemblyBuilderProps] = None)
java
new CloudAssemblyBuilder(String outdir, CloudAssemblyBuilderProps props)
csharp
new CloudAssemblyBuilder(string? outdir = null, CloudAssemblyBuilderProps? props = null)
go
NewCloudAssemblyBuilder(Outdir *string, Props CloudAssemblyBuilderProps)
Properties
Methods
addArtifact(id: string, manifest: ArtifactManifest): voiddef add_artifact(self, id: str, manifest: ArtifactManifest) -> Nonepublic void addArtifact(String id, ArtifactManifest manifest)public void AddArtifact(string id, ArtifactManifest manifest)func AddArtifact(Id *string, Manifest ArtifactManifest)#Adds an artifact into the cloud assembly.
2 parameters
Parameters
ididididId— - The ID of the artifact.manifestmanifestmanifestmanifestManifest— - The artifact manifest.
addMissing(missing: MissingContext): voiddef add_missing(self, missing: MissingContext) -> Nonepublic void addMissing(MissingContext missing)public void AddMissing(MissingContext missing)func AddMissing(Missing MissingContext)#Reports that some context is missing in order for this cloud assembly to be fully synthesized.
1 parameter
Parameters
missingmissingmissingmissingMissing— - Missing context information.
buildAssembly(options?: AssemblyBuildOptions): CloudAssemblydef build_assembly(self, options: typing.Optional[AssemblyBuildOptions] = None) -> CloudAssemblypublic CloudAssembly buildAssembly(AssemblyBuildOptions options)public CloudAssembly BuildAssembly(AssemblyBuildOptions? options = null)func BuildAssembly(Options AssemblyBuildOptions) CloudAssembly#Finalizes the cloud assembly into the output directory returns a `CloudAssembly` object that can be used to inspect the assembly.
createNestedAssembly(artifactId: string, displayName: string): CloudAssemblyBuilder // chainabledef create_nested_assembly(self, artifact_id: str, display_name: str) -> CloudAssemblyBuilderpublic CloudAssemblyBuilder createNestedAssembly(String artifactId, String displayName)public CloudAssemblyBuilder CreateNestedAssembly(string artifactId, string displayName)func CreateNestedAssembly(ArtifactId *string, DisplayName *string) CloudAssemblyBuilder#Creates a nested cloud assembly.
Delete the cloud assembly directory.