software.amazon.awscdk.services.lambda

Interface CfnFunctionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.257Z")
 @Stability(value=Stable)
public interface CfnFunctionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Lambda::Function`.

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())
         .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")
         .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

Modifier and Type	Method and Description
static CfnFunctionProps.Builder	builder()
default List<String>	getArchitectures() `AWS::Lambda::Function.Architectures`.
Object	getCode() `AWS::Lambda::Function.Code`.
default String	getCodeSigningConfigArn() `AWS::Lambda::Function.CodeSigningConfigArn`.
default Object	getDeadLetterConfig() `AWS::Lambda::Function.DeadLetterConfig`.
default String	getDescription() `AWS::Lambda::Function.Description`.
default Object	getEnvironment() `AWS::Lambda::Function.Environment`.
default Object	getFileSystemConfigs() `AWS::Lambda::Function.FileSystemConfigs`.
default String	getFunctionName() `AWS::Lambda::Function.FunctionName`.
default String	getHandler() `AWS::Lambda::Function.Handler`.
default Object	getImageConfig() `AWS::Lambda::Function.ImageConfig`.
default String	getKmsKeyArn() `AWS::Lambda::Function.KmsKeyArn`.
default List<String>	getLayers() `AWS::Lambda::Function.Layers`.
default Number	getMemorySize() `AWS::Lambda::Function.MemorySize`.
default String	getPackageType() `AWS::Lambda::Function.PackageType`.
default Number	getReservedConcurrentExecutions() `AWS::Lambda::Function.ReservedConcurrentExecutions`.
String	getRole() `AWS::Lambda::Function.Role`.
default String	getRuntime() `AWS::Lambda::Function.Runtime`.
default List<CfnTag>	getTags() `AWS::Lambda::Function.Tags`.
default Number	getTimeout() `AWS::Lambda::Function.Timeout`.
default Object	getTracingConfig() `AWS::Lambda::Function.TracingConfig`.
default Object	getVpcConfig() `AWS::Lambda::Function.VpcConfig`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArchitectures

@Stability(value=Stable)
 @Nullable
default List<String> getArchitectures()

`AWS::Lambda::Function.Architectures`.

getCode

@Stability(value=Stable)
 @NotNull
Object getCode()

`AWS::Lambda::Function.Code`.

getCodeSigningConfigArn

@Stability(value=Stable)
 @Nullable
default String getCodeSigningConfigArn()

`AWS::Lambda::Function.CodeSigningConfigArn`.

getDeadLetterConfig

@Stability(value=Stable)
 @Nullable
default Object getDeadLetterConfig()

`AWS::Lambda::Function.DeadLetterConfig`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::Lambda::Function.Description`.

getEnvironment

@Stability(value=Stable)
 @Nullable
default Object getEnvironment()

`AWS::Lambda::Function.Environment`.

getFileSystemConfigs

@Stability(value=Stable)
 @Nullable
default Object getFileSystemConfigs()

`AWS::Lambda::Function.FileSystemConfigs`.

getFunctionName

@Stability(value=Stable)
 @Nullable
default String getFunctionName()

`AWS::Lambda::Function.FunctionName`.

getHandler

@Stability(value=Stable)
 @Nullable
default String getHandler()

`AWS::Lambda::Function.Handler`.

getImageConfig

@Stability(value=Stable)
 @Nullable
default Object getImageConfig()

`AWS::Lambda::Function.ImageConfig`.

getKmsKeyArn

@Stability(value=Stable)
 @Nullable
default String getKmsKeyArn()

`AWS::Lambda::Function.KmsKeyArn`.

getLayers

@Stability(value=Stable)
 @Nullable
default List<String> getLayers()

`AWS::Lambda::Function.Layers`.

getMemorySize

@Stability(value=Stable)
 @Nullable
default Number getMemorySize()

`AWS::Lambda::Function.MemorySize`.

getPackageType

@Stability(value=Stable)
 @Nullable
default String getPackageType()

`AWS::Lambda::Function.PackageType`.

getReservedConcurrentExecutions

@Stability(value=Stable)
 @Nullable
default Number getReservedConcurrentExecutions()

`AWS::Lambda::Function.ReservedConcurrentExecutions`.

getRole

@Stability(value=Stable)
 @NotNull
String getRole()

`AWS::Lambda::Function.Role`.

getRuntime

@Stability(value=Stable)
 @Nullable
default String getRuntime()

`AWS::Lambda::Function.Runtime`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::Lambda::Function.Tags`.

getTimeout

@Stability(value=Stable)
 @Nullable
default Number getTimeout()

`AWS::Lambda::Function.Timeout`.

getTracingConfig

@Stability(value=Stable)
 @Nullable
default Object getTracingConfig()

`AWS::Lambda::Function.TracingConfig`.

getVpcConfig

@Stability(value=Stable)
 @Nullable
default Object getVpcConfig()

`AWS::Lambda::Function.VpcConfig`.

builder

@Stability(value=Stable)
static CfnFunctionProps.Builder builder()

Returns:

a CfnFunctionProps.Builder of CfnFunctionProps