This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Lambda::Function Code
<a name="aws-properties-lambda-function-code"></a>

The [deployment package](https://docs.amazonaws.cn/lambda/latest/dg/gettingstarted-package.html) 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.

**Note**  
When you specify source code inline for a Node.js function, the `index` file that Amazon CloudFormation creates uses the extension `.js`. This means that Node.js treats the file as a CommonJS module.

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.

## Syntax
<a name="aws-properties-lambda-function-code-syntax"></a>

To declare this entity in your Amazon CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-lambda-function-code-syntax.json"></a>

```
{
  "[ImageUri](#cfn-lambda-function-code-imageuri)" : String,
  "[S3Bucket](#cfn-lambda-function-code-s3bucket)" : String,
  "[S3Key](#cfn-lambda-function-code-s3key)" : String,
  "[S3ObjectStorageMode](#cfn-lambda-function-code-s3objectstoragemode)" : String,
  "[S3ObjectVersion](#cfn-lambda-function-code-s3objectversion)" : String,
  "[SourceKMSKeyArn](#cfn-lambda-function-code-sourcekmskeyarn)" : String,
  "[ZipFile](#cfn-lambda-function-code-zipfile)" : String
}
```

### YAML
<a name="aws-properties-lambda-function-code-syntax.yaml"></a>

```
  [ImageUri](#cfn-lambda-function-code-imageuri): String
  [S3Bucket](#cfn-lambda-function-code-s3bucket): String
  [S3Key](#cfn-lambda-function-code-s3key): String
  [S3ObjectStorageMode](#cfn-lambda-function-code-s3objectstoragemode): String
  [S3ObjectVersion](#cfn-lambda-function-code-s3objectversion): String
  [SourceKMSKeyArn](#cfn-lambda-function-code-sourcekmskeyarn): String
  [ZipFile](#cfn-lambda-function-code-zipfile): String
```

## Properties
<a name="aws-properties-lambda-function-code-properties"></a>

`ImageUri`  <a name="cfn-lambda-function-code-imageuri"></a>
URI of a [container image](https://docs.amazonaws.cn/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Bucket`  <a name="cfn-lambda-function-code-s3bucket"></a>
An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.  
*Required*: Conditional  
*Type*: String  
*Pattern*: `^[0-9A-Za-z\.\-_]*(?<!\.)$`  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Key`  <a name="cfn-lambda-function-code-s3key"></a>
The Amazon S3 key of the deployment package.  
*Required*: Conditional  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3ObjectStorageMode`  <a name="cfn-lambda-function-code-s3objectstoragemode"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `COPY | REFERENCE`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3ObjectVersion`  <a name="cfn-lambda-function-code-s3objectversion"></a>
For versioned objects, the version of the deployment package object to use.  
*Required*: Conditional  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceKMSKeyArn`  <a name="cfn-lambda-function-code-sourcekmskeyarn"></a>
The ARN of the Amazon Key Management Service (Amazon KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an [Amazon owned key](https://docs.amazonaws.cn/kms/latest/developerguide/concepts.html#aws-owned-cmk).  
*Required*: No  
*Type*: String  
*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ZipFile`  <a name="cfn-lambda-function-code-zipfile"></a>
(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, Amazon CloudFormation places it in a file named `index` and zips it to create a [deployment package](https://docs.amazonaws.cn/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the `Handler` property, the first part of the handler identifier must be `index`. For example, `index.handler`.  
When you specify source code inline for a Node.js function, the `index` file that Amazon CloudFormation creates uses the extension `.js`. This means that Node.js treats the file as a CommonJS module.  
When using Node.js 24 or later, Node.js can automatically detect if a `.js` file should be treated as CommonJS or as an ES module. To enable auto-detection, add the `--experimental-detect-module` flag to the `NODE_OPTIONS` environment variable. For more information, see [Experimental Node.js features](https://docs.amazonaws.cn//lambda/latest/dg/lambda-nodejs.html#nodejs-experimental-features).
 For JSON, you must escape quotes and special characters such as newline (`\n`) with a backslash.  
If you specify a function that interacts with an Amazon CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. Amazon CloudFormation provides a response module ([cfn-response](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Amazon Lambda with Amazon CloudFormation](https://docs.amazonaws.cn/lambda/latest/dg/services-cloudformation.html) for details.   
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Examples
<a name="aws-properties-lambda-function-code--examples"></a>

### Inline Function
<a name="aws-properties-lambda-function-code--examples--Inline_Function"></a>

Inline Node.js function that lists Amazon S3 buckets in ` us-east-1 `. This example uses the [Amazon SDK for JavaScript v3](https://docs.amazonaws.cn/sdk-for-javascript/v3/developer-guide/welcome.html), which is available in the `nodejs18.x` runtime. Before using this example, make sure that your function's execution role has Amazon S3 read permissions.

#### YAML
<a name="aws-properties-lambda-function-code--examples--Inline_Function--yaml"></a>

```
      Code:
        ZipFile: |
          const { S3Client, ListBucketsCommand } = require("@aws-sdk/client-s3");
          const s3 = new S3Client({ region: "us-east-1" }); // replace "us-east-1" with your Amazon Web Services Region

          exports.handler = async function(event) {
            const command = new ListBucketsCommand({});
            const response = await s3.send(command);
            return response.Buckets;
          };
```