Class PythonFunctionProps
(experimental) Properties for a PythonFunction.
Inheritance
Namespace: Amazon.CDK.AWS.Lambda.Python.Alpha
Assembly: Amazon.CDK.AWS.Lambda.Python.Alpha.dll
Syntax (csharp)
public class PythonFunctionProps : Object, IPythonFunctionProps, IFunctionOptions, IEventInvokeConfigOptions
Syntax (vb)
Public Class PythonFunctionProps
Inherits Object
Implements IPythonFunctionProps, IFunctionOptions, IEventInvokeConfigOptions
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
Constructors
PythonFunctionProps() |
Properties
AdotInstrumentation | Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation. |
AllowAllOutbound | Whether to allow the Lambda to send all network traffic. |
AllowPublicSubnet | Lambda Functions in a public subnet can NOT access the internet. |
ApplicationLogLevel | Sets the application log level for the function. |
Architecture | The system architectures compatible with this lambda function. |
Bundling | (experimental) Bundling options to use for this function. |
CodeSigningConfig | Code signing config associated with this function. |
CurrentVersionOptions | Options for the |
DeadLetterQueue | The SQS queue to use if DLQ is enabled. |
DeadLetterQueueEnabled | Enabled DLQ. |
DeadLetterTopic | The SNS topic to use as a DLQ. |
Description | A description of the function. |
Entry | (experimental) Path to the source of the function or the location for dependencies. |
Environment | Key-value pairs that Lambda caches and makes available for your Lambda functions. |
EnvironmentEncryption | The AWS KMS key that's used to encrypt your function's environment variables. |
EphemeralStorageSize | The size of the function’s /tmp directory in MiB. |
Events | Event sources for this function. |
Filesystem | The filesystem configuration for the lambda function. |
FunctionName | A name for the function. |
Handler | (experimental) The name of the exported handler in the index file. |
Index | (experimental) The path (relative to entry) to the index file containing the exported handler. |
InitialPolicy | Initial policy statements to add to the created Lambda Role. |
InsightsVersion | Specify the version of CloudWatch Lambda insights to use for monitoring. |
Ipv6AllowedForDualStack | Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. |
Layers | A list of layers to add to the function's execution environment. |
LogFormat | Sets the logFormat for the function. |
LoggingFormat | Sets the loggingFormat for the function. |
LogGroup | The log group the function sends logs to. |
LogRetention | The number of days log events are kept in CloudWatch Logs. |
LogRetentionRetryOptions | When log retention is specified, a custom resource attempts to create the CloudWatch log group. |
LogRetentionRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. |
MaxEventAge | The maximum age of a request that Lambda sends to a function for processing. |
MemorySize | The amount of memory, in MB, that is allocated to your Lambda function. |
OnFailure | The destination for failed invocations. |
OnSuccess | The destination for successful invocations. |
ParamsAndSecrets | Specify the configuration of Parameters and Secrets Extension. |
Profiling | Enable profiling. |
ProfilingGroup | Profiling Group. |
ReservedConcurrentExecutions | The maximum of concurrent executions you want to reserve for the function. |
RetryAttempts | The maximum number of times to retry when the function returns an error. |
Role | Lambda execution role. |
Runtime | (experimental) The runtime environment. |
RuntimeManagementMode | Sets the runtime management configuration for a function's version. |
SecurityGroups | The list of security groups to associate with the Lambda's network interfaces. |
SnapStart | Enable SnapStart for Lambda Function. |
SystemLogLevel | Sets the system log level for the function. |
Timeout | The function execution time (in seconds) after which Lambda terminates the function. |
Tracing | Enable AWS X-Ray Tracing for Lambda Function. |
Vpc | VPC network to place Lambda network interfaces. |
VpcSubnets | Where to place the network interfaces within the VPC. |
Constructors
PythonFunctionProps()
public PythonFunctionProps()
Properties
AdotInstrumentation
Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.
public IAdotInstrumentationConfig AdotInstrumentation { get; set; }
Property Value
Remarks
Default: - No ADOT instrumentation
AllowAllOutbound
Whether to allow the Lambda to send all network traffic.
public Nullable<bool> AllowAllOutbound { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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.
Default: true
AllowPublicSubnet
Lambda Functions in a public subnet can NOT access the internet.
public Nullable<bool> AllowPublicSubnet { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Use this property to acknowledge this limitation and still place the function in a public subnet.
Default: false
ApplicationLogLevel
Sets the application log level for the function.
public string ApplicationLogLevel { get; set; }
Property Value
System.String
Remarks
Default: "INFO"
Architecture
The system architectures compatible with this lambda function.
public Architecture Architecture { get; set; }
Property Value
Remarks
Default: Architecture.X86_64
Bundling
(experimental) Bundling options to use for this function.
public IBundlingOptions Bundling { get; set; }
Property Value
Remarks
Use this to specify custom bundling options like the bundling Docker image, asset hash type, custom hash, architecture, etc.
Default: - Use the default bundling Docker image, with x86_64 architecture.
Stability: Experimental
CodeSigningConfig
Code signing config associated with this function.
public ICodeSigningConfig CodeSigningConfig { get; set; }
Property Value
Remarks
Default: - Not Sign the Code
CurrentVersionOptions
Options for the lambda.Version
resource automatically created by the fn.currentVersion
method.
public IVersionOptions CurrentVersionOptions { get; set; }
Property Value
Remarks
Default: - default options as described in VersionOptions
DeadLetterQueue
The SQS queue to use if DLQ is enabled.
public IQueue DeadLetterQueue { get; set; }
Property Value
Remarks
If SNS topic is desired, specify deadLetterTopic
property instead.
Default: - SQS queue with 14 day retention period if deadLetterQueueEnabled
is true
DeadLetterQueueEnabled
Enabled DLQ.
public Nullable<bool> DeadLetterQueueEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If deadLetterQueue
is undefined,
an SQS queue with default options will be defined for your Function.
Default: - false unless deadLetterQueue
is set, which implies DLQ is enabled.
DeadLetterTopic
The SNS topic to use as a DLQ.
public ITopic DeadLetterTopic { get; set; }
Property Value
Remarks
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.
Default: - no SNS topic
Description
A description of the function.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: - No description.
Entry
(experimental) Path to the source of the function or the location for dependencies.
public string Entry { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
Environment
Key-value pairs that Lambda caches and makes available for your Lambda functions.
public IDictionary<string, string> Environment { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.
Default: - No environment variables.
EnvironmentEncryption
The AWS KMS key that's used to encrypt your function's environment variables.
public IKey EnvironmentEncryption { get; set; }
Property Value
Remarks
Default: - AWS Lambda creates and uses an AWS managed customer master key (CMK).
EphemeralStorageSize
The size of the function’s /tmp directory in MiB.
public Size EphemeralStorageSize { get; set; }
Property Value
Remarks
Default: 512 MiB
Events
Event sources for this function.
public IEventSource[] Events { get; set; }
Property Value
Remarks
You can also add event sources using addEventSource
.
Default: - No event sources.
Filesystem
The filesystem configuration for the lambda function.
public FileSystem Filesystem { get; set; }
Property Value
Remarks
Default: - will not mount any filesystem
FunctionName
A name for the function.
public string FunctionName { get; set; }
Property Value
System.String
Remarks
Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.
Handler
(experimental) The name of the exported handler in the index file.
public string Handler { get; set; }
Property Value
System.String
Remarks
Default: handler
Stability: Experimental
Index
(experimental) The path (relative to entry) to the index file containing the exported handler.
public string Index { get; set; }
Property Value
System.String
Remarks
Default: index.py
Stability: Experimental
InitialPolicy
Initial policy statements to add to the created Lambda Role.
public PolicyStatement[] InitialPolicy { get; set; }
Property Value
Remarks
You can call addToRolePolicy
to the created lambda to add statements post creation.
Default: - No policy statements are added to the created Lambda role.
InsightsVersion
Specify the version of CloudWatch Lambda insights to use for monitoring.
public LambdaInsightsVersion InsightsVersion { get; set; }
Property Value
Remarks
Default: - No Lambda Insights
Ipv6AllowedForDualStack
Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
public Nullable<bool> Ipv6AllowedForDualStack { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Only used if 'vpc' is supplied.
Default: false
Layers
A list of layers to add to the function's execution environment.
public ILayerVersion[] Layers { get; set; }
Property Value
Remarks
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.
Default: - No layers.
LogFormat
Sets the logFormat for the function.
public string LogFormat { get; set; }
Property Value
System.String
Remarks
Default: "Text"
LoggingFormat
Sets the loggingFormat for the function.
public Nullable<LoggingFormat> LoggingFormat { get; set; }
Property Value
System.Nullable<LoggingFormat>
Remarks
Default: LoggingFormat.TEXT
LogGroup
The log group the function sends logs to.
public ILogGroup LogGroup { get; set; }
Property Value
Remarks
By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/
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.
Default: /aws/lambda/${this.functionName}
- default log group created by Lambda
LogRetention
The number of days log events are kept in CloudWatch Logs.
public Nullable<RetentionDays> LogRetention { get; set; }
Property Value
System.Nullable<RetentionDays>
Remarks
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:
using Amazon.CDK.AWS.Logs;
LogGroup myLogGroup;
myLogGroup.LogGroupName;
Default: logs.RetentionDays.INFINITE
LogRetentionRetryOptions
When log retention is specified, a custom resource attempts to create the CloudWatch log group.
public ILogRetentionRetryOptions LogRetentionRetryOptions { get; set; }
Property Value
Remarks
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.
Default: - Default AWS SDK retry options.
LogRetentionRole
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
public IRole LogRetentionRole { get; set; }
Property Value
Remarks
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.
Default: - A new role is created.
MaxEventAge
The maximum age of a request that Lambda sends to a function for processing.
public Duration MaxEventAge { get; set; }
Property Value
Remarks
Minimum: 60 seconds Maximum: 6 hours
Default: Duration.hours(6)
MemorySize
The amount of memory, in MB, that is allocated to your Lambda function.
public Nullable<double> MemorySize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide.
Default: 128
OnFailure
The destination for failed invocations.
public IDestination OnFailure { get; set; }
Property Value
Remarks
Default: - no destination
OnSuccess
The destination for successful invocations.
public IDestination OnSuccess { get; set; }
Property Value
Remarks
Default: - no destination
ParamsAndSecrets
Specify the configuration of Parameters and Secrets Extension.
public ParamsAndSecretsLayerVersion ParamsAndSecrets { get; set; }
Property Value
Remarks
Default: - No Parameters and Secrets Extension
See: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-integration-lambda-extensions.html
Profiling
Enable profiling.
public Nullable<bool> Profiling { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - No profiling.
See: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html
ProfilingGroup
Profiling Group.
public IProfilingGroup ProfilingGroup { get; set; }
Property Value
Remarks
Default: - A new profiling group will be created if profiling
is set.
See: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html
ReservedConcurrentExecutions
The maximum of concurrent executions you want to reserve for the function.
public Nullable<double> ReservedConcurrentExecutions { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - No specific limit - account limit.
See: https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html
RetryAttempts
The maximum number of times to retry when the function returns an error.
public Nullable<double> RetryAttempts { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Minimum: 0 Maximum: 2
Default: 2
Role
Lambda execution role.
public IRole Role { get; set; }
Property Value
Remarks
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".
Default: - A unique role will be generated for this lambda function.
Both supplied and generated roles can always be changed by calling addToRolePolicy
.
Runtime
(experimental) The runtime environment.
public Runtime Runtime { get; set; }
Property Value
Remarks
Only runtimes of the Python family are supported.
Stability: Experimental
RuntimeManagementMode
Sets the runtime management configuration for a function's version.
public RuntimeManagementMode RuntimeManagementMode { get; set; }
Property Value
Remarks
Default: Auto
SecurityGroups
The list of security groups to associate with the Lambda's network interfaces.
public ISecurityGroup[] SecurityGroups { get; set; }
Property Value
Remarks
Only used if 'vpc' is supplied.
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.
SnapStart
Enable SnapStart for Lambda Function.
public SnapStartConf SnapStart { get; set; }
Property Value
Remarks
SnapStart is currently supported only for Java 11, 17 runtime
Default: - No snapstart
SystemLogLevel
Sets the system log level for the function.
public string SystemLogLevel { get; set; }
Property Value
System.String
Remarks
Default: "INFO"
Timeout
The function execution time (in seconds) after which Lambda terminates the function.
public Duration Timeout { get; set; }
Property Value
Remarks
Because the execution time affects cost, set this value based on the function's expected execution time.
Default: Duration.seconds(3)
Tracing
Enable AWS X-Ray Tracing for Lambda Function.
public Nullable<Tracing> Tracing { get; set; }
Property Value
System.Nullable<Tracing>
Remarks
Default: Tracing.Disabled
Vpc
VPC network to place Lambda network interfaces.
public IVpc Vpc { get; set; }
Property Value
Remarks
Specify this if the Lambda function needs to access resources in a VPC.
This is required when vpcSubnets
is specified.
Default: - Function is not placed within a VPC.
VpcSubnets
Where to place the network interfaces within the VPC.
public ISubnetSelection VpcSubnets { get; set; }
Property Value
Remarks
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
).
Default: - the Vpc default strategy if not specified