Class NestedCloudAssemblyArtifact
Asset manifest is a description of a set of assets which need to be built and published.
Inherited Members
Namespace: Amazon.CDK.CXAPI
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class NestedCloudAssemblyArtifact : CloudArtifact
Syntax (vb)
Public Class NestedCloudAssemblyArtifact
Inherits CloudArtifact
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.CloudAssembly.Schema;
using Amazon.CDK.CXAPI;
CloudAssembly cloudAssembly;
var nestedCloudAssemblyArtifact = new NestedCloudAssemblyArtifact(cloudAssembly, "name", new ArtifactManifest {
Type = ArtifactType.NONE,
// the properties below are optional
Dependencies = new [] { "dependencies" },
DisplayName = "displayName",
Environment = "environment",
Metadata = new Dictionary<string, MetadataEntry[]> {
{ "metadataKey", new [] { new MetadataEntry {
Type = "type",
// the properties below are optional
Data = "data",
Trace = new [] { "trace" }
} } }
},
Properties = new AwsCloudFormationStackProperties {
TemplateFile = "templateFile",
// the properties below are optional
AssumeRoleArn = "assumeRoleArn",
AssumeRoleExternalId = "assumeRoleExternalId",
BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
CloudFormationExecutionRoleArn = "cloudFormationExecutionRoleArn",
LookupRole = new BootstrapRole {
Arn = "arn",
// the properties below are optional
AssumeRoleExternalId = "assumeRoleExternalId",
BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
RequiresBootstrapStackVersion = 123
},
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
RequiresBootstrapStackVersion = 123,
StackName = "stackName",
StackTemplateAssetObjectUrl = "stackTemplateAssetObjectUrl",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TerminationProtection = false,
ValidateOnSynth = false
}
});
Synopsis
Constructors
NestedCloudAssemblyArtifact(CloudAssembly, String, IArtifactManifest) | |
NestedCloudAssemblyArtifact(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
NestedCloudAssemblyArtifact(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
DirectoryName | The relative directory name of the asset manifest. |
DisplayName | Display name. |
FullPath | Full path to the nested assembly directory. |
NestedAssembly | The nested Assembly. |
Methods
IsNestedCloudAssemblyArtifact(Object) | Checks if |
Constructors
NestedCloudAssemblyArtifact(CloudAssembly, String, IArtifactManifest)
public NestedCloudAssemblyArtifact(CloudAssembly assembly, string name, IArtifactManifest artifact)
Parameters
- assembly CloudAssembly
- name System.String
- artifact IArtifactManifest
NestedCloudAssemblyArtifact(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected NestedCloudAssemblyArtifact(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
NestedCloudAssemblyArtifact(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected NestedCloudAssemblyArtifact(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
DirectoryName
The relative directory name of the asset manifest.
public virtual string DirectoryName { get; }
Property Value
System.String
DisplayName
Display name.
public virtual string DisplayName { get; }
Property Value
System.String
FullPath
Full path to the nested assembly directory.
public virtual string FullPath { get; }
Property Value
System.String
NestedAssembly
The nested Assembly.
public virtual CloudAssembly NestedAssembly { get; }
Property Value
Methods
IsNestedCloudAssemblyArtifact(Object)
Checks if art
is an instance of this class.
public static bool IsNestedCloudAssemblyArtifact(object art)
Parameters
- art System.Object
Returns
System.Boolean
Remarks
Use this method instead of instanceof
to properly detect NestedCloudAssemblyArtifact
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the cx-api
library on
disk are seen as independent, completely different libraries. As a
consequence, the class NestedCloudAssemblyArtifact
in each copy of the cx-api
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the cx-api
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.