# AssemblyManifest

A manifest which describes the cloud assembly.

- 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#L125)
- Type last changed: v2.174.0 · 4 Jan 2025

## 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](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.ArtifactManifest.html) } — The set of artifacts in this assembly.

  **Default:** no artifacts.

- `minimumCliVersion`: string — Required CLI version, if available.

  **Default:** Minimum CLI version unknown

  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.

- `missing`: [MissingContext](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.MissingContext.html)[] — Missing context information.

  **Default:** no missing context.

  If this field has values, it means that the
  cloud assembly is not complete and should not be deployed.

- `runtime`: [RuntimeInfo](/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.RuntimeInfo.html) — Runtime information.

  **Default:** no info.

- `version`: string (required) — Protocol version.