Language	Type name
.NET	Amazon.CDK.AWS.Lambda.Python.Alpha.PythonFunction
Go	github.com/aws/aws-cdk-go/awscdklambdapythonalpha/v2#PythonFunction
Java	software.amazon.awscdk.services.lambda.python.alpha.PythonFunction
Python	aws_cdk.aws_lambda_python_alpha.PythonFunction
TypeScript (source)	@aws-cdk/aws-lambda-python-alpha » PythonFunction

Implements IConstruct, IDependable, IResource, IEnvironment Aware, IFunction, IConnectable, IGrantable, IFunction Ref, IClient Vpn Connection Handler

A Python Lambda function.

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/" },
  },
});

Initializer

new PythonFunction(scope: Construct, id: string, props: PythonFunctionProps)

Parameters

• scope Construct
• id string
• props Python Function Props

Construct Props

entry🔹

Type: string

Path to the source of the function or the location for dependencies.

runtime🔹

Type: Runtime

The runtime environment.

Only runtimes of the Python family are supported.

adotInstrumentation?🔹

Type: Adot Instrumentation Config (optional, default: No ADOT instrumentation)

Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.

See also: https://aws-otel.github.io/docs/getting-started/lambda

allowAllIpv6Outbound?🔹

Type: boolean (optional, default: false)

Whether to allow the Lambda to send all ipv6 network traffic.

If set to true, there will only be a single egress rule which allows all outbound ipv6 traffic. If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets using ipv6.

Do not specify this property if the securityGroups or securityGroup property is set. Instead, configure allowAllIpv6Outbound directly on the security group.

allowAllOutbound?🔹

Type: boolean (optional, default: true)

Whether to allow the Lambda to send all network traffic (except ipv6).

If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.

Do not specify this property if the securityGroups or securityGroup property is set. Instead, configure allowAllOutbound directly on the security group.

allowPublicSubnet?🔹

Type: boolean (optional, default: false)

Lambda Functions in a public subnet can NOT access the internet.

Use this property to acknowledge this limitation and still place the function in a public subnet.

See also: https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841

applicationLogLevel?⚠️

⚠️ Deprecated: Use applicationLogLevelV2 as a property instead.

Type: string (optional, default: "INFO")

Sets the application log level for the function.

applicationLogLevelV2?🔹

Type: Application Log Level (optional, default: ApplicationLogLevel.INFO)

Sets the application log level for the function.

architecture?🔹

Type: Architecture (optional, default: Architecture.X86_64)

The system architectures compatible with this lambda function.

bundling?🔹

Type: Bundling Options (optional, default: Use the default bundling Docker image, with x86_64 architecture.)

Bundling options to use for this function.

Use this to specify custom bundling options like the bundling Docker image, asset hash type, custom hash, architecture, etc.

codeSigningConfig?🔹

Type: ICode Signing Config Ref (optional, default: Not Sign the Code)

Code signing config associated with this function.

currentVersionOptions?🔹

Type: Version Options (optional, default: default options as described in VersionOptions)

Options for the lambda.Version resource automatically created by the fn.currentVersion method.

deadLetterQueue?🔹

Type: IQueue (optional, default: SQS queue with 14 day retention period if deadLetterQueueEnabled is true)

The SQS queue to use if DLQ is enabled.

If SNS topic is desired, specify deadLetterTopic property instead.

deadLetterQueueEnabled?🔹

Type: boolean (optional, default: false unless deadLetterQueue is set, which implies DLQ is enabled.)

Enabled DLQ.

If deadLetterQueue is undefined, an SQS queue with default options will be defined for your Function.

deadLetterTopic?🔹

Type: ITopic (optional, default: no SNS topic)

The SNS topic to use as a DLQ.

Note that if deadLetterQueueEnabled is set to true, an SQS queue will be created rather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly.

description?🔹

Type: string (optional, default: No description.)

A description of the function.

durableConfig?🔹

Type: Durable Config (optional, default: No durable configuration)

The durable configuration for the function.

If durability is added to an existing function, a resource replacement will be triggered. See the 'durableConfig' section in the module README for more details.

environment?🔹

Type: { [string]: string } (optional, default: No environment variables.)

Key-value pairs that Lambda caches and makes available for your Lambda functions.

Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.

environmentEncryption?🔹

Type: IKey Ref (optional, default: AWS Lambda creates and uses an AWS managed customer master key (CMK).)

The AWS KMS key that's used to encrypt your function's environment variables.

ephemeralStorageSize?🔹

Type: Size (optional, default: 512 MiB)

The size of the function’s /tmp directory in MiB.

events?🔹

Type: IEvent Source[] (optional, default: No event sources.)

Event sources for this function.

You can also add event sources using addEventSource.

filesystem?🔹

Type: File System (optional, default: will not mount any filesystem)

The filesystem configuration for the lambda function.

functionName?🔹

Type: string (optional, default: AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.)

A name for the function.

handler?🔹

Type: string (optional, default: handler)

The name of the exported handler in the index file.

index?🔹

Type: string (optional, default: index.py)

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

initialPolicy?🔹

Type: Policy Statement[] (optional, default: No policy statements are added to the created Lambda role.)

Initial policy statements to add to the created Lambda Role.

You can call addToRolePolicy to the created lambda to add statements post creation.

insightsVersion?🔹

Type: Lambda Insights Version (optional, default: No Lambda Insights)

Specify the version of CloudWatch Lambda insights to use for monitoring.

See also: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-docker.html

ipv6AllowedForDualStack?🔹

Type: boolean (optional, default: false)

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

Only used if 'vpc' is supplied.

layers?🔹

Type: ILayer Version[] (optional, default: No layers.)

A list of layers to add to the function's execution environment.

You can configure your Lambda function to pull in additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies that can be used by multiple functions.

logFormat?⚠️

⚠️ Deprecated: Use loggingFormat as a property instead.

Type: string (optional, default: "Text")

Sets the logFormat for the function.

logGroup?🔹

Type: ILog Group Ref (optional, default: /aws/lambda/${this.functionName} - default log group created by Lambda)

The log group the function sends logs to.

By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/<function name>. However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention.

Use the logGroup property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it.

Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first.

logRemovalPolicy?⚠️

⚠️ Deprecated: use logGroup instead

Type: Removal Policy (optional, default: RemovalPolicy.Retain)

Determine the removal policy of the log group that is auto-created by this construct.

Normally you want to retain the log group so you can diagnose issues from logs even after a deployment that no longer includes the log group. In that case, use the normal date-based retention policy to age out your logs.

logRetention?⚠️

⚠️ Deprecated: use logGroup instead

Type: Retention Days (optional, default: logs.RetentionDays.INFINITE)

The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to INFINITE.

This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with logs.LogGroup and use the logGroup property to instruct the Lambda function to send logs to it. Migrating from logRetention to logGroup will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust.

In AWS CDK code, you can access the log group name directly from the LogGroup construct:

import * as logs from 'aws-cdk-lib/aws-logs';
declare const myLogGroup: logs.LogGroup;
myLogGroup.logGroupName;

logRetentionRetryOptions?🔹

Type: Log Retention Retry Options (optional, default: Default AWS SDK retry options.)

When log retention is specified, a custom resource attempts to create the CloudWatch log group.

These options control the retry policy when interacting with CloudWatch APIs.

This is a legacy API and we strongly recommend you migrate to logGroup if you can. logGroup allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

logRetentionRole?🔹

Type: IRole (optional, default: A new role is created.)

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

This is a legacy API and we strongly recommend you migrate to logGroup if you can. logGroup allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

loggingFormat?🔹

Type: Logging Format (optional, default: LoggingFormat.TEXT)

Sets the loggingFormat for the function.

maxEventAge?🔹

Type: Duration (optional, default: Duration.hours(6))

The maximum age of a request that Lambda sends to a function for processing.

Minimum: 60 seconds Maximum: 6 hours

memorySize?🔹

Type: number (optional, default: 128)

The amount of memory, in MB, that is allocated to your Lambda function.

Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide.

onFailure?🔹

Type: IDestination (optional, default: no destination)

The destination for failed invocations.

onSuccess?🔹

Type: IDestination (optional, default: no destination)

The destination for successful invocations.

paramsAndSecrets?🔹

Type: Params And Secrets Layer Version (optional, default: No Parameters and Secrets Extension)

Specify the configuration of Parameters and Secrets Extension.

See also: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-integration-lambda-extensions.html

profiling?🔹

Type: boolean (optional, default: No profiling.)

Enable profiling.

See also: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html

profilingGroup?🔹

Type: IProfiling Group (optional, default: A new profiling group will be created if profiling is set.)

Profiling Group.

See also: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html

recursiveLoop?🔹

Type: Recursive Loop (optional, default: RecursiveLoop.Terminate)

Sets the Recursive Loop Protection for Lambda Function.

It lets Lambda detect and terminate unintended recursive loops.

reservedConcurrentExecutions?🔹

Type: number (optional, default: No specific limit - account limit.)

The maximum of concurrent executions you want to reserve for the function.

See also: https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html

retryAttempts?🔹

Type: number (optional, default: 2)

The maximum number of times to retry when the function returns an error.

Minimum: 0 Maximum: 2

role?🔹

Type: IRole (optional, default: A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling addToRolePolicy.)

Lambda execution role.

This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal.

The default Role automatically has permissions granted for Lambda execution. If you provide a Role, you must add the relevant AWS managed policies yourself.

The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and "service-role/AWSLambdaVPCAccessExecutionRole".

runtimeManagementMode?🔹

Type: Runtime Management Mode (optional, default: Auto)

Sets the runtime management configuration for a function's version.

securityGroups?🔹

Type: ISecurity Group[] (optional, default: If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function.)

The list of security groups to associate with the Lambda's network interfaces.

Only used if 'vpc' is supplied.

snapStart?🔹

Type: Snap Start Conf (optional, default: No snapstart)

Enable SnapStart for Lambda Function.

SnapStart is currently supported for Java 11, Java 17, Python 3.12, Python 3.13, and .NET 8 runtime

systemLogLevel?⚠️

⚠️ Deprecated: Use systemLogLevelV2 as a property instead.

Type: string (optional, default: "INFO")

Sets the system log level for the function.

systemLogLevelV2?🔹

Type: System Log Level (optional, default: SystemLogLevel.INFO)

Sets the system log level for the function.

tenancyConfig?🔹

Type: Tenancy Config (optional, default: Tenant isolation is not enabled)

The tenancy configuration for the function.

timeout?🔹

Type: Duration (optional, default: Duration.seconds(3))

The function execution time (in seconds) after which Lambda terminates the function.

Because the execution time affects cost, set this value based on the function's expected execution time.

tracing?🔹

Type: Tracing (optional, default: Tracing.Disabled)

Enable AWS X-Ray Tracing for Lambda Function.

vpc?🔹

Type: IVpc (optional, default: Function is not placed within a VPC.)

VPC network to place Lambda network interfaces.

Specify this if the Lambda function needs to access resources in a VPC. This is required when vpcSubnets is specified.

vpcSubnets?🔹

Type: Subnet Selection (optional, default: the Vpc default strategy if not specified)

Where to place the network interfaces within the VPC.

This requires vpc to be specified in order for interfaces to actually be placed in the subnets. If vpc is not specify, this will raise an error.

Note: Internet access for Lambda Functions requires a NAT Gateway, so picking public subnets is not allowed (unless allowPublicSubnet is set to true).

Properties

architecture🔹

Type: Architecture

The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

connections🔹

Type: Connections

Access the Connections object.

Will fail if not a VPC-enabled Lambda Function

currentVersion🔹

Type: Version

Returns a lambda.Version which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes.

You can specify options for this version using the currentVersionOptions prop when initializing the lambda.Function.

env🔹

Type: Resource Environment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

functionArn🔹

Type: string

ARN of this function.

functionName🔹

Type: string

Name of this function.

functionRef🔹

Type: Function Reference

A reference to a Function resource.

grantPrincipal🔹

Type: IPrincipal

The principal this Lambda Function is running as.

isBoundToVpc🔹

Type: boolean

Whether or not this Lambda function was bound to a VPC.

If this is false, trying to access the connections object will fail.

latestVersion🔹

Type: IVersion

The $LATEST version of this function.

Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.

To obtain a reference to an explicit version which references the current function configuration, use lambdaFunction.currentVersion instead.

logGroup🔹

Type: ILog Group

The LogGroup where the Lambda function's logs are made available.

If either logRetention is set or this property is called, a CloudFormation custom resource is added to the stack that pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention period (never expire, by default).

Further, if the log group already exists and the logRetention is not set, the custom resource will reset the log retention to never expire even if it was configured with a different value.

node🔹

Type: Node

The tree node.

permissionsNode🔹

Type: Node

The construct node where permissions are attached.

resourceArnsForGrantInvoke🔹

Type: string[]

The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().

runtime🔹

Type: Runtime

The runtime configured for this lambda.

stack🔹

Type: Stack

The stack in which this resource is defined.

deadLetterQueue?🔹

Type: IQueue (optional)

The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

deadLetterTopic?🔹

Type: ITopic (optional)

The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).

role?🔹

Type: IRole (optional)

Execution role associated with this function.

tenancyConfig?🔹

Type: Tenancy Config (optional)

The tenancy configuration for this function.

timeout?🔹

Type: Duration (optional)

The timeout configured for this lambda.

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

add Alias(aliasName, options?)🔹

public addAlias(aliasName: string, options?: AliasOptions): Alias

Parameters

• aliasName string — The name of the alias.
• options Alias Options — Alias options.

Returns

• Alias

Defines an alias for this function.

The alias will automatically be updated to point to the latest version of the function as it is being updated during a deployment.

declare const fn: lambda.Function;
fn.addAlias('Live');
// Is equivalent to
new lambda.Alias(this, 'AliasLive', {
  aliasName: 'Live',
  version: fn.currentVersion,
});

add Environment(key, value, options?)🔹

public addEnvironment(key: string, value: string, options?: EnvironmentOptions): Function

Parameters

• key string — The environment variable key.
• value string — The environment variable's value.
• options Environment Options — Environment variable options.

Returns

• Function

Adds an environment variable to this Lambda function.

If this is a ref to a Lambda function, this operation results in a no-op.

add Event Source(source)🔹

public addEventSource(source: IEventSource): void

Parameters

• source IEvent Source

Adds an event source to this function.

Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module.

The following example adds an SQS Queue as an event source:

import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
myFunction.addEventSource(new SqsEventSource(myQueue));

add Event Source Mapping(id, options)🔹

public addEventSourceMapping(id: string, options: EventSourceMappingOptions): EventSourceMapping

Parameters

• id string
• options Event Source Mapping Options

Returns

• Event Source Mapping

Adds an event source that maps to this AWS Lambda function.

add Function Url(options?)🔹

public addFunctionUrl(options?: FunctionUrlOptions): FunctionUrl

Parameters

• options Function Url Options

Returns

• Function Url

Adds a url to this lambda function.

add Layers(...layers)🔹

public addLayers(...layers: ILayerVersion[]): void

Parameters

• layers ILayer Version — the layers to be added.

Adds one or more Lambda Layers to this Lambda function.

add Permission(id, permission)🔹

public addPermission(id: string, permission: Permission): void

Parameters

• id string — The id for the permission construct.
• permission Permission — The permission to grant to this Lambda function.

Adds a permission to the Lambda resource policy.

See also: [Permission for details.](Permission for details.)

add To Role Policy(statement)🔹

public addToRolePolicy(statement: PolicyStatement): void

Parameters

• statement Policy Statement

Adds a statement to the IAM role assumed by the instance.

apply Cross Stack Reference Strength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength Reference Strength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

apply Removal Policy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy Removal Policy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

configure Async Invoke(options)🔹

public configureAsyncInvoke(options: EventInvokeConfigOptions): void

Parameters

• options Event Invoke Config Options

Configures options for asynchronous invocation.

consider Warning On Invoke Function Permissions(scope, action)🔹

public considerWarningOnInvokeFunctionPermissions(scope: Construct, action: string): void

Parameters

• scope Construct
• action string

A warning will be added to functions under the following conditions: - permissions that include lambda:InvokeFunction are added to the unqualified function.

• function.currentVersion is invoked before or after the permission is created.

This applies only to permissions on Lambda functions, not versions or aliases. This function is overridden as a noOp for QualifiedFunctionBase.

grant Invoke(grantee)🔹

public grantInvoke(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant the given identity permissions to invoke this Lambda.

[disable-awslint:no-grants]

grant Invoke Composite Principal(compositePrincipal)🔹

public grantInvokeCompositePrincipal(compositePrincipal: CompositePrincipal): Grant[]

Parameters

• compositePrincipal Composite Principal

Returns

• Grant[]

Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.

[disable-awslint:no-grants]

grant Invoke Latest Version(grantee)🔹

public grantInvokeLatestVersion(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda.

[disable-awslint:no-grants]

grant Invoke Url(grantee)🔹

public grantInvokeUrl(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant the given identity permissions to invoke this Lambda Function URL.

[disable-awslint:no-grants]

grant Invoke Version(grantee, version)🔹

public grantInvokeVersion(grantee: IGrantable, version: IVersion): Grant

Parameters

• grantee IGrantable
• version IVersion

Returns

• Grant

Grant the given identity permissions to invoke the given version of this Lambda.

[disable-awslint:no-grants]

invalidate Version Based On(x)🔹

public invalidateVersionBasedOn(x: string): void

Parameters

• x string

Mix additional information into the hash of the Version object.

The Lambda Function construct does its best to automatically create a new Version when anything about the Function changes (its code, its layers, any of the other properties).

However, you can sometimes source information from places that the CDK cannot look into, like the deploy-time values of SSM parameters. In those cases, the CDK would not force the creation of a new Version object when it actually should.

This method can be used to invalidate the current Version object. Pass in any string into this method, and make sure the string changes when you know a new Version needs to be created.

This method may be called more than once.

metric(metricName, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props Metric Options

Returns

• Metric

Return the given named metric for this Function.

metric Duration(props?)🔹

public metricDuration(props?: MetricOptions): Metric

Parameters

• props Metric Options

Returns

• Metric

How long execution of this Lambda takes.

Average over 5 minutes

metric Errors(props?)🔹

public metricErrors(props?: MetricOptions): Metric

Parameters

• props Metric Options

Returns

• Metric

How many invocations of this Lambda fail.

Sum over 5 minutes

metric Invocations(props?)🔹

public metricInvocations(props?: MetricOptions): Metric

Parameters

• props Metric Options

Returns

• Metric

How often this Lambda is invoked.

Sum over 5 minutes

metric Throttles(props?)🔹

public metricThrottles(props?: MetricOptions): Metric

Parameters

• props Metric Options

Returns

• Metric

How often this Lambda is throttled.

Sum over 5 minutes

to String()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.