Package software.amazon.awscdk.services.lambda

Class CfnFunction

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.lambda.CfnFunction
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.618Z") @Stability(Stable) public class CfnFunction extends CfnResource implements IInspectable
A CloudFormation AWS::Lambda::Function.

The AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a deployment package and an execution role . The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.

You set the package type to Image if the deployment package is a container image . For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

You set the package type to Zip if the deployment package is a .zip file archive . For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see Deploy Python Lambda functions with .zip file archives .

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode , Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

Note that you configure provisioned concurrency on a AWS::Lambda::Version or a AWS::Lambda::Alias .

For a complete introduction to Lambda functions, see What is Lambda? in the Lambda developer guide.

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.*;
 CfnFunction cfnFunction = CfnFunction.Builder.create(this, "MyCfnFunction")
         .code(CodeProperty.builder()
                 .imageUri("imageUri")
                 .s3Bucket("s3Bucket")
                 .s3Key("s3Key")
                 .s3ObjectVersion("s3ObjectVersion")
                 .zipFile("zipFile")
                 .build())
         .role("role")
         // the properties below are optional
         .architectures(List.of("architectures"))
         .codeSigningConfigArn("codeSigningConfigArn")
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .targetArn("targetArn")
                 .build())
         .description("description")
         .environment(EnvironmentProperty.builder()
                 .variables(Map.of(
                         "variablesKey", "variables"))
                 .build())
         .ephemeralStorage(EphemeralStorageProperty.builder()
                 .size(123)
                 .build())
         .fileSystemConfigs(List.of(FileSystemConfigProperty.builder()
                 .arn("arn")
                 .localMountPath("localMountPath")
                 .build()))
         .functionName("functionName")
         .handler("handler")
         .imageConfig(ImageConfigProperty.builder()
                 .command(List.of("command"))
                 .entryPoint(List.of("entryPoint"))
                 .workingDirectory("workingDirectory")
                 .build())
         .kmsKeyArn("kmsKeyArn")
         .layers(List.of("layers"))
         .memorySize(123)
         .packageType("packageType")
         .reservedConcurrentExecutions(123)
         .runtime("runtime")
         .runtimeManagementConfig(RuntimeManagementConfigProperty.builder()
                 .updateRuntimeOn("updateRuntimeOn")
                 // the properties below are optional
                 .runtimeVersionArn("runtimeVersionArn")
                 .build())
         .snapStart(SnapStartProperty.builder()
                 .applyOn("applyOn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeout(123)
         .tracingConfig(TracingConfigProperty.builder()
                 .mode("mode")
                 .build())
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFunction

      protected CfnFunction(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFunction

      protected CfnFunction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFunction

      @Stability(Stable) public CfnFunction(@NotNull Construct scope, @NotNull String id, @NotNull CfnFunctionProps props)
      Create a new AWS::Lambda::Function.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the function.

    • getAttrSnapStartResponseApplyOn

      @Stability(Stable) @NotNull public String getAttrSnapStartResponseApplyOn()

    • getAttrSnapStartResponseOptimizationStatus

      @Stability(Stable) @NotNull public String getAttrSnapStartResponseOptimizationStatus()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of tags to apply to the function.

    • getCode

      @Stability(Stable) @NotNull public Object getCode()
      The code for the function.

    • setCode

      @Stability(Stable) public void setCode(@NotNull IResolvable value)
      The code for the function.

    • setCode

      @Stability(Stable) public void setCode(@NotNull CfnFunction.CodeProperty value)
      The code for the function.

    • getRole

      @Stability(Stable) @NotNull public String getRole()
      The Amazon Resource Name (ARN) of the function's execution role.

    • setRole

      @Stability(Stable) public void setRole(@NotNull String value)
      The Amazon Resource Name (ARN) of the function's execution role.

    • getArchitectures

      @Stability(Stable) @Nullable public List<String> getArchitectures()
      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 .

    • setArchitectures

      @Stability(Stable) public void setArchitectures(@Nullable List<String> value)
      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 .

    • getCodeSigningConfigArn

      @Stability(Stable) @Nullable public String getCodeSigningConfigArn()
      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.

    • setCodeSigningConfigArn

      @Stability(Stable) public void setCodeSigningConfigArn(@Nullable String value)
      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.

    • getDeadLetterConfig

      @Stability(Stable) @Nullable public Object getDeadLetterConfig()
      A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

      For more information, see Dead-letter queues .

    • setDeadLetterConfig

      @Stability(Stable) public void setDeadLetterConfig(@Nullable IResolvable value)
      A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

      For more information, see Dead-letter queues .

    • setDeadLetterConfig

      @Stability(Stable) public void setDeadLetterConfig(@Nullable CfnFunction.DeadLetterConfigProperty value)
      A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

      For more information, see Dead-letter queues .

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the function.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the function.

    • getEnvironment

      @Stability(Stable) @Nullable public Object getEnvironment()
      Environment variables that are accessible from function code during execution.

    • setEnvironment

      @Stability(Stable) public void setEnvironment(@Nullable IResolvable value)
      Environment variables that are accessible from function code during execution.

    • setEnvironment

      @Stability(Stable) public void setEnvironment(@Nullable CfnFunction.EnvironmentProperty value)
      Environment variables that are accessible from function code during execution.

    • getEphemeralStorage

      @Stability(Stable) @Nullable public Object getEphemeralStorage()
      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.

    • setEphemeralStorage

      @Stability(Stable) public void setEphemeralStorage(@Nullable IResolvable value)
      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.

    • setEphemeralStorage

      @Stability(Stable) public void setEphemeralStorage(@Nullable CfnFunction.EphemeralStorageProperty value)
      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.

    • getFileSystemConfigs

      @Stability(Stable) @Nullable public Object getFileSystemConfigs()
      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 .

    • setFileSystemConfigs

      @Stability(Stable) public void setFileSystemConfigs(@Nullable IResolvable value)
      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 .

    • setFileSystemConfigs

      @Stability(Stable) public void setFileSystemConfigs(@Nullable List<Object> value)
      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 .

    • getFunctionName

      @Stability(Stable) @Nullable public String getFunctionName()
      The name of the Lambda function, up to 64 characters in length.

      If you don't specify a name, AWS CloudFormation 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.

    • setFunctionName

      @Stability(Stable) public void setFunctionName(@Nullable String value)
      The name of the Lambda function, up to 64 characters in length.

      If you don't specify a name, AWS CloudFormation 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.

    • getHandler

      @Stability(Stable) @Nullable public String getHandler()
      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 .

    • setHandler

      @Stability(Stable) public void setHandler(@Nullable String value)
      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 .

    • getImageConfig

      @Stability(Stable) @Nullable public Object getImageConfig()
      Configuration values that override the container image Dockerfile settings.

      For more information, see Container image settings .

    • setImageConfig

      @Stability(Stable) public void setImageConfig(@Nullable IResolvable value)
      Configuration values that override the container image Dockerfile settings.

      For more information, see Container image settings .

    • setImageConfig

      @Stability(Stable) public void setImageConfig(@Nullable CfnFunction.ImageConfigProperty value)
      Configuration values that override the container image Dockerfile settings.

      For more information, see Container image settings .

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      The ARN of the AWS Key Management Service ( AWS 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.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      The ARN of the AWS Key Management Service ( AWS 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.

    • getLayers

      @Stability(Stable) @Nullable public List<String> getLayers()
      A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

    • setLayers

      @Stability(Stable) public void setLayers(@Nullable List<String> value)
      A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

    • getMemorySize

      @Stability(Stable) @Nullable public Number getMemorySize()
      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.

    • setMemorySize

      @Stability(Stable) public void setMemorySize(@Nullable Number value)
      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.

    • getPackageType

      @Stability(Stable) @Nullable public String getPackageType()
      The type of deployment package.

      Set to Image for container image and set Zip for .zip file archive.

    • setPackageType

      @Stability(Stable) public void setPackageType(@Nullable String value)
      The type of deployment package.

      Set to Image for container image and set Zip for .zip file archive.

    • getReservedConcurrentExecutions

      @Stability(Stable) @Nullable public Number getReservedConcurrentExecutions()
      The number of simultaneous executions to reserve for the function.

    • setReservedConcurrentExecutions

      @Stability(Stable) public void setReservedConcurrentExecutions(@Nullable Number value)
      The number of simultaneous executions to reserve for the function.

    • getRuntime

      @Stability(Stable) @Nullable public String getRuntime()
      The identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive.

      The following list includes deprecated runtimes. For more information, see Runtime deprecation policy .

    • setRuntime

      @Stability(Stable) public void setRuntime(@Nullable String value)
      The identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive.

      The following list includes deprecated runtimes. For more information, see Runtime deprecation policy .

    • getRuntimeManagementConfig

      @Stability(Stable) @Nullable public Object getRuntimeManagementConfig()
      Sets the runtime management configuration for a function's version.

      For more information, see Runtime updates .

    • setRuntimeManagementConfig

      @Stability(Stable) public void setRuntimeManagementConfig(@Nullable IResolvable value)
      Sets the runtime management configuration for a function's version.

      For more information, see Runtime updates .

    • setRuntimeManagementConfig

      @Stability(Stable) public void setRuntimeManagementConfig(@Nullable CfnFunction.RuntimeManagementConfigProperty value)
      Sets the runtime management configuration for a function's version.

      For more information, see Runtime updates .

    • getSnapStart

      @Stability(Stable) @Nullable public Object getSnapStart()
      The function's AWS Lambda SnapStart setting.

    • setSnapStart

      @Stability(Stable) public void setSnapStart(@Nullable IResolvable value)
      The function's AWS Lambda SnapStart setting.

    • setSnapStart

      @Stability(Stable) public void setSnapStart(@Nullable CfnFunction.SnapStartProperty value)
      The function's AWS Lambda SnapStart setting.

    • getTimeout

      @Stability(Stable) @Nullable public Number getTimeout()
      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 .

    • setTimeout

      @Stability(Stable) public void setTimeout(@Nullable Number value)
      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 .

    • getTracingConfig

      @Stability(Stable) @Nullable public Object getTracingConfig()
      Set Mode to Active to sample and trace a subset of incoming requests with X-Ray .

    • setTracingConfig

      @Stability(Stable) public void setTracingConfig(@Nullable IResolvable value)
      Set Mode to Active to sample and trace a subset of incoming requests with X-Ray .

    • setTracingConfig

      @Stability(Stable) public void setTracingConfig(@Nullable CfnFunction.TracingConfigProperty value)
      Set Mode to Active to sample and trace a subset of incoming requests with X-Ray .

    • getVpcConfig

      @Stability(Stable) @Nullable public Object getVpcConfig()
      For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

      When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC .

    • setVpcConfig

      @Stability(Stable) public void setVpcConfig(@Nullable IResolvable value)
      For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

      When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC .

    • setVpcConfig

      @Stability(Stable) public void setVpcConfig(@Nullable CfnFunction.VpcConfigProperty value)
      For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

      When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC .