Package software.amazon.awscdk.services.lambda

Interface CfnFunction.CodeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunction.CodeProperty.Jsii$Proxy

Enclosing class:

CfnFunction

@Stability(Stable)
public static interface CfnFunction.CodeProperty
extends software.amazon.jsii.JsiiSerializable

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.

When you specify source code inline for a Node.js function, the index file that AWS CloudFormation creates uses the extension .js . This means that Lambda treats the file as a CommonJS module. ES modules aren't supported for inline functions.

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.

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.*;
 CodeProperty codeProperty = CodeProperty.builder()
         .imageUri("imageUri")
         .s3Bucket("s3Bucket")
         .s3Key("s3Key")
         .s3ObjectVersion("s3ObjectVersion")
         .sourceKmsKeyArn("sourceKmsKeyArn")
         .zipFile("zipFile")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFunction.CodeProperty.Builder	builder()
default String	getImageUri()	URI of a container image in the Amazon ECR registry.
default String	getS3Bucket()	An Amazon S3 bucket in the same AWS Region as your function.
default String	getS3Key()	The Amazon S3 key of the deployment package.
default String	getS3ObjectVersion()	For versioned objects, the version of the deployment package object to use.
default String	getSourceKmsKeyArn()	The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt your function's .zip deployment package.
default String	getZipFile()	(Node.js and Python) The source code of your Lambda function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImageUri

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

URI of a container image in the Amazon ECR registry.

See Also:

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

getS3Bucket

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

An Amazon S3 bucket in the same AWS Region as your function.

The bucket can be in a different AWS account .

See Also:

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

getS3Key

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

The Amazon S3 key of the deployment package.

See Also:

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

getS3ObjectVersion

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

For versioned objects, the version of the deployment package object to use.

See Also:

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

getSourceKmsKeyArn

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

The ARN of the AWS Key Management Service ( AWS 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 AWS owned key .

See Also:

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

getZipFile

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

(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 .

When you specify source code inline for a Node.js function, the index file that AWS CloudFormation creates uses the extension .js . This means that Lambda treats the file as a CommonJS module. ES modules aren't supported for inline functions.

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.

See Also:

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

builder

@Stability(Stable)
static CfnFunction.CodeProperty.Builder builder()

Returns:

a CfnFunction.CodeProperty.Builder of CfnFunction.CodeProperty