Package software.amazon.awscdk.services.lambda

Class CfnFunctionProps.Builder

java.lang.Object
software.amazon.awscdk.services.lambda.CfnFunctionProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFunctionProps>
Enclosing interface:
CfnFunctionProps
@Stability(Stable) public static final class CfnFunctionProps.Builder extends Object implements software.amazon.jsii.Builder<CfnFunctionProps>
A builder for CfnFunctionProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • code

      @Stability(Stable) public CfnFunctionProps.Builder code(IResolvable code)
      Sets the value of CfnFunctionProps.getCode()
      Parameters:
      code - 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. 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. This parameter is required.
      Returns:
      this

    • code

      @Stability(Stable) public CfnFunctionProps.Builder code(CfnFunction.CodeProperty code)
      Sets the value of CfnFunctionProps.getCode()
      Parameters:
      code - 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. 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. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public CfnFunctionProps.Builder role(String role)
      Sets the value of CfnFunctionProps.getRole()
      Parameters:
      role - The Amazon Resource Name (ARN) of the function's execution role. This parameter is required.
      Returns:
      this

    • architectures

      @Stability(Stable) public CfnFunctionProps.Builder architectures(List<String> architectures)
      Sets the value of CfnFunctionProps.getArchitectures()
      Parameters:
      architectures - The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
      Returns:
      this

    • codeSigningConfigArn

      @Stability(Stable) public CfnFunctionProps.Builder codeSigningConfigArn(String codeSigningConfigArn)
      Sets the value of CfnFunctionProps.getCodeSigningConfigArn()
      Parameters:
      codeSigningConfigArn - To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
      Returns:
      this

    • deadLetterConfig

      @Stability(Stable) public CfnFunctionProps.Builder deadLetterConfig(IResolvable deadLetterConfig)
      Sets the value of CfnFunctionProps.getDeadLetterConfig()
      Parameters:
      deadLetterConfig - The dead-letter queue for failed asynchronous invocations.
      Returns:
      this

    • deadLetterConfig

      @Stability(Stable) public CfnFunctionProps.Builder deadLetterConfig(CfnFunction.DeadLetterConfigProperty deadLetterConfig)
      Sets the value of CfnFunctionProps.getDeadLetterConfig()
      Parameters:
      deadLetterConfig - The dead-letter queue for failed asynchronous invocations.
      Returns:
      this

    • description

      @Stability(Stable) public CfnFunctionProps.Builder description(String description)
      Sets the value of CfnFunctionProps.getDescription()
      Parameters:
      description - A description of the function.
      Returns:
      this

    • environment

      @Stability(Stable) public CfnFunctionProps.Builder environment(IResolvable environment)
      Sets the value of CfnFunctionProps.getEnvironment()
      Parameters:
      environment - A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.
      Returns:
      this

    • environment

      @Stability(Stable) public CfnFunctionProps.Builder environment(CfnFunction.EnvironmentProperty environment)
      Sets the value of CfnFunctionProps.getEnvironment()
      Parameters:
      environment - A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.
      Returns:
      this

    • ephemeralStorage

      @Stability(Stable) public CfnFunctionProps.Builder ephemeralStorage(IResolvable ephemeralStorage)
      Sets the value of CfnFunctionProps.getEphemeralStorage()
      Parameters:
      ephemeralStorage - The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
      Returns:
      this

    • ephemeralStorage

      @Stability(Stable) public CfnFunctionProps.Builder ephemeralStorage(CfnFunction.EphemeralStorageProperty ephemeralStorage)
      Sets the value of CfnFunctionProps.getEphemeralStorage()
      Parameters:
      ephemeralStorage - The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
      Returns:
      this

    • fileSystemConfigs

      @Stability(Stable) public CfnFunctionProps.Builder fileSystemConfigs(IResolvable fileSystemConfigs)
      Sets the value of CfnFunctionProps.getFileSystemConfigs()
      Parameters:
      fileSystemConfigs - Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. For more information about using the DependsOn attribute, see DependsOn Attribute.
      Returns:
      this

    • fileSystemConfigs

      @Stability(Stable) public CfnFunctionProps.Builder fileSystemConfigs(List<? extends Object> fileSystemConfigs)
      Sets the value of CfnFunctionProps.getFileSystemConfigs()
      Parameters:
      fileSystemConfigs - Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. For more information about using the DependsOn attribute, see DependsOn Attribute.
      Returns:
      this

    • functionName

      @Stability(Stable) public CfnFunctionProps.Builder functionName(String functionName)
      Sets the value of CfnFunctionProps.getFunctionName()
      Parameters:
      functionName - The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
      Returns:
      this

    • handler

      @Stability(Stable) public CfnFunctionProps.Builder handler(String handler)
      Sets the value of CfnFunctionProps.getHandler()
      Parameters:
      handler - The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.
      Returns:
      this

    • imageConfig

      @Stability(Stable) public CfnFunctionProps.Builder imageConfig(IResolvable imageConfig)
      Sets the value of CfnFunctionProps.getImageConfig()
      Parameters:
      imageConfig - Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
      Returns:
      this

    • imageConfig

      @Stability(Stable) public CfnFunctionProps.Builder imageConfig(CfnFunction.ImageConfigProperty imageConfig)
      Sets the value of CfnFunctionProps.getImageConfig()
      Parameters:
      imageConfig - Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
      Returns:
      this

    • kmsKeyArn

      @Stability(Stable) public CfnFunctionProps.Builder kmsKeyArn(String kmsKeyArn)
      Sets the value of CfnFunctionProps.getKmsKeyArn()
      Parameters:
      kmsKeyArn - The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
      Returns:
      this

    • layers

      @Stability(Stable) public CfnFunctionProps.Builder layers(List<String> layers)
      Sets the value of CfnFunctionProps.getLayers()
      Parameters:
      layers - A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
      Returns:
      this

    • loggingConfig

      @Stability(Stable) public CfnFunctionProps.Builder loggingConfig(IResolvable loggingConfig)
      Sets the value of CfnFunctionProps.getLoggingConfig()
      Parameters:
      loggingConfig - The function's Amazon CloudWatch Logs configuration settings.
      Returns:
      this

    • loggingConfig

      @Stability(Stable) public CfnFunctionProps.Builder loggingConfig(CfnFunction.LoggingConfigProperty loggingConfig)
      Sets the value of CfnFunctionProps.getLoggingConfig()
      Parameters:
      loggingConfig - The function's Amazon CloudWatch Logs configuration settings.
      Returns:
      this

    • memorySize

      @Stability(Stable) public CfnFunctionProps.Builder memorySize(Number memorySize)
      Sets the value of CfnFunctionProps.getMemorySize()
      Parameters:
      memorySize - The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
      Returns:
      this

    • packageType

      @Stability(Stable) public CfnFunctionProps.Builder packageType(String packageType)
      Sets the value of CfnFunctionProps.getPackageType()
      Parameters:
      packageType - The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
      Returns:
      this

    • recursiveLoop

      @Stability(Stable) public CfnFunctionProps.Builder recursiveLoop(String recursiveLoop)
      Sets the value of CfnFunctionProps.getRecursiveLoop()
      Parameters:
      recursiveLoop - This property is set to terminate unintended recursions. If set to Terminate, Lambda detects and terminates unitended recursive loops. If set to Allow Lambda lets recursions be and does not terminate it.
      Returns:
      this

    • reservedConcurrentExecutions

      @Stability(Stable) public CfnFunctionProps.Builder reservedConcurrentExecutions(Number reservedConcurrentExecutions)
      Sets the value of CfnFunctionProps.getReservedConcurrentExecutions()
      Parameters:
      reservedConcurrentExecutions - The number of simultaneous executions to reserve for the function.
      Returns:
      this

    • runtime

      @Stability(Stable) public CfnFunctionProps.Builder runtime(String runtime)
      Sets the value of CfnFunctionProps.getRuntime()
      Parameters:
      runtime - The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation. For a list of all currently supported runtimes, see Supported runtimes.
      Returns:
      this

    • runtimeManagementConfig

      @Stability(Stable) public CfnFunctionProps.Builder runtimeManagementConfig(IResolvable runtimeManagementConfig)
      Sets the value of CfnFunctionProps.getRuntimeManagementConfig()
      Parameters:
      runtimeManagementConfig - Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
      Returns:
      this

    • runtimeManagementConfig

      @Stability(Stable) public CfnFunctionProps.Builder runtimeManagementConfig(CfnFunction.RuntimeManagementConfigProperty runtimeManagementConfig)
      Sets the value of CfnFunctionProps.getRuntimeManagementConfig()
      Parameters:
      runtimeManagementConfig - Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
      Returns:
      this

    • snapStart

      @Stability(Stable) public CfnFunctionProps.Builder snapStart(IResolvable snapStart)
      Sets the value of CfnFunctionProps.getSnapStart()
      Parameters:
      snapStart - The function's SnapStart setting.
      Returns:
      this

    • snapStart

      @Stability(Stable) public CfnFunctionProps.Builder snapStart(CfnFunction.SnapStartProperty snapStart)
      Sets the value of CfnFunctionProps.getSnapStart()
      Parameters:
      snapStart - The function's SnapStart setting.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnFunctionProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnFunctionProps.getTags()
      Parameters:
      tags - A list of tags to apply to the function.
      Returns:
      this

    • timeout

      @Stability(Stable) public CfnFunctionProps.Builder timeout(Number timeout)
      Sets the value of CfnFunctionProps.getTimeout()
      Parameters:
      timeout - The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
      Returns:
      this

    • tracingConfig

      @Stability(Stable) public CfnFunctionProps.Builder tracingConfig(IResolvable tracingConfig)
      Sets the value of CfnFunctionProps.getTracingConfig()
      Parameters:
      tracingConfig - The function's tracing configuration. To sample and record incoming requests, set Mode to Active.
      Returns:
      this

    • tracingConfig

      @Stability(Stable) public CfnFunctionProps.Builder tracingConfig(CfnFunction.TracingConfigProperty tracingConfig)
      Sets the value of CfnFunctionProps.getTracingConfig()
      Parameters:
      tracingConfig - The function's tracing configuration. To sample and record incoming requests, set Mode to Active.
      Returns:
      this

    • vpcConfig

      @Stability(Stable) public CfnFunctionProps.Builder vpcConfig(IResolvable vpcConfig)
      Sets the value of CfnFunctionProps.getVpcConfig()
      Parameters:
      vpcConfig - The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see VPC Settings. When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the ec2:DescribeNetworkInterfaces permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.
      Returns:
      this

    • vpcConfig

      @Stability(Stable) public CfnFunctionProps.Builder vpcConfig(CfnFunction.VpcConfigProperty vpcConfig)
      Sets the value of CfnFunctionProps.getVpcConfig()
      Parameters:
      vpcConfig - The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see VPC Settings. When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the ec2:DescribeNetworkInterfaces permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.
      Returns:
      this

    • build

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