# ArtifactManifest

A manifest for a single artifact within the cloud assembly.

Extends: ArtifactManifest
Used as props by: AssetManifestArtifact, CloudArtifact, CloudFormationStackArtifact, NestedCloudAssemblyArtifact, TreeCloudArtifact

- Source: [`node_modules/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/schema.d.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/node_modules/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/schema.d.ts#L64)
- Type last changed: v2.241.0 · 2 Mar 2026

## 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 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

- `additionalMetadataFile`: string — A file with additional metadata entries.

  **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.

- `dependencies`: string[] — IDs of artifacts that must be deployed before this artifact.

  **Default:** no dependencies.

- `displayName`: string — A string that can be shown to a user to uniquely identify this artifact inside a cloud assembly tree.

  **Default:** no display name

  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`: string — The environment into which this artifact is deployed.

  **Default:** no envrionment.

- `metadata`: { [key: string]: [MetadataEntry](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.MetadataEntry.html)[] } — Associated metadata.

  **Default:** no 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`: [AwsCloudFormationStackProperties](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.AwsCloudFormationStackProperties.html) | [AssetManifestProperties](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.AssetManifestProperties.html) | [TreeArtifactProperties](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.TreeArtifactProperties.html) | [NestedCloudAssemblyProperties](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.NestedCloudAssemblyProperties.html) | [FeatureFlagReportProperties](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.FeatureFlagReportProperties.html) — The set of properties for this artifact (depends on type).

  **Default:** no properties.

- `type`: [ArtifactType](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.ArtifactType.html) (required) — The type of artifact.