Class TreeCloudArtifact
Inherited Members
Namespace: Amazon.CDK.CXAPI
Assembly: Amazon.CDK.CXAPI.dll
Syntax (csharp)
public class TreeCloudArtifact : CloudArtifact
Syntax (vb)
Public Class TreeCloudArtifact
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 treeCloudArtifact = new TreeCloudArtifact(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
TreeCloudArtifact(CloudAssembly, String, IArtifactManifest) | |
TreeCloudArtifact(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
TreeCloudArtifact(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
File |
Methods
IsTreeCloudArtifact(Object) | Checks if |
Constructors
TreeCloudArtifact(CloudAssembly, String, IArtifactManifest)
public TreeCloudArtifact(CloudAssembly assembly, string name, IArtifactManifest artifact)
Parameters
- assembly CloudAssembly
- name System.String
- artifact IArtifactManifest
TreeCloudArtifact(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected TreeCloudArtifact(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
TreeCloudArtifact(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected TreeCloudArtifact(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
File
public virtual string File { get; }
Property Value
System.String
Methods
IsTreeCloudArtifact(Object)
Checks if art
is an instance of this class.
public static bool IsTreeCloudArtifact(object art)
Parameters
- art System.Object
Returns
System.Boolean
Remarks
Use this method instead of instanceof
to properly detect TreeCloudArtifact
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 TreeCloudArtifact
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.