Interface IArtifactManifest
A manifest for a single artifact within the cloud assembly.
Namespace: Amazon.CDK.CloudAssembly.Schema
Assembly: Amazon.CDK.CloudAssembly.Schema.dll
Syntax (csharp)
public interface IArtifactManifest
Syntax (vb)
Public Interface IArtifactManifest
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;
var artifactManifest = 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
Properties
Dependencies | IDs of artifacts that must be deployed before this artifact. |
DisplayName | A string that represents this artifact. |
Environment | The environment into which this artifact is deployed. |
Metadata | Associated metadata. |
Properties | The set of properties for this artifact (depends on type). |
Type | The type of artifact. |
Properties
Dependencies
IDs of artifacts that must be deployed before this artifact.
virtual string[] Dependencies { get; }
Property Value
System.String[]
Remarks
Default: - no dependencies.
DisplayName
A string that represents this artifact.
virtual string DisplayName { get; }
Property Value
System.String
Remarks
Should only be used in user interfaces.
Default: - no display name
Environment
The environment into which this artifact is deployed.
virtual string Environment { get; }
Property Value
System.String
Remarks
Default: - no envrionment.
Metadata
Associated metadata.
virtual IDictionary<string, IMetadataEntry[]> Metadata { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, IMetadataEntry[]>
Remarks
Default: - no metadata.
Properties
The set of properties for this artifact (depends on type).
virtual object Properties { get; }
Property Value
System.Object
Remarks
Default: - no properties.