aws-cdk-lib.FileAssetSource

FileAssetSource Struct

Represents the source for a file asset.

Source

core/lib/assets.ts

Type last changed

v2.187.0 · 31 Mar 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const fileAssetSource: cdk.FileAssetSource = {
  sourceHash: 'sourceHash',

  // the properties below are optional
  deployTime: false,
  displayName: 'displayName',
  executable: ['executable'],
  fileName: 'fileName',
  packaging: cdk.FileAssetPackaging.ZIP_DIRECTORY,
};

Properties

deployTimebooleandeploy_timebooldeployTimeBooleanDeployTimeboolDeployTime*bool= false#

Whether or not the asset needs to exist beyond deployment time;

notes

i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds.

For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets.

displayNamestringdisplay_namestrdisplayNameStringDisplayNamestringDisplayName*string#

A display name for this asset.

Default: The asset hash is used to display the asset

If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information.

executablestring[]executabletyping.List[str]executableList<String>Executablestring[]Executable*[]*string#

An external command that will produce the packaged asset.

Default: Exactly one of fileName and executable is required

The command should produce the location of a ZIP file on stdout.

fileNamestringfile_namestrfileNameStringFileNamestringFileName*string#

The path, relative to the root of the cloud assembly, in which this asset source resides.

Default: Exactly one of fileName and executable is required

This can be a path to a file or a directory, depending on the packaging type.

packagingFileAssetPackagingpackagingFileAssetPackagingpackagingFileAssetPackagingPackagingFileAssetPackagingPackagingFileAssetPackaging#

Which type of packaging to perform.

Default: Required if fileName is specified.

sourceHashstringsource_hashstrsourceHashStringSourceHashstringSourceHash*stringrequired#

A hash on the content source.

This hash is used to uniquely identify this asset throughout the system. If this value doesn't change, the asset will not be rebuilt or republished.