software.amazon.awscdk.services.lambda

Interface FunctionProps

All Superinterfaces:

EventInvokeConfigOptions, FunctionOptions

All Known Subinterfaces:

EdgeFunctionProps, SingletonFunctionProps, TriggerFunctionProps

All Known Implementing Classes:

EdgeFunctionProps.Jsii$Proxy, FunctionProps.Jsii$Proxy, SingletonFunctionProps.Jsii$Proxy, TriggerFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:33.844Z")
public interface FunctionProps
extends FunctionOptions

Example:

 import software.amazon.awscdk.services.lambda.*;
 Function fn = Function.Builder.create(this, "MyFunc")
         .runtime(Runtime.NODEJS_12_X)
         .handler("index.handler")
         .code(Code.fromInline("exports.handler = handler.toString()"))
         .build();
 Rule rule = Rule.Builder.create(this, "rule")
         .eventPattern(EventPattern.builder()
                 .source(List.of("aws.ec2"))
                 .build())
         .build();
 Queue queue = new Queue(this, "Queue");
 rule.addTarget(LambdaFunction.Builder.create(fn)
         .deadLetterQueue(queue) // Optional: add a dead letter queue
         .maxEventAge(Duration.hours(2)) // Optional: set the maxEventAge retry policy
         .retryAttempts(2)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static FunctionProps.Builder	builder()
Code	getCode() The source code of your Lambda function.
java.lang.String	getHandler() The name of the method within your code that Lambda calls to execute your function.
Runtime	getRuntime() The runtime environment for the Lambda function that you are uploading.

Methods inherited from interface software.amazon.awscdk.services.lambda.FunctionOptions

getAllowAllOutbound, getAllowPublicSubnet, getArchitecture, getArchitectures, getCodeSigningConfig, getCurrentVersionOptions, getDeadLetterQueue, getDeadLetterQueueEnabled, getDeadLetterTopic, getDescription, getEnvironment, getEnvironmentEncryption, getEphemeralStorageSize, getEvents, getFilesystem, getFunctionName, getInitialPolicy, getInsightsVersion, getLayers, getLogRetention, getLogRetentionRetryOptions, getLogRetentionRole, getMemorySize, getProfiling, getProfilingGroup, getReservedConcurrentExecutions, getRole, getSecurityGroup, getSecurityGroups, getTimeout, getTracing, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.awscdk.services.lambda.EventInvokeConfigOptions

getMaxEventAge, getOnFailure, getOnSuccess, getRetryAttempts

Method Detail

getCode

Code getCode()

The source code of your Lambda function.

You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text.

getHandler

java.lang.String getHandler()

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

The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-features.html#gettingstarted-features-programmingmodel.

Use Handler.FROM_IMAGE when defining a function from a Docker image.

NOTE: If you specify your source code as inline text by specifying the ZipFile property within the Code property, specify index.function_name as the handler.

getRuntime

Runtime getRuntime()

The runtime environment for the Lambda function that you are uploading.

For valid values, see the Runtime property in the AWS Lambda Developer Guide.

Use Runtime.FROM_IMAGE when when defining a function from a Docker image.

builder

static FunctionProps.Builder builder()

Specified by:

builder in interface EventInvokeConfigOptions

Specified by:

builder in interface FunctionOptions

Returns:

a FunctionProps.Builder of FunctionProps