software.amazon.awscdk

Interface AssetOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AssetOptions, AssetProps, AssetStagingProps, InitFileAssetOptions, InitSourceAssetOptions

All Known Implementing Classes:

AssetOptions.Jsii$Proxy, AssetOptions.Jsii$Proxy, AssetProps.Jsii$Proxy, AssetStagingProps.Jsii$Proxy, InitFileAssetOptions.Jsii$Proxy, InitSourceAssetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:42.409Z")
 @Stability(value=Experimental)
public interface AssetOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Asset hash options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AssetOptions.Builder	builder()
default String	getAssetHash() (experimental) Specify a custom hash for this asset.
default AssetHashType	getAssetHashType() (experimental) Specifies the type of hash to calculate for this asset.
default BundlingOptions	getBundling() (experimental) Bundle the asset by executing a command in a Docker container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAssetHash

@Stability(value=Experimental)
 @Nullable
default String getAssetHash()

(experimental) Specify a custom hash for this asset.

If assetHashType is set it must be set to AssetHashType.CUSTOM. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.

Default: - based on `assetHashType`

getAssetHashType

@Stability(value=Experimental)
 @Nullable
default AssetHashType getAssetHashType()

(experimental) Specifies the type of hash to calculate for this asset.

If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM.

Default: - the default is `AssetHashType.SOURCE`, but if `assetHash` is explicitly specified this value defaults to `AssetHashType.CUSTOM`.

getBundling

@Stability(value=Experimental)
 @Nullable
default BundlingOptions getBundling()

(experimental) Bundle the asset by executing a command in a Docker container.

The asset path will be mounted at /asset-input. The Docker container is responsible for putting content at /asset-output. The content at /asset-output will be zipped and used as the final asset.

Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwise

builder

@Stability(value=Experimental)
static AssetOptions.Builder builder()

Returns:

a AssetOptions.Builder of AssetOptions