Class CfnFunction.CodeProperty
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.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Lambda
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CodeProperty : Object, CfnFunction.ICodeProperty
Syntax (vb)
Public Class CodeProperty
Inherits Object
Implements CfnFunction.ICodeProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;
var codeProperty = new CodeProperty {
ImageUri = "imageUri",
S3Bucket = "s3Bucket",
S3Key = "s3Key",
S3ObjectVersion = "s3ObjectVersion",
ZipFile = "zipFile"
};
Synopsis
Constructors
CodeProperty() |
Properties
ImageUri | URI of a container image in the Amazon ECR registry. |
S3Bucket | An Amazon S3 bucket in the same AWS Region as your function. |
S3Key | The Amazon S3 key of the deployment package. |
S3ObjectVersion | For versioned objects, the version of the deployment package object to use. |
ZipFile | (Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named |
Constructors
CodeProperty()
public CodeProperty()
Properties
ImageUri
URI of a container image in the Amazon ECR registry.
public string ImageUri { get; set; }
Property Value
System.String
Remarks
S3Bucket
An Amazon S3 bucket in the same AWS Region as your function.
public string S3Bucket { get; set; }
Property Value
System.String
Remarks
The bucket can be in a different AWS account .
S3Key
The Amazon S3 key of the deployment package.
public string S3Key { get; set; }
Property Value
System.String
Remarks
S3ObjectVersion
For versioned objects, the version of the deployment package object to use.
public string S3ObjectVersion { get; set; }
Property Value
System.String
Remarks
ZipFile
(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named index
and zips it to create a deployment package . This zip file cannot exceed 4MB. For the Handler
property, the first part of the handler identifier must be index
. For example, index.handler
.
public string ZipFile { get; set; }
Property Value
System.String
Remarks
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 AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ( cfn-response ) that simplifies sending responses. See Using AWS Lambda with AWS CloudFormation for details.