ArtifactManifest Struct
A manifest for a single artifact within the cloud assembly.
Example
// 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 artifactManifest: cloud_assembly_schema.ArtifactManifest = {
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,
},
};
Properties
additionalMetadataFilestringadditional_metadata_filestradditionalMetadataFileStringAdditionalMetadataFilestringAdditionalMetadataFile*string#Default: no additional metadata
The schema of this file is exactly the same as the type of the metadata field. In other words, that file contains an object mapping construct paths to arrays of metadata entries.
dependenciesstring[]dependenciestyping.List[str]dependenciesList<String>Dependenciesstring[]Dependencies*[]*string#Default: no dependencies.
Default: no display name
notes
Is used by the CLI to present a list of stacks to the user in a way that makes sense to them. Even though the property name "display name" doesn't imply it, this field is used to select stacks as well, so all stacks should have a unique display name.
Default: no envrionment.
metadata{ [key: string]: MetadataEntry[] }metadatatyping.Mapping[str, typing.List[MetadataEntry]]metadataMap<String, List<MetadataEntry>>MetadataIDictionary<string, MetadataEntry[]>Metadata*map[string]*[]MetadataEntry#Default: no metadata.
notes
Metadata can be stored directly in the assembly manifest, as well as in a separate file (see additionalMetadataFile). It should prefer to be stored in the additional file, as that will reduce the size of the assembly manifest in cases of a lot of metdata (which CDK does emit by default).
propertiesAwsCloudFormationStackProperties | AssetManifestProperties | TreeArtifactProperties | NestedCloudAssemblyProperties | FeatureFlagReportPropertiespropertiestyping.Union[AwsCloudFormationStackProperties, AssetManifestProperties, TreeArtifactProperties, NestedCloudAssemblyProperties, FeatureFlagReportProperties]propertiesAwsCloudFormationStackPropertiesPropertiesAwsCloudFormationStackPropertiesPropertiesinterface{}#Default: no properties.