AWS CDK Reference

Appearance

v2.275.0

DockerImageAsset Struct ​

A file asset.

Source
node_modules/@aws-cdk/cloud-assembly-schema/lib/assets/docker-image-asset.d.ts
Type last changed
v2.187.0 · 31 Mar 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 dockerImageAsset: cloud_assembly_schema.DockerImageAsset = {
  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',
};

Properties ​

destinations{ [key: string]: DockerImageDestination }destinationstyping.Mapping[str, DockerImageDestination]destinationsMap<String, DockerImageDestination>DestinationsIDictionary<string, DockerImageDestination>Destinations*map[string]DockerImageDestinationrequired#
Destinations for this container asset.
displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#
A display name for this asset.

Default: The identifier will be used as the display name

sourceDockerImageSourcesourceDockerImageSourcesourceDockerImageSourceSourceDockerImageSourceSourceDockerImageSourcerequired#
Source description for container assets.