interface ArtifactManifest
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CloudAssembly.Schema.ArtifactManifest |
 Java | software.amazon.awscdk.cloudassembly.schema.ArtifactManifest |
 Python | aws_cdk.cloud_assembly_schema.ArtifactManifest |
 TypeScript | @aws-cdk/cloud-assembly-schema » ArtifactManifest |
A manifest for a single artifact within the cloud assembly.
Properties
| Name | Type | Description |
|---|---|---|
| type | Artifact | The type of artifact. |
| additional | string | A file with additional metadata entries. |
| dependencies? | string[] | IDs of artifacts that must be deployed before this artifact. |
| display | string | A string that can be shown to a user to uniquely identify this artifact inside a cloud assembly tree. |
| environment? | string | The environment into which this artifact is deployed. |
| metadata? | { [string]: Metadata[] } | Associated metadata. |
| properties? | Aws | Asset | Tree | Nested | Feature | The set of properties for this artifact (depends on type). |
type
Type:
Artifact
The type of artifact.
additionalMetadataFile?
Type:
string
(optional, default: no additional metadata)
A file with additional metadata entries.
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.
dependencies?
Type:
string[]
(optional, default: no dependencies.)
IDs of artifacts that must be deployed before this artifact.
displayName?
Type:
string
(optional, default: no display name)
A string that can be shown to a user to uniquely identify this artifact inside a cloud assembly tree.
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.
environment?
Type:
string
(optional, default: no envrionment.)
The environment into which this artifact is deployed.
metadata?
Type:
{ [string]: Metadata[] }
(optional, default: no metadata.)
Associated metadata.
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).
properties?
Type:
Aws | Asset | Tree | Nested | Feature
(optional, default: no properties.)
The set of properties for this artifact (depends on type).