Class CloudAssemblyBuilder
Can be used to build a cloud assembly.
Inheritance
Namespace: Amazon.CDK.CXAPI
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CloudAssemblyBuilder : DeputyBase
Syntax (vb)
Public Class CloudAssemblyBuilder
Inherits DeputyBase
Remarks
ExampleMetadata: fixture=_generated
Examples
// 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_
});
Synopsis
Constructors
CloudAssemblyBuilder(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CloudAssemblyBuilder(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CloudAssemblyBuilder(String, ICloudAssemblyBuilderProps) | Initializes a cloud assembly builder. |
Properties
AssetOutdir | The directory where assets of this Cloud Assembly should be stored. |
Outdir | The root directory of the resulting cloud assembly. |
Methods
AddArtifact(String, IArtifactManifest) | Adds an artifact into the cloud assembly. |
AddMissing(IMissingContext) | Reports that some context is missing in order for this cloud assembly to be fully synthesized. |
BuildAssembly(IAssemblyBuildOptions) | Finalizes the cloud assembly into the output directory returns a |
CreateNestedAssembly(String, String) | Creates a nested cloud assembly. |
Delete() | Delete the cloud assembly directory. |
Constructors
CloudAssemblyBuilder(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CloudAssemblyBuilder(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CloudAssemblyBuilder(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CloudAssemblyBuilder(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CloudAssemblyBuilder(String, ICloudAssemblyBuilderProps)
Initializes a cloud assembly builder.
public CloudAssemblyBuilder(string outdir = null, ICloudAssemblyBuilderProps props = null)
Parameters
- outdir System.String
The output directory, uses temporary directory if undefined.
- props ICloudAssemblyBuilderProps
The output directory, uses temporary directory if undefined.
Properties
AssetOutdir
The directory where assets of this Cloud Assembly should be stored.
public virtual string AssetOutdir { get; }
Property Value
System.String
Outdir
The root directory of the resulting cloud assembly.
public virtual string Outdir { get; }
Property Value
System.String
Methods
AddArtifact(String, IArtifactManifest)
Adds an artifact into the cloud assembly.
public virtual void AddArtifact(string id, IArtifactManifest manifest)
Parameters
- id System.String
The ID of the artifact.
- manifest IArtifactManifest
The artifact manifest.
AddMissing(IMissingContext)
Reports that some context is missing in order for this cloud assembly to be fully synthesized.
public virtual void AddMissing(IMissingContext missing)
Parameters
- missing IMissingContext
Missing context information.
BuildAssembly(IAssemblyBuildOptions)
Finalizes the cloud assembly into the output directory returns a CloudAssembly
object that can be used to inspect the assembly.
public virtual CloudAssembly BuildAssembly(IAssemblyBuildOptions options = null)
Parameters
- options IAssemblyBuildOptions
Returns
CreateNestedAssembly(String, String)
Creates a nested cloud assembly.
public virtual CloudAssemblyBuilder CreateNestedAssembly(string artifactId, string displayName)
Parameters
- artifactId System.String
- displayName System.String
Returns
Delete()
Delete the cloud assembly directory.
public virtual void Delete()