Interface IAssemblyManifest
A manifest which describes the cloud assembly.
Namespace: Amazon.CDK.CloudAssembly.Schema
Assembly: Amazon.CDK.CloudAssembly.Schema.dll
Syntax (csharp)
public interface IAssemblyManifest
Syntax (vb)
Public Interface IAssemblyManifest
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 assemblyManifest = new AssemblyManifest {
Version = "version",
// the properties below are optional
Artifacts = new Dictionary<string, ArtifactManifest> {
{ "artifactsKey", 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
}
} }
},
Missing = new [] { new MissingContext {
Key = "key",
Props = new AmiContextQuery {
Account = "account",
Filters = new Dictionary<string, string[]> {
{ "filtersKey", new [] { "filters" } }
},
Region = "region",
// the properties below are optional
LookupRoleArn = "lookupRoleArn",
Owners = new [] { "owners" }
},
Provider = ContextProvider.AMI_PROVIDER
} },
Runtime = new RuntimeInfo {
Libraries = new Dictionary<string, string> {
{ "librariesKey", "libraries" }
}
}
};
Synopsis
Properties
Artifacts | The set of artifacts in this assembly. |
Missing | Missing context information. |
Runtime | Runtime information. |
Version | Protocol version. |
Properties
Artifacts
The set of artifacts in this assembly.
virtual IDictionary<string, IArtifactManifest> Artifacts { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, IArtifactManifest>
Remarks
Default: - no artifacts.
Missing
Missing context information.
virtual IMissingContext[] Missing { get; }
Property Value
Remarks
If this field has values, it means that the cloud assembly is not complete and should not be deployed.
Default: - no missing context.
Runtime
Runtime information.
virtual IRuntimeInfo Runtime { get; }
Property Value
Remarks
Default: - no info.
Version
Protocol version.
string Version { get; }
Property Value
System.String