Package software.amazon.awscdk

Interface FileAssetSource

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FileAssetSource.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:30.986Z")
@Stability(Stable)
public interface FileAssetSource
extends software.amazon.jsii.JsiiSerializable

Represents the source for a file asset.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 FileAssetSource fileAssetSource = FileAssetSource.builder()
         .sourceHash("sourceHash")
         // the properties below are optional
         .deployTime(false)
         .displayName("displayName")
         .executable(List.of("executable"))
         .fileName("fileName")
         .packaging(FileAssetPackaging.ZIP_DIRECTORY)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FileAssetSource.Builder	A builder for FileAssetSource
static final class	FileAssetSource.Jsii$Proxy	An implementation for FileAssetSource

Method Summary

Modifier and Type	Method	Description
static FileAssetSource.Builder	builder()
default Boolean	getDeployTime()	Whether or not the asset needs to exist beyond deployment time;
default String	getDisplayName()	A display name for this asset.
default List<String>	getExecutable()	An external command that will produce the packaged asset.
default String	getFileName()	The path, relative to the root of the cloud assembly, in which this asset source resides.
default FileAssetPackaging	getPackaging()	Which type of packaging to perform.
String	getSourceHash()	A hash on the content source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSourceHash

@Stability(Stable)
@NotNull
String getSourceHash()

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.

getDeployTime

@Stability(Stable)
@Nullable
default Boolean getDeployTime()

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

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.

Default: false

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

A display name for this asset.

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

Default: - The asset hash is used to display the asset

getExecutable

@Stability(Stable)
@Nullable
default List<String> getExecutable()

An external command that will produce the packaged asset.

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

Default: - Exactly one of `fileName` and `executable` is required

getFileName

@Stability(Stable)
@Nullable
default String getFileName()

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

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

Default: - Exactly one of `fileName` and `executable` is required

getPackaging

@Stability(Stable)
@Nullable
default FileAssetPackaging getPackaging()

Which type of packaging to perform.

Default: - Required if `fileName` is specified.

builder

@Stability(Stable)
static FileAssetSource.Builder builder()

Returns:

a FileAssetSource.Builder of FileAssetSource