Class CloudAssembly

Represents a deployable cloud application.

Inheritance

System.Object

CloudAssembly

Namespace: Amazon.CDK.CXAPI

Assembly: Amazon.CDK.CXAPI.dll

Syntax (csharp)

public class CloudAssembly : DeputyBase

Syntax (vb)

Public Class CloudAssembly
    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;

var cloudAssembly = new CloudAssembly("directory", new LoadManifestOptions {
    SkipEnumCheck = false,
    SkipVersionCheck = false
});

Synopsis

Constructors

CloudAssembly(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CloudAssembly(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CloudAssembly(String, ILoadManifestOptions)	Reads a cloud assembly from the specified directory.

Properties

Artifacts	All artifacts included in this assembly.
Directory	The root directory of the cloud assembly.
Manifest	The raw assembly manifest.
NestedAssemblies	The nested assembly artifacts in this assembly.
Runtime	Runtime information such as module versions used to synthesize this assembly.
Stacks
StacksRecursively	Returns all the stacks, including the ones in nested assemblies.
Version	The schema version of the assembly manifest.

Methods

GetNestedAssembly(String)	Returns a nested assembly.
GetNestedAssemblyArtifact(String)	Returns a nested assembly artifact.
GetStack(String)	(deprecated) Returns a CloudFormation stack artifact by name from this assembly.
GetStackArtifact(String)	Returns a CloudFormation stack artifact from this assembly.
GetStackByName(String)	Returns a CloudFormation stack artifact from this assembly.
Tree()	Returns the tree metadata artifact from this assembly.
TryGetArtifact(String)	Attempts to find an artifact with a specific identity.

Constructors

CloudAssembly(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CloudAssembly(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CloudAssembly(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CloudAssembly(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CloudAssembly(String, ILoadManifestOptions)

Reads a cloud assembly from the specified directory.

public CloudAssembly(string directory, ILoadManifestOptions loadOptions = null)

Parameters

directory System.String

The root directory of the assembly.

loadOptions ILoadManifestOptions

The root directory of the assembly.

Properties

Artifacts

All artifacts included in this assembly.

public virtual CloudArtifact[] Artifacts { get; }

Property Value

CloudArtifact[]

Directory

The root directory of the cloud assembly.

public virtual string Directory { get; }

Property Value

System.String

Manifest

The raw assembly manifest.

public virtual IAssemblyManifest Manifest { get; }

Property Value

IAssemblyManifest

NestedAssemblies

The nested assembly artifacts in this assembly.

public virtual NestedCloudAssemblyArtifact[] NestedAssemblies { get; }

Property Value

NestedCloudAssemblyArtifact[]

Runtime

Runtime information such as module versions used to synthesize this assembly.

public virtual IRuntimeInfo Runtime { get; }

Property Value

IRuntimeInfo

Stacks

public virtual CloudFormationStackArtifact[] Stacks { get; }

Property Value

CloudFormationStackArtifact[]

all the CloudFormation stack artifacts that are included in this assembly.

StacksRecursively

Returns all the stacks, including the ones in nested assemblies.

public virtual CloudFormationStackArtifact[] StacksRecursively { get; }

Property Value

CloudFormationStackArtifact[]

Version

The schema version of the assembly manifest.

public virtual string Version { get; }

Property Value

System.String

Methods

GetNestedAssembly(String)

Returns a nested assembly.

public virtual CloudAssembly GetNestedAssembly(string artifactId)

Parameters

artifactId System.String

The artifact ID of the nested assembly.

Returns

CloudAssembly

GetNestedAssemblyArtifact(String)

Returns a nested assembly artifact.

public virtual NestedCloudAssemblyArtifact GetNestedAssemblyArtifact(string artifactId)

Parameters

artifactId System.String

The artifact ID of the nested assembly.

Returns

NestedCloudAssemblyArtifact

GetStack(String)

(deprecated) Returns a CloudFormation stack artifact by name from this assembly.

public virtual CloudFormationStackArtifact GetStack(string stackName)

Parameters

stackName System.String

Returns

CloudFormationStackArtifact

Remarks

Stability: Deprecated

GetStackArtifact(String)

Returns a CloudFormation stack artifact from this assembly.

public virtual CloudFormationStackArtifact GetStackArtifact(string artifactId)

Parameters

artifactId System.String

the artifact id of the stack (can be obtained through stack.artifactId).

Returns

CloudFormationStackArtifact

a CloudFormationStackArtifact object.

Remarks

Throws: if there is no stack artifact with that id

GetStackByName(String)

Returns a CloudFormation stack artifact from this assembly.

public virtual CloudFormationStackArtifact GetStackByName(string stackName)

Parameters

stackName System.String

the name of the CloudFormation stack.

Returns

CloudFormationStackArtifact

a CloudFormationStackArtifact object.

Remarks

Will only search the current assembly.

Throws: if there is more than one stack with the same stack name. You can use getStackArtifact(stack.artifactId) instead.

Tree()

Returns the tree metadata artifact from this assembly.

public virtual TreeCloudArtifact Tree()

Returns

TreeCloudArtifact

a TreeCloudArtifact object if there is one defined in the manifest, undefined otherwise.

Remarks

Throws: if there is no metadata artifact by that name

TryGetArtifact(String)

Attempts to find an artifact with a specific identity.

public virtual CloudArtifact TryGetArtifact(string id)

Parameters

id System.String

The artifact ID.

Returns

CloudArtifact

A CloudArtifact object or undefined if the artifact does not exist in this assembly.