AWS CDK Reference

Appearance

v2.275.0

AssetManifest Struct ​

Definitions for the asset manifest.

Source
node_modules/@aws-cdk/cloud-assembly-schema/lib/assets/schema.d.ts

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 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',
        },
        dockerBuildContexts: {
          dockerBuildContextsKey: 'dockerBuildContexts',
        },
        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 ​

dockerImagesoptional{ [key: string]: DockerImageAsset }docker_imagesoptionaltyping.Mapping[str, DockerImageAsset]dockerImagesoptionalMap<String, DockerImageAsset>DockerImagesoptionalIDictionary<string, DockerImageAsset>DockerImagesoptional*map[string]DockerImageAsset#
The Docker image assets in this manifest.

Default: No Docker images

filesoptional{ [key: string]: FileAsset }filesoptionaltyping.Mapping[str, FileAsset]filesoptionalMap<String, FileAsset>FilesoptionalIDictionary<string, FileAsset>Filesoptional*map[string]FileAsset#
The file assets in this manifest.

Default: No files

versionstringversionstrversionStringVersionstringVersion*stringrequired#
Version of the manifest.