Package software.amazon.awscdk.services.lambda

Interface CfnFunctionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:31.089Z")
@Stability(Stable)
public interface CfnFunctionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFunction.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 CfnFunctionProps cfnFunctionProps = CfnFunctionProps.builder()
         .code(CodeProperty.builder()
                 .imageUri("imageUri")
                 .s3Bucket("s3Bucket")
                 .s3Key("s3Key")
                 .s3ObjectVersion("s3ObjectVersion")
                 .sourceKmsKeyArn("sourceKmsKeyArn")
                 .zipFile("zipFile")
                 .build())
         .role("role")
         // the properties below are optional
         .architectures(List.of("architectures"))
         .codeSigningConfigArn("codeSigningConfigArn")
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .targetArn("targetArn")
                 .build())
         .description("description")
         .environment(EnvironmentProperty.builder()
                 .variables(Map.of(
                         "variablesKey", "variables"))
                 .build())
         .ephemeralStorage(EphemeralStorageProperty.builder()
                 .size(123)
                 .build())
         .fileSystemConfigs(List.of(FileSystemConfigProperty.builder()
                 .arn("arn")
                 .localMountPath("localMountPath")
                 .build()))
         .functionName("functionName")
         .handler("handler")
         .imageConfig(ImageConfigProperty.builder()
                 .command(List.of("command"))
                 .entryPoint(List.of("entryPoint"))
                 .workingDirectory("workingDirectory")
                 .build())
         .kmsKeyArn("kmsKeyArn")
         .layers(List.of("layers"))
         .loggingConfig(LoggingConfigProperty.builder()
                 .applicationLogLevel("applicationLogLevel")
                 .logFormat("logFormat")
                 .logGroup("logGroup")
                 .systemLogLevel("systemLogLevel")
                 .build())
         .memorySize(123)
         .packageType("packageType")
         .recursiveLoop("recursiveLoop")
         .reservedConcurrentExecutions(123)
         .runtime("runtime")
         .runtimeManagementConfig(RuntimeManagementConfigProperty.builder()
                 .updateRuntimeOn("updateRuntimeOn")
                 // the properties below are optional
                 .runtimeVersionArn("runtimeVersionArn")
                 .build())
         .snapStart(SnapStartProperty.builder()
                 .applyOn("applyOn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeout(123)
         .tracingConfig(TracingConfigProperty.builder()
                 .mode("mode")
                 .build())
         .vpcConfig(VpcConfigProperty.builder()
                 .ipv6AllowedForDualStack(false)
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFunctionProps.Builder	builder()
default List<String>	getArchitectures()	The instruction set architecture that the function supports.
Object	getCode()	The deployment package for a Lambda function.
default String	getCodeSigningConfigArn()	To enable code signing for this function, specify the ARN of a code-signing configuration.
default Object	getDeadLetterConfig()	The dead-letter queue for failed asynchronous invocations.
default String	getDescription()	A description of the function.
default Object	getEnvironment()	A function's environment variable settings.
default Object	getEphemeralStorage()	The size of the function's /tmp directory in MB.
default Object	getFileSystemConfigs()	Connection settings for an Amazon EFS file system.
default String	getFunctionName()	The name of the Lambda function, up to 64 characters in length.
default String	getHandler()	The name of the method within your code that Lambda calls to run your function.
default Object	getImageConfig()	Configuration values that override the container image Dockerfile settings.
default String	getKmsKeyArn()	The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables.
default List<String>	getLayers()	A list of function layers to add to the function's execution environment.
default Object	getLoggingConfig()	The function's Amazon CloudWatch Logs configuration settings.
default Number	getMemorySize()	The amount of memory available to the function at runtime.
default String	getPackageType()	The type of deployment package.
default String	getRecursiveLoop()	This property is set to terminate unintended recursions.
default Number	getReservedConcurrentExecutions()	The number of simultaneous executions to reserve for the function.
String	getRole()	The Amazon Resource Name (ARN) of the function's execution role.
default String	getRuntime()	The identifier of the function's runtime.
default Object	getRuntimeManagementConfig()	Sets the runtime management configuration for a function's version.
default Object	getSnapStart()	The function's SnapStart setting.
default List<CfnTag>	getTags()	A list of tags to apply to the function.
default Number	getTimeout()	The amount of time (in seconds) that Lambda allows a function to run before stopping it.
default Object	getTracingConfig()	The function's tracing configuration.
default Object	getVpcConfig()	The VPC security groups and subnets that are attached to a Lambda function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCode

@Stability(Stable)
@NotNull
Object getCode()

The deployment package for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code

getRole

@Stability(Stable)
@NotNull
String getRole()

The Amazon Resource Name (ARN) of the function's execution role.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role

getArchitectures

@Stability(Stable)
@Nullable
default List<String> getArchitectures()

The instruction set architecture that the function supports.

Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures

getCodeSigningConfigArn

@Stability(Stable)
@Nullable
default String getCodeSigningConfigArn()

To enable code signing for this function, specify the ARN of a code-signing configuration.

A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn

getDeadLetterConfig

@Stability(Stable)
@Nullable
default Object getDeadLetterConfig()

The dead-letter queue for failed asynchronous invocations.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description

getEnvironment

@Stability(Stable)
@Nullable
default Object getEnvironment()

A function's environment variable settings.

You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment

getEphemeralStorage

@Stability(Stable)
@Nullable
default Object getEphemeralStorage()

The size of the function's /tmp directory in MB.

The default value is 512, but it can be any whole number between 512 and 10,240 MB.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage

getFileSystemConfigs

@Stability(Stable)
@Nullable
default Object getFileSystemConfigs()

Connection settings for an Amazon EFS file system.

To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. For more information about using the DependsOn attribute, see DependsOn Attribute.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs

getFunctionName

@Stability(Stable)
@Nullable
default String getFunctionName()

The name of the Lambda function, up to 64 characters in length.

If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname

getHandler

@Stability(Stable)
@Nullable
default String getHandler()

The name of the method within your code that Lambda calls to run your function.

Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler

getImageConfig

@Stability(Stable)
@Nullable
default Object getImageConfig()

Configuration values that override the container image Dockerfile settings.

For more information, see Container image settings.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn

getLayers

@Stability(Stable)
@Nullable
default List<String> getLayers()

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers

getLoggingConfig

@Stability(Stable)
@Nullable
default Object getLoggingConfig()

The function's Amazon CloudWatch Logs configuration settings.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig

getMemorySize

@Stability(Stable)
@Nullable
default Number getMemorySize()

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize

getPackageType

@Stability(Stable)
@Nullable
default String getPackageType()

The type of deployment package.

Set to Image for container image and set Zip for .zip file archive.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype

getRecursiveLoop

@Stability(Stable)
@Nullable
default String getRecursiveLoop()

This property is set to terminate unintended recursions.

If set to Terminate, Lambda detects and terminates unitended recursive loops. If set to Allow Lambda lets recursions be and does not terminate it.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-recursiveloop

getReservedConcurrentExecutions

@Stability(Stable)
@Nullable
default Number getReservedConcurrentExecutions()

The number of simultaneous executions to reserve for the function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions

getRuntime

@Stability(Stable)
@Nullable
default String getRuntime()

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation. For a list of all currently supported runtimes, see Supported runtimes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime

getRuntimeManagementConfig

@Stability(Stable)
@Nullable
default Object getRuntimeManagementConfig()

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

For more information, see Runtime updates.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtimemanagementconfig

getSnapStart

@Stability(Stable)
@Nullable
default Object getSnapStart()

The function's SnapStart setting.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-snapstart

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of tags to apply to the function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags

getTimeout

@Stability(Stable)
@Nullable
default Number getTimeout()

The amount of time (in seconds) that Lambda allows a function to run before stopping it.

The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout

getTracingConfig

@Stability(Stable)
@Nullable
default Object getTracingConfig()

The function's tracing configuration. To sample and record incoming requests, set Mode to Active.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig

getVpcConfig

@Stability(Stable)
@Nullable
default Object getVpcConfig()

The VPC security groups and subnets that are attached to a Lambda function.

When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see VPC Settings. When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the ec2:DescribeNetworkInterfaces permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig

builder

@Stability(Stable)
static CfnFunctionProps.Builder builder()

Returns:

a CfnFunctionProps.Builder of CfnFunctionProps