Package software.amazon.awscdk.core
Interface FileAssetSource
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
FileAssetSource.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:29:55.037Z")
@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.core.*; FileAssetSource fileAssetSource = FileAssetSource.builder() .sourceHash("sourceHash") // the properties below are optional .executable(List.of("executable")) .fileName("fileName") .packaging(FileAssetPackaging.ZIP_DIRECTORY) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forFileAssetSource
static final class
An implementation forFileAssetSource
-
Method Summary
Modifier and TypeMethodDescriptionstatic FileAssetSource.Builder
builder()
An external command that will produce the packaged asset.default String
The path, relative to the root of the cloud assembly, in which this asset source resides.default FileAssetPackaging
Which type of packaging to perform.A hash on the content source.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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.
-
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 `directory` and `executable` is required
-
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 `directory` and `executable` is required
-
getPackaging
Which type of packaging to perform.Default: - Required if `fileName` is specified.
-
builder
- Returns:
- a
FileAssetSource.Builder
ofFileAssetSource
-