class CloudAssemblyBuilder
Language | Type name |
---|---|
![]() | Amazon.CDK.CXAPI.CloudAssemblyBuilder |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/cxapi#CloudAssemblyBuilder |
![]() | software.amazon.awscdk.cxapi.CloudAssemblyBuilder |
![]() | aws_cdk.cx_api.CloudAssemblyBuilder |
![]() | aws-cdk-lib » cx_api » CloudAssemblyBuilder |
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 { 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_,
});
Initializer
new CloudAssemblyBuilder(outdir?: string, props?: CloudAssemblyBuilderProps)
Parameters
- outdir
string
— The output directory, uses temporary directory if undefined. - props
Cloud
Assembly Builder Props
Initializes a cloud assembly builder.
Properties
Name | Type | Description |
---|---|---|
asset | string | The directory where assets of this Cloud Assembly should be stored. |
outdir | string | The root directory of the resulting cloud assembly. |
assetOutdir
Type:
string
The directory where assets of this Cloud Assembly should be stored.
outdir
Type:
string
The root directory of the resulting cloud assembly.
Methods
Name | Description |
---|---|
add | Adds an artifact into the cloud assembly. |
add | Reports that some context is missing in order for this cloud assembly to be fully synthesized. |
build | Finalizes the cloud assembly into the output directory returns a CloudAssembly object that can be used to inspect the assembly. |
create | Creates a nested cloud assembly. |
delete() | Delete the cloud assembly directory. |
addArtifact(id, manifest)
public addArtifact(id: string, manifest: ArtifactManifest): void
Parameters
- id
string
— The ID of the artifact. - manifest
Artifact
— The artifact manifest.Manifest
Adds an artifact into the cloud assembly.
addMissing(missing)
public addMissing(missing: MissingContext): void
Parameters
- missing
Missing
— Missing context information.Context
Reports that some context is missing in order for this cloud assembly to be fully synthesized.
buildAssembly(options?)
public buildAssembly(options?: AssemblyBuildOptions): CloudAssembly
Parameters
- options
Assembly
Build Options
Returns
Finalizes the cloud assembly into the output directory returns a CloudAssembly
object that can be used to inspect the assembly.
createNestedAssembly(artifactId, displayName)
public createNestedAssembly(artifactId: string, displayName: string): CloudAssemblyBuilder
Parameters
- artifactId
string
- displayName
string
Returns
Creates a nested cloud assembly.
delete()
public delete(): void
Delete the cloud assembly directory.