Interface IBundlingOptions
(experimental) Options for bundling.
Namespace: Amazon.CDK.AWS.Lambda.Python
Assembly: Amazon.CDK.AWS.Lambda.Python.dll
Syntax (csharp)
public interface IBundlingOptions
Syntax (vb)
Public Interface IBundlingOptions
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
var entry = "/path/to/function";
var image = DockerImage.FromBuild(entry);
new PythonFunction(this, "function", new PythonFunctionProps {
Entry = entry,
Runtime = Runtime.PYTHON_3_8,
Bundling = new BundlingOptions {
BuildArgs = new Dictionary<string, string> { { "PIP_INDEX_URL", "https://your.index.url/simple/" }, { "PIP_EXTRA_INDEX_URL", "https://your.extra-index.url/simple/" } }
}
});
Synopsis
Properties
AssetHash | (experimental) Specify a custom hash for this asset. |
AssetHashType | (experimental) Determines how asset hash is calculated. Assets will get rebuild and uploaded only if their hash has changed. |
BuildArgs | (experimental) Optional build arguments to pass to the default container. |
Environment | (experimental) Environment variables defined when bundling runs. |
Image | (experimental) Docker image to use for bundling. |
OutputPathSuffix | (experimental) Output path suffix: the suffix for the directory into which the bundled output is written. |
Properties
AssetHash
(experimental) Specify a custom hash for this asset.
virtual string AssetHash { get; }
Property Value
System.String
Remarks
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
Stability: Experimental
AssetHashType
(experimental) Determines how asset hash is calculated. Assets will get rebuild and uploaded only if their hash has changed.
virtual Nullable<AssetHashType> AssetHashType { get; }
Property Value
System.Nullable<AssetHashType>
Remarks
If asset hash is set to SOURCE
(default), then only changes to the source
directory will cause the asset to rebuild. This means, for example, that in
order to pick up a new dependency version, a change must be made to the
source tree. Ideally, this can be implemented by including a dependency
lockfile in your source tree or using fixed dependencies.
If the asset hash is set to OUTPUT
, the hash is calculated after
bundling. This means that any change in the output will cause the asset to
be invalidated and uploaded. Bear in mind that pip
adds timestamps to
dependencies it installs, which implies that in this mode Python bundles
will always get rebuild and uploaded. Normally this is an anti-pattern
since build
Default: AssetHashType.SOURCE By default, hash is calculated based on the contents of the source directory. This means that only updates to the source will cause the asset to rebuild.
Stability: Experimental
BuildArgs
(experimental) Optional build arguments to pass to the default container.
virtual IDictionary<string, string> BuildArgs { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
This can be used to customize the index URLs used for installing dependencies. This is not used if a custom image is provided.
Default: - No build arguments.
Stability: Experimental
Environment
(experimental) Environment variables defined when bundling runs.
virtual IDictionary<string, string> Environment { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - no environment variables are defined.
Stability: Experimental
Image
(experimental) Docker image to use for bundling.
virtual DockerImage Image { get; }
Property Value
Remarks
If no options are provided, the default bundling image will be used. Dependencies will be installed using the default packaging commands and copied over from into the Lambda asset.
Default: - Default bundling image.
Stability: Experimental
OutputPathSuffix
(experimental) Output path suffix: the suffix for the directory into which the bundled output is written.
virtual string OutputPathSuffix { get; }
Property Value
System.String
Remarks
Default: - 'python' for a layer, empty string otherwise.
Stability: Experimental