> **Experimental**
>
> `@aws-cdk/aws-lambda-python-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# BundlingOptions

Options for bundling.

Extends: BundlingOptions
Extends: DockerRunOptions

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/types.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0-alpha.0/packages/@aws-cdk/aws-lambda-python-alpha/lib/types.ts#L6)

## Example

```ts
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

- `assetExcludes`: string[] — List of file patterns to exclude when copying assets from source for bundling.

  **Default:** Empty list

- `assetHash`: string — Specify a custom hash for this asset.

  **Default:** Based on `assetHashType`

  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.

- `assetHashType`: [AssetHashType](/cdk/api/v2/docs/aws-cdk-lib.AssetHashType.html) — Determines how asset hash is calculated. Assets will get rebuild and uploaded only if their hash has changed.

  **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.

  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 } — Optional build arguments to pass to the default container.

  **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.

- `bundlingFileAccess`: [BundlingFileAccess](/cdk/api/v2/docs/aws-cdk-lib.BundlingFileAccess.html) = BundlingFileAccess.BIND_MOUNT — Which option to use to copy the source files to the docker container and output files back.

- `command`: string[] — The command to run in the container.

  **Default:** run the command defined in the image

- `commandHooks`: [ICommandHooks](/cdk/api/v2/docs/@aws-cdk_aws-lambda-python-alpha.ICommandHooks.html) — Command hooks.

  **Default:** do not run additional commands

- `entrypoint`: string[] — The entrypoint to run in the container.

  **Default:** run the entrypoint defined in the image

- `environment`: { [key: string]: string } — The environment variables to pass to the container.

  **Default:** no environment variables.

- `image`: [DockerImage](/cdk/api/v2/docs/aws-cdk-lib.DockerImage.html) — Docker image to use for bundling.

  **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.

- `network`: string — Docker [Networking options](https://docs.docker.com/engine/reference/commandline/run/#connect-a-container-to-a-network---network).

  **Default:** no networking options

- `outputPathSuffix`: string — Output path suffix: the suffix for the directory into which the bundled output is written.

  **Default:** 'python' for a layer, empty string otherwise.

- `platform`: string — Set platform if server is multi-platform capable. _Requires Docker Engine API v1.38+_.

  **Default:** no platform specified

  Example value: `linux/amd64`

- `poetryIncludeHashes`: boolean — Whether to export Poetry dependencies with hashes.

  **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.

- `poetryWithoutUrls`: boolean — Whether to export Poetry dependencies with source repository urls.

  **Default:** URLs are included in the exported `requirements.txt` file.

- `securityOpt`: string — [Security configuration](https://docs.docker.com/engine/reference/run/#security-configuration) when running the docker container.

  **Default:** no security options

- `user`: string — The user to use when running the container.

  **Default:** root or image default

- `volumes`: [DockerVolume](/cdk/api/v2/docs/aws-cdk-lib.DockerVolume.html)[] — Docker volumes to mount.

  **Default:** no volumes are mounted

- `volumesFrom`: string[] — Where to mount the specified volumes from.

  **Default:** no containers are specified to mount volumes from

- `workingDirectory`: string — Working directory inside the container.

  **Default:** image default