Class FunctionProps.Builder

java.lang.Object
software.amazon.awscdk.services.lambda.FunctionProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<FunctionProps>
Enclosing interface:
FunctionProps

@Stability(Stable) public static final class FunctionProps.Builder extends Object implements software.amazon.jsii.Builder<FunctionProps>
A builder for FunctionProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • code

      @Stability(Stable) public FunctionProps.Builder code(Code code)
      Sets the value of FunctionProps.getCode()
      Parameters:
      code - The source code of your Lambda function. This parameter is required. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text.
      Returns:
      this
    • handler

      @Stability(Stable) public FunctionProps.Builder handler(String handler)
      Sets the value of FunctionProps.getHandler()
      Parameters:
      handler - The name of the method within your code that Lambda calls to execute your function. This parameter is required. 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/foundation-progmodel.html.

      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.

      Returns:
      this
    • runtime

      @Stability(Stable) public FunctionProps.Builder runtime(Runtime runtime)
      Sets the value of FunctionProps.getRuntime()
      Parameters:
      runtime - The runtime environment for the Lambda function that you are uploading. This parameter is required. For valid values, see the Runtime property in the AWS Lambda Developer Guide.

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

      Returns:
      this
    • adotInstrumentation

      @Stability(Stable) public FunctionProps.Builder adotInstrumentation(AdotInstrumentationConfig adotInstrumentation)
      Parameters:
      adotInstrumentation - Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.
      Returns:
      this
    • allowAllOutbound

      @Stability(Stable) public FunctionProps.Builder allowAllOutbound(Boolean allowAllOutbound)
      Parameters:
      allowAllOutbound - Whether to allow the Lambda to send all network traffic. If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.

      Do not specify this property if the securityGroups or securityGroup property is set. Instead, configure allowAllOutbound directly on the security group.

      Returns:
      this
    • allowPublicSubnet

      @Stability(Stable) public FunctionProps.Builder allowPublicSubnet(Boolean allowPublicSubnet)
      Parameters:
      allowPublicSubnet - Lambda Functions in a public subnet can NOT access the internet. Use this property to acknowledge this limitation and still place the function in a public subnet.
      Returns:
      this
    • applicationLogLevel

      @Stability(Stable) public FunctionProps.Builder applicationLogLevel(String applicationLogLevel)
      Parameters:
      applicationLogLevel - Sets the application log level for the function.
      Returns:
      this
    • architecture

      @Stability(Stable) public FunctionProps.Builder architecture(Architecture architecture)
      Parameters:
      architecture - The system architectures compatible with this lambda function.
      Returns:
      this
    • codeSigningConfig

      @Stability(Stable) public FunctionProps.Builder codeSigningConfig(ICodeSigningConfig codeSigningConfig)
      Parameters:
      codeSigningConfig - Code signing config associated with this function.
      Returns:
      this
    • currentVersionOptions

      @Stability(Stable) public FunctionProps.Builder currentVersionOptions(VersionOptions currentVersionOptions)
      Parameters:
      currentVersionOptions - Options for the lambda.Version resource automatically created by the fn.currentVersion method.
      Returns:
      this
    • deadLetterQueue

      @Stability(Stable) public FunctionProps.Builder deadLetterQueue(IQueue deadLetterQueue)
      Parameters:
      deadLetterQueue - The SQS queue to use if DLQ is enabled. If SNS topic is desired, specify deadLetterTopic property instead.
      Returns:
      this
    • deadLetterQueueEnabled

      @Stability(Stable) public FunctionProps.Builder deadLetterQueueEnabled(Boolean deadLetterQueueEnabled)
      Parameters:
      deadLetterQueueEnabled - Enabled DLQ. If deadLetterQueue is undefined, an SQS queue with default options will be defined for your Function.
      Returns:
      this
    • deadLetterTopic

      @Stability(Stable) public FunctionProps.Builder deadLetterTopic(ITopic deadLetterTopic)
      Parameters:
      deadLetterTopic - The SNS topic to use as a DLQ. Note that if deadLetterQueueEnabled is set to true, an SQS queue will be created rather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly.
      Returns:
      this
    • description

      @Stability(Stable) public FunctionProps.Builder description(String description)
      Parameters:
      description - A description of the function.
      Returns:
      this
    • environment

      @Stability(Stable) public FunctionProps.Builder environment(Map<String,String> environment)
      Parameters:
      environment - Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.
      Returns:
      this
    • environmentEncryption

      @Stability(Stable) public FunctionProps.Builder environmentEncryption(IKey environmentEncryption)
      Parameters:
      environmentEncryption - The AWS KMS key that's used to encrypt your function's environment variables.
      Returns:
      this
    • ephemeralStorageSize

      @Stability(Stable) public FunctionProps.Builder ephemeralStorageSize(Size ephemeralStorageSize)
      Parameters:
      ephemeralStorageSize - The size of the function’s /tmp directory in MiB.
      Returns:
      this
    • events

      @Stability(Stable) public FunctionProps.Builder events(List<? extends IEventSource> events)
      Sets the value of FunctionOptions.getEvents()
      Parameters:
      events - Event sources for this function. You can also add event sources using addEventSource.
      Returns:
      this
    • filesystem

      @Stability(Stable) public FunctionProps.Builder filesystem(FileSystem filesystem)
      Parameters:
      filesystem - The filesystem configuration for the lambda function.
      Returns:
      this
    • functionName

      @Stability(Stable) public FunctionProps.Builder functionName(String functionName)
      Parameters:
      functionName - A name for the function.
      Returns:
      this
    • initialPolicy

      @Stability(Stable) public FunctionProps.Builder initialPolicy(List<? extends PolicyStatement> initialPolicy)
      Parameters:
      initialPolicy - Initial policy statements to add to the created Lambda Role. You can call addToRolePolicy to the created lambda to add statements post creation.
      Returns:
      this
    • insightsVersion

      @Stability(Stable) public FunctionProps.Builder insightsVersion(LambdaInsightsVersion insightsVersion)
      Parameters:
      insightsVersion - Specify the version of CloudWatch Lambda insights to use for monitoring.
      Returns:
      this
    • ipv6AllowedForDualStack

      @Stability(Stable) public FunctionProps.Builder ipv6AllowedForDualStack(Boolean ipv6AllowedForDualStack)
      Parameters:
      ipv6AllowedForDualStack - Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. Only used if 'vpc' is supplied.
      Returns:
      this
    • layers

      @Stability(Stable) public FunctionProps.Builder layers(List<? extends ILayerVersion> layers)
      Sets the value of FunctionOptions.getLayers()
      Parameters:
      layers - A list of layers to add to the function's execution environment. You can configure your Lambda function to pull in additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies that can be used by multiple functions.
      Returns:
      this
    • logFormat

      @Stability(Stable) public FunctionProps.Builder logFormat(String logFormat)
      Parameters:
      logFormat - Sets the logFormat for the function.
      Returns:
      this
    • loggingFormat

      @Stability(Stable) public FunctionProps.Builder loggingFormat(LoggingFormat loggingFormat)
      Parameters:
      loggingFormat - Sets the loggingFormat for the function.
      Returns:
      this
    • logGroup

      @Stability(Stable) public FunctionProps.Builder logGroup(ILogGroup logGroup)
      Parameters:
      logGroup - The log group the function sends logs to. By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/. However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention.

      Use the logGroup property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it.

      Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first.

      Returns:
      this
    • logRetention

      @Stability(Stable) public FunctionProps.Builder logRetention(RetentionDays logRetention)
      Parameters:
      logRetention - The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to INFINITE.

      This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with logs.LogGroup and use the logGroup property to instruct the Lambda function to send logs to it. Migrating from logRetention to logGroup will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust.

      In AWS CDK code, you can access the log group name directly from the LogGroup construct:

                           import software.amazon.awscdk.services.logs.*;
                           
                           LogGroup myLogGroup;
                           
                           myLogGroup.getLogGroupName();
                           
      Returns:
      this
    • logRetentionRetryOptions

      @Stability(Stable) public FunctionProps.Builder logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions)
      Parameters:
      logRetentionRetryOptions - When log retention is specified, a custom resource attempts to create the CloudWatch log group. These options control the retry policy when interacting with CloudWatch APIs.

      This is a legacy API and we strongly recommend you migrate to logGroup if you can. logGroup allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

      Returns:
      this
    • logRetentionRole

      @Stability(Stable) public FunctionProps.Builder logRetentionRole(IRole logRetentionRole)
      Parameters:
      logRetentionRole - The IAM role for the Lambda function associated with the custom resource that sets the retention policy. This is a legacy API and we strongly recommend you migrate to logGroup if you can. logGroup allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.
      Returns:
      this
    • memorySize

      @Stability(Stable) public FunctionProps.Builder memorySize(Number memorySize)
      Parameters:
      memorySize - The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide.
      Returns:
      this
    • paramsAndSecrets

      @Stability(Stable) public FunctionProps.Builder paramsAndSecrets(ParamsAndSecretsLayerVersion paramsAndSecrets)
      Parameters:
      paramsAndSecrets - Specify the configuration of Parameters and Secrets Extension.
      Returns:
      this
    • profiling

      @Stability(Stable) public FunctionProps.Builder profiling(Boolean profiling)
      Parameters:
      profiling - Enable profiling.
      Returns:
      this
    • profilingGroup

      @Stability(Stable) public FunctionProps.Builder profilingGroup(IProfilingGroup profilingGroup)
      Parameters:
      profilingGroup - Profiling Group.
      Returns:
      this
    • reservedConcurrentExecutions

      @Stability(Stable) public FunctionProps.Builder reservedConcurrentExecutions(Number reservedConcurrentExecutions)
      Parameters:
      reservedConcurrentExecutions - The maximum of concurrent executions you want to reserve for the function.
      Returns:
      this
    • role

      @Stability(Stable) public FunctionProps.Builder role(IRole role)
      Sets the value of FunctionOptions.getRole()
      Parameters:
      role - Lambda execution role. This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal.

      The default Role automatically has permissions granted for Lambda execution. If you provide a Role, you must add the relevant AWS managed policies yourself.

      The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and "service-role/AWSLambdaVPCAccessExecutionRole".

      Returns:
      this
    • runtimeManagementMode

      @Stability(Stable) public FunctionProps.Builder runtimeManagementMode(RuntimeManagementMode runtimeManagementMode)
      Parameters:
      runtimeManagementMode - Sets the runtime management configuration for a function's version.
      Returns:
      this
    • securityGroups

      @Stability(Stable) public FunctionProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
      Parameters:
      securityGroups - The list of security groups to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied.
      Returns:
      this
    • snapStart

      @Stability(Stable) public FunctionProps.Builder snapStart(SnapStartConf snapStart)
      Parameters:
      snapStart - Enable SnapStart for Lambda Function. SnapStart is currently supported only for Java 11, 17 runtime
      Returns:
      this
    • systemLogLevel

      @Stability(Stable) public FunctionProps.Builder systemLogLevel(String systemLogLevel)
      Parameters:
      systemLogLevel - Sets the system log level for the function.
      Returns:
      this
    • timeout

      @Stability(Stable) public FunctionProps.Builder timeout(Duration timeout)
      Parameters:
      timeout - The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time.
      Returns:
      this
    • tracing

      @Stability(Stable) public FunctionProps.Builder tracing(Tracing tracing)
      Parameters:
      tracing - Enable AWS X-Ray Tracing for Lambda Function.
      Returns:
      this
    • vpc

      @Stability(Stable) public FunctionProps.Builder vpc(IVpc vpc)
      Sets the value of FunctionOptions.getVpc()
      Parameters:
      vpc - VPC network to place Lambda network interfaces. Specify this if the Lambda function needs to access resources in a VPC. This is required when vpcSubnets is specified.
      Returns:
      this
    • vpcSubnets

      @Stability(Stable) public FunctionProps.Builder vpcSubnets(SubnetSelection vpcSubnets)
      Parameters:
      vpcSubnets - Where to place the network interfaces within the VPC. This requires vpc to be specified in order for interfaces to actually be placed in the subnets. If vpc is not specify, this will raise an error.

      Note: Internet access for Lambda Functions requires a NAT Gateway, so picking public subnets is not allowed (unless allowPublicSubnet is set to true).

      Returns:
      this
    • maxEventAge

      @Stability(Stable) public FunctionProps.Builder maxEventAge(Duration maxEventAge)
      Parameters:
      maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours
      Returns:
      this
    • onFailure

      @Stability(Stable) public FunctionProps.Builder onFailure(IDestination onFailure)
      Parameters:
      onFailure - The destination for failed invocations.
      Returns:
      this
    • onSuccess

      @Stability(Stable) public FunctionProps.Builder onSuccess(IDestination onSuccess)
      Parameters:
      onSuccess - The destination for successful invocations.
      Returns:
      this
    • retryAttempts

      @Stability(Stable) public FunctionProps.Builder retryAttempts(Number retryAttempts)
      Parameters:
      retryAttempts - The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2
      Returns:
      this
    • build

      @Stability(Stable) public FunctionProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<FunctionProps>
      Returns:
      a new instance of FunctionProps
      Throws:
      NullPointerException - if any required attribute was not provided