interface ArtifactManifest

Language	Type name
.NET	Amazon.CDK.cloud_assembly_schema.ArtifactManifest
Go	github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#ArtifactManifest
Java	software.amazon.awscdk.cloud_assembly_schema.ArtifactManifest
Python	aws_cdk.cloud_assembly_schema.ArtifactManifest
TypeScript (source)	aws-cdk-lib » cloud_assembly_schema » ArtifactManifest

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

Name	Type	Description
type	ArtifactType	The type of artifact.
additionalMetadataFile?	string	A file with additional metadata entries.
dependencies?	string[]	IDs of artifacts that must be deployed before this artifact.
displayName?	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]: MetadataEntry[] }	Associated metadata.
properties?	AwsCloudFormationStackProperties | AssetManifestProperties | TreeArtifactProperties | NestedCloudAssemblyProperties | FeatureFlagReportProperties	The set of properties for this artifact (depends on type).

---

type

Type: ArtifactType

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]: MetadataEntry[] } (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: AwsCloudFormationStackProperties | AssetManifestProperties | TreeArtifactProperties | NestedCloudAssemblyProperties | FeatureFlagReportProperties (optional, default: no properties.)

The set of properties for this artifact (depends on type).