AssemblyManifest Struct
A manifest which describes the cloud assembly.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
declare const assumeRoleAdditionalOptions: any;
const assemblyManifest: cloud_assembly_schema.AssemblyManifest = {
version: 'version',
// the properties below are optional
artifacts: {
artifactsKey: {
type: cloud_assembly_schema.ArtifactType.NONE,
// the properties below are optional
additionalMetadataFile: 'additionalMetadataFile',
dependencies: ['dependencies'],
displayName: 'displayName',
environment: 'environment',
metadata: {
metadataKey: [{
type: 'type',
// the properties below are optional
data: 'data',
trace: ['trace'],
}],
},
properties: {
templateFile: 'templateFile',
// the properties below are optional
assumeRoleAdditionalOptions: {
assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
},
assumeRoleArn: 'assumeRoleArn',
assumeRoleExternalId: 'assumeRoleExternalId',
bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',
lookupRole: {
arn: 'arn',
// the properties below are optional
assumeRoleAdditionalOptions: {
assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
},
assumeRoleExternalId: 'assumeRoleExternalId',
bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
requiresBootstrapStackVersion: 123,
},
notificationArns: ['notificationArns'],
parameters: {
parametersKey: 'parameters',
},
requiresBootstrapStackVersion: 123,
stackName: 'stackName',
stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',
tags: {
tagsKey: 'tags',
},
terminationProtection: false,
validateOnSynth: false,
},
},
},
minimumCliVersion: 'minimumCliVersion',
missing: [{
key: 'key',
props: {
account: 'account',
filters: {
filtersKey: ['filters'],
},
region: 'region',
// the properties below are optional
assumeRoleAdditionalOptions: {
assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
},
lookupRoleArn: 'lookupRoleArn',
lookupRoleExternalId: 'lookupRoleExternalId',
owners: ['owners'],
},
provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,
}],
runtime: {
libraries: {
librariesKey: 'libraries',
},
},
};
Properties
artifacts{ [key: string]: ArtifactManifest }artifactstyping.Mapping[str, ArtifactManifest]artifactsMap<String, ArtifactManifest>ArtifactsIDictionary<string, ArtifactManifest>Artifacts*map[string]ArtifactManifest= no artifacts.#The set of artifacts in this assembly.
minimumCliVersionstringminimum_cli_versionstrminimumCliVersionStringMinimumCliVersionstringMinimumCliVersion*string= Minimum CLI version unknown#Required CLI version, if available.
If the manifest producer knows, it can put the minimum version of the CLI here that supports reading this assembly.
If set, it can be used to show a more informative error message to users.
missingMissingContext[]missingtyping.List[MissingContext]missingList<MissingContext>MissingMissingContext[]Missing*[]MissingContext= no missing context.#Missing context information.
If this field has values, it means that the cloud assembly is not complete and should not be deployed.
runtimeRuntimeInforuntimeRuntimeInforuntimeRuntimeInfoRuntimeRuntimeInfoRuntimeRuntimeInfo= no info.#Runtime information.
Protocol version.