CfnFunctionProps (software.amazon.awscdk:lambda 1.201.0 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-10T17:05:56.447Z")
 @Stability(value=Stable)
public interface CfnFunctionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnFunction`.

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.*;
 CfnFunctionProps cfnFunctionProps = CfnFunctionProps.builder()
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnFunctionProps.Builder` A builder for `CfnFunctionProps`
`static class`	`CfnFunctionProps.Jsii$Proxy` An implementation for `CfnFunctionProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnFunctionProps.Builder`	`builder()`
`default List<String>`	`getArchitectures()` The instruction set architecture that the function supports.
`Object`	`getCode()` The code for the function.
`default String`	`getCodeSigningConfigArn()` To enable code signing for this function, specify the ARN of a code-signing configuration.
`default Object`	`getDeadLetterConfig()` A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
`default String`	`getDescription()` A description of the function.
`default Object`	`getEnvironment()` Environment variables that are accessible from function code during execution.
`default Object`	`getEphemeralStorage()` The size of the function's `/tmp` directory in MB.
`default Object`	`getFileSystemConfigs()` Connection settings for an Amazon EFS file system.
`default String`	`getFunctionName()` The name of the Lambda function, up to 64 characters in length.
`default String`	`getHandler()` The name of the method within your code that Lambda calls to run your function.
`default Object`	`getImageConfig()` Configuration values that override the container image Dockerfile settings.
`default 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](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) .
`default List<String>`	`getLayers()` A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment.
`default Number`	`getMemorySize()` The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime.
`default String`	`getPackageType()` The type of deployment package.
`default Number`	`getReservedConcurrentExecutions()` The number of simultaneous executions to reserve for the function.
`String`	`getRole()` The Amazon Resource Name (ARN) of the function's execution role.
`default String`	`getRuntime()` The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) .
`default Object`	`getRuntimeManagementConfig()` Sets the runtime management configuration for a function's version.
`default Object`	`getSnapStart()` The function's [AWS Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
`default List<CfnTag>`	`getTags()` A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
`default Number`	`getTimeout()` The amount of time (in seconds) that Lambda allows a function to run before stopping it.
`default Object`	`getTracingConfig()` Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) .
`default Object`	`getVpcConfig()` For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getCode
```
@Stability(value=Stable)
 @NotNull
Object getCode()
```
    The code for the function.
  - getRole
```
@Stability(value=Stable)
 @NotNull
String getRole()
```
    The Amazon Resource Name (ARN) of the function's execution role.
  - getArchitectures
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getCodeSigningConfigArn
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getDeadLetterConfig
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getDescription
```
@Stability(value=Stable)
 @Nullable
default String getDescription()
```
    A description of the function.
  - getEnvironment
```
@Stability(value=Stable)
 @Nullable
default Object getEnvironment()
```
    Environment variables that are accessible from function code during execution.
  - getEphemeralStorage
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getFileSystemConfigs
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getFunctionName
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getHandler
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getImageConfig
```
@Stability(value=Stable)
 @Nullable
default Object getImageConfig()
```
    Configuration values that override the container image Dockerfile settings.
    For more information, see Container image settings .
  - getKmsKeyArn
```
@Stability(value=Stable)
 @Nullable
default 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](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) . When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, this key is also used to encrypt your function's snapshot. If you don't provide a customer managed key, Lambda uses a default service key.
  - getLayers
```
@Stability(value=Stable)
 @Nullable
default List<String> getLayers()
```
    A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.
  - getMemorySize
```
@Stability(value=Stable)
 @Nullable
default Number getMemorySize()
```
    The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) 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(value=Stable)
 @Nullable
default String getPackageType()
```
    The type of deployment package.
    Set to Image for container image and set Zip for .zip file archive.
  - getReservedConcurrentExecutions
```
@Stability(value=Stable)
 @Nullable
default Number getReservedConcurrentExecutions()
```
    The number of simultaneous executions to reserve for the function.
  - getRuntime
```
@Stability(value=Stable)
 @Nullable
default String getRuntime()
```
    The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . 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(value=Stable)
 @Nullable
default Object getRuntimeManagementConfig()
```
    Sets the runtime management configuration for a function's version.
    For more information, see Runtime updates .
  - getSnapStart
```
@Stability(value=Stable)
 @Nullable
default Object getSnapStart()
```
    The function's [AWS Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()
```
    A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
  - getTimeout
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getTracingConfig
```
@Stability(value=Stable)
 @Nullable
default Object getTracingConfig()
```
    Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) .
  - getVpcConfig
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - builder
```
@Stability(value=Stable)
static CfnFunctionProps.Builder builder()
```
    Returns:
    
    a CfnFunctionProps.Builder of CfnFunctionProps

Interface CfnFunctionProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getCode

getRole

getArchitectures

getCodeSigningConfigArn

getDeadLetterConfig

getDescription

getEnvironment

getEphemeralStorage

getFileSystemConfigs

getFunctionName

getHandler

getImageConfig

getKmsKeyArn

getLayers

getMemorySize

getPackageType

getReservedConcurrentExecutions

getRuntime

getRuntimeManagementConfig

getSnapStart

getTags

getTimeout

getTracingConfig

getVpcConfig

builder