Interface CfnFunctionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFunctionProps.Jsii$Proxy
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")) .loggingConfig(LoggingConfigProperty.builder() .applicationLogLevel("applicationLogLevel") .logFormat("logFormat") .logGroup("logGroup") .systemLogLevel("systemLogLevel") .build()) .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() .ipv6AllowedForDualStack(false) .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnFunctionProps
static final class
An implementation forCfnFunctionProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnFunctionProps.Builder
builder()
The instruction set architecture that the function supports.getCode()
The code for the function.default String
To enable code signing for this function, specify the ARN of a code-signing configuration.default Object
A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.default String
A description of the function.default Object
Environment variables that are accessible from function code during execution.default Object
The size of the function's/tmp
directory in MB.default Object
Connection settings for an Amazon EFS file system.default String
The name of the Lambda function, up to 64 characters in length.default String
The name of the method within your code that Lambda calls to run your function.default Object
Configuration values that override the container image Dockerfile settings.default String
The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt your function's environment variables .A list of function layers to add to the function's execution environment.default Object
The function's Amazon CloudWatch Logs configuration settings.default Number
The amount of memory available to the function at runtime.default String
The type of deployment package.default Number
The number of simultaneous executions to reserve for the function.getRole()
The Amazon Resource Name (ARN) of the function's execution role.default String
The identifier of the function's runtime .default Object
Sets the runtime management configuration for a function's version.default Object
The function's AWS Lambda SnapStart setting.getTags()
A list of tags to apply to the function.default Number
The amount of time (in seconds) that Lambda allows a function to run before stopping it.default Object
default Object
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 Details
-
getCode
The code for the function.- See Also:
-
getRole
The Amazon Resource Name (ARN) of the function's execution role.- See Also:
-
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
.- See Also:
-
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.
- See Also:
-
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 .
- See Also:
-
getDescription
A description of the function.- See Also:
-
getEnvironment
Environment variables that are accessible from function code during execution.- See Also:
-
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.
- See Also:
-
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 .- See Also:
-
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.
- See Also:
-
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 .
- See Also:
-
getImageConfig
Configuration values that override the container image Dockerfile settings.For more information, see Container image settings .
- See Also:
-
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.- See Also:
-
getLayers
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.- See Also:
-
getLoggingConfig
The function's Amazon CloudWatch Logs configuration settings.- See Also:
-
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. 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.- See Also:
-
getPackageType
The type of deployment package.Set to
Image
for container image and setZip
for .zip file archive.- See Also:
-
getReservedConcurrentExecutions
The number of simultaneous executions to reserve for the function.- See Also:
-
getRuntime
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 .
- See Also:
-
getRuntimeManagementConfig
Sets the runtime management configuration for a function's version.For more information, see Runtime updates .
- See Also:
-
getSnapStart
The function's AWS Lambda SnapStart setting.- See Also:
-
getTags
A list of tags to apply to the function.- See Also:
-
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 .
- See Also:
-
getTracingConfig
- See Also:
-
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 .
- See Also:
-
builder
- Returns:
- a
CfnFunctionProps.Builder
ofCfnFunctionProps
-