interface AssetManifest

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

Obtainable from Manifest.loadAssetManifest()

Definitions for the asset manifest.

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 assetManifest: cloud_assembly_schema.AssetManifest = {
  version: 'version',

  // the properties below are optional
  dockerImages: {
    dockerImagesKey: {
      destinations: {
        destinationsKey: {
          imageTag: 'imageTag',
          repositoryName: 'repositoryName',

          // the properties below are optional
          assumeRoleAdditionalOptions: {
            assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
          },
          assumeRoleArn: 'assumeRoleArn',
          assumeRoleExternalId: 'assumeRoleExternalId',
          region: 'region',
        },
      },
      source: {
        cacheDisabled: false,
        cacheFrom: [{
          type: 'type',

          // the properties below are optional
          params: {
            paramsKey: 'params',
          },
        }],
        cacheTo: {
          type: 'type',

          // the properties below are optional
          params: {
            paramsKey: 'params',
          },
        },
        directory: 'directory',
        dockerBuildArgs: {
          dockerBuildArgsKey: 'dockerBuildArgs',
        },
        dockerBuildSecrets: {
          dockerBuildSecretsKey: 'dockerBuildSecrets',
        },
        dockerBuildSsh: 'dockerBuildSsh',
        dockerBuildTarget: 'dockerBuildTarget',
        dockerFile: 'dockerFile',
        dockerOutputs: ['dockerOutputs'],
        executable: ['executable'],
        networkMode: 'networkMode',
        platform: 'platform',
      },

      // the properties below are optional
      displayName: 'displayName',
    },
  },
  files: {
    filesKey: {
      destinations: {
        destinationsKey: {
          bucketName: 'bucketName',
          objectKey: 'objectKey',

          // the properties below are optional
          assumeRoleAdditionalOptions: {
            assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
          },
          assumeRoleArn: 'assumeRoleArn',
          assumeRoleExternalId: 'assumeRoleExternalId',
          region: 'region',
        },
      },
      source: {
        executable: ['executable'],
        packaging: cloud_assembly_schema.FileAssetPackaging.FILE,
        path: 'path',
      },

      // the properties below are optional
      displayName: 'displayName',
    },
  },
};

Properties

Name	Type	Description
version	string	Version of the manifest.
dockerImages?	{ [string]: DockerImageAsset }	The Docker image assets in this manifest.
files?	{ [string]: FileAsset }	The file assets in this manifest.

---

version

Type: string

Version of the manifest.

---

dockerImages?

Type: { [string]: DockerImageAsset } (optional, default: No Docker images)

The Docker image assets in this manifest.

---

files?

Type: { [string]: FileAsset } (optional, default: No files)

The file assets in this manifest.