Experimental
@aws-cdk/aws-lambda-python-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
BundlingOptions Struct
Options for bundling.
Example
const entry = '/path/to/function';
const image = DockerImage.fromBuild(entry);
new python.PythonFunction(this, 'function', {
entry,
runtime: Runtime.PYTHON_3_8,
bundling: {
buildArgs: { PIP_INDEX_URL: "https://your.index.url/simple/", PIP_EXTRA_INDEX_URL: "https://your.extra-index.url/simple/" },
},
});
Properties
assetExcludesstring[]asset_excludestyping.List[str]assetExcludesList<String>AssetExcludesstring[]AssetExcludes*[]*string#Default: Empty list
Default: Based on assetHashType
notes
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.
assetHashTypeAssetHashTypeasset_hash_typeAssetHashTypeassetHashTypeAssetHashTypeAssetHashTypeAssetHashTypeAssetHashTypeAssetHashType#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.
notes
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
buildArgs{ [key: string]: string }build_argstyping.Mapping[str, str]buildArgsMap<String, String>BuildArgsIDictionary<string, string>BuildArgs*map[string]*string#Default: No build arguments.
This can be used to customize the index URLs used for installing dependencies. This is not used if a custom image is provided.
bundlingFileAccessBundlingFileAccessbundling_file_accessBundlingFileAccessbundlingFileAccessBundlingFileAccessBundlingFileAccessBundlingFileAccessBundlingFileAccessBundlingFileAccess= BundlingFileAccess.BIND_MOUNT#Default: run the command defined in the image
commandHooksICommandHookscommand_hooksICommandHookscommandHooksICommandHooksCommandHooksICommandHooksCommandHooksICommandHooks#Default: do not run additional commands
entrypointstring[]entrypointtyping.List[str]entrypointList<String>Entrypointstring[]Entrypoint*[]*string#Default: run the entrypoint defined in the image
environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*string#Default: no environment variables.
Default: Default bundling image.
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: no networking options
outputPathSuffixstringoutput_path_suffixstroutputPathSuffixStringOutputPathSuffixstringOutputPathSuffix*string#Default: 'python' for a layer, empty string otherwise.
Default: no platform specified
Example value: linux/amd64
poetryIncludeHashesbooleanpoetry_include_hashesboolpoetryIncludeHashesBooleanPoetryIncludeHashesboolPoetryIncludeHashes*bool#Default: Hashes are NOT included in the exported requirements.txt file
Note that this can cause builds to fail if not all dependencies export with a hash.
poetryWithoutUrlsbooleanpoetry_without_urlsboolpoetryWithoutUrlsBooleanPoetryWithoutUrlsboolPoetryWithoutUrls*bool#Default: URLs are included in the exported requirements.txt file.
Default: no security options
Default: root or image default
volumesDockerVolume[]volumestyping.List[DockerVolume]volumesList<DockerVolume>VolumesDockerVolume[]Volumes*[]DockerVolume#Default: no volumes are mounted
volumesFromstring[]volumes_fromtyping.List[str]volumesFromList<String>VolumesFromstring[]VolumesFrom*[]*string#Default: no containers are specified to mount volumes from
workingDirectorystringworking_directorystrworkingDirectoryStringWorkingDirectorystringWorkingDirectory*string#Default: image default