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 (source)	@aws-cdk/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 * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';
const artifactManifest: cloud_assembly_schema.ArtifactManifest = {
  type: cloud_assembly_schema.ArtifactType.NONE,

  // the properties below are optional
  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
    assumeRoleArn: 'assumeRoleArn',
    assumeRoleExternalId: 'assumeRoleExternalId',
    bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
    cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',
    lookupRole: {
      arn: 'arn',

      // the properties below are optional
      assumeRoleExternalId: 'assumeRoleExternalId',
      bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
      requiresBootstrapStackVersion: 123,
    },
    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.
dependencies?	string[]	IDs of artifacts that must be deployed before this artifact.
displayName?	string	A string that represents this artifact.
environment?	string	The environment into which this artifact is deployed.
metadata?	{ [string]: MetadataEntry[] }	Associated metadata.
properties?	AwsCloudFormationStackProperties | AssetManifestProperties | TreeArtifactProperties | NestedCloudAssemblyProperties	The set of properties for this artifact (depends on type).

---

type

Type: ArtifactType

The type of artifact.

---

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 represents this artifact.

Should only be used in user interfaces.

---

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.

---

properties?

Type: AwsCloudFormationStackProperties | AssetManifestProperties | TreeArtifactProperties | NestedCloudAssemblyProperties (optional, default: no properties.)

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