software.amazon.awscdk.services.lambda.python

Interface PythonFunctionProps

All Superinterfaces:

EventInvokeConfigOptions, FunctionOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PythonFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.28.0 (build 1801f4f)",
           date="2021-04-28T11:07:44.331Z")
 @Stability(value=Experimental)
public interface PythonFunctionProps
extends software.amazon.jsii.JsiiSerializable, FunctionOptions

(experimental) Properties for a PythonFunction.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static PythonFunctionProps.Builder	builder()
default String	getAssetHash() (experimental) Specify a custom hash for this asset.
default AssetHashType	getAssetHashType() (experimental) Determines how asset hash is calculated.
String	getEntry() (experimental) The path to the root directory of the function.
default String	getHandler() (experimental) The name of the exported handler in the index file.
default String	getIndex() (experimental) The path (relative to entry) to the index file containing the exported handler.
default Runtime	getRuntime() (experimental) The runtime environment.

Methods inherited from interface software.amazon.awscdk.services.lambda.FunctionOptions

getAllowAllOutbound, getAllowPublicSubnet, getCodeSigningConfig, getCurrentVersionOptions, getDeadLetterQueue, getDeadLetterQueueEnabled, getDescription, getEnvironment, getEnvironmentEncryption, getEvents, getFilesystem, getFunctionName, getInitialPolicy, getLayers, getLogRetention, getLogRetentionRetryOptions, getLogRetentionRole, getMemorySize, getProfiling, getProfilingGroup, getReservedConcurrentExecutions, getRole, getSecurityGroup, getSecurityGroups, getTimeout, getTracing, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.awscdk.services.lambda.EventInvokeConfigOptions

getMaxEventAge, getOnFailure, getOnSuccess, getRetryAttempts

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEntry

@Stability(value=Experimental)
 @NotNull
String getEntry()

(experimental) The path to the root directory of the function.

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) Determines how asset hash is calculated. Assets will get rebuild and uploaded only if their hash has changed.

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.

getHandler

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

(experimental) The name of the exported handler in the index file.

Default: handler

getIndex

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

(experimental) The path (relative to entry) to the index file containing the exported handler.

Default: index.py

getRuntime

@Stability(value=Experimental)
 @Nullable
default Runtime getRuntime()

(experimental) The runtime environment.

Only runtimes of the Python family are supported.

Default: lambda.Runtime.PYTHON_3_7

builder

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

Specified by:

builder in interface EventInvokeConfigOptions

Specified by:

builder in interface FunctionOptions

Returns:

a PythonFunctionProps.Builder of PythonFunctionProps