Interface CfnFunctionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFunctionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
date="2025-12-12T17:54:22.364Z")
@Stability(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.sam.*;
Object assumeRolePolicyDocument;
CfnFunctionProps cfnFunctionProps = CfnFunctionProps.builder()
.architectures(List.of("architectures"))
.assumeRolePolicyDocument(assumeRolePolicyDocument)
.autoPublishAlias("autoPublishAlias")
.autoPublishCodeSha256("autoPublishCodeSha256")
.codeSigningConfigArn("codeSigningConfigArn")
.codeUri("codeUri")
.deadLetterQueue(DeadLetterQueueProperty.builder()
.targetArn("targetArn")
.type("type")
.build())
.deploymentPreference(DeploymentPreferenceProperty.builder()
.alarms(List.of("alarms"))
.enabled(false)
.hooks(HooksProperty.builder()
.postTraffic("postTraffic")
.preTraffic("preTraffic")
.build())
.role("role")
.type("type")
.build())
.description("description")
.environment(FunctionEnvironmentProperty.builder()
.variables(Map.of(
"variablesKey", "variables"))
.build())
.ephemeralStorage(EphemeralStorageProperty.builder()
.size(123)
.build())
.eventInvokeConfig(EventInvokeConfigProperty.builder()
.destinationConfig(EventInvokeDestinationConfigProperty.builder()
.onFailure(DestinationProperty.builder()
.destination("destination")
// the properties below are optional
.type("type")
.build())
.onSuccess(DestinationProperty.builder()
.destination("destination")
// the properties below are optional
.type("type")
.build())
.build())
.maximumEventAgeInSeconds(123)
.maximumRetryAttempts(123)
.build())
.events(Map.of(
"eventsKey", EventSourceProperty.builder()
.properties(AlexaSkillEventProperty.builder()
.skillId("skillId")
.build())
.type("type")
.build()))
.fileSystemConfigs(List.of(FileSystemConfigProperty.builder()
.arn("arn")
.localMountPath("localMountPath")
.build()))
.functionName("functionName")
.functionUrlConfig(FunctionUrlConfigProperty.builder()
.authType("authType")
// the properties below are optional
.cors("cors")
.invokeMode("invokeMode")
.build())
.handler("handler")
.imageConfig(ImageConfigProperty.builder()
.command(List.of("command"))
.entryPoint(List.of("entryPoint"))
.workingDirectory("workingDirectory")
.build())
.imageUri("imageUri")
.inlineCode("inlineCode")
.kmsKeyArn("kmsKeyArn")
.layers(List.of("layers"))
.memorySize(123)
.packageType("packageType")
.permissionsBoundary("permissionsBoundary")
.policies("policies")
.provisionedConcurrencyConfig(ProvisionedConcurrencyConfigProperty.builder()
.provisionedConcurrentExecutions("provisionedConcurrentExecutions")
.build())
.reservedConcurrentExecutions(123)
.role("role")
.runtime("runtime")
.tags(Map.of(
"tagsKey", "tags"))
.timeout(123)
.tracing("tracing")
.versionDescription("versionDescription")
.vpcConfig(VpcConfigProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnFunctionPropsstatic final classAn implementation forCfnFunctionProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnFunctionProps.Builderbuilder()default Objectdefault Stringdefault Stringdefault Stringdefault Objectdefault ObjectReturns union: eitherIResolvableorCfnFunction.DeadLetterQueuePropertydefault ObjectReturns union: eitherIResolvableorCfnFunction.DeploymentPreferencePropertydefault Stringdefault ObjectReturns union: eitherIResolvableorCfnFunction.FunctionEnvironmentPropertydefault ObjectReturns union: eitherIResolvableorCfnFunction.EphemeralStoragePropertydefault ObjectReturns union: eitherIResolvableorCfnFunction.EventInvokeConfigPropertydefault ObjectReturns union: eitherIResolvableor Mapinvalid input: '<'String, eitherIResolvableorCfnFunction.EventSourceProperty>default ObjectReturns union: eitherIResolvableor Listinvalid input: '<'eitherIResolvableorCfnFunction.FileSystemConfigProperty>default Stringdefault ObjectReturns union: eitherIResolvableorCfnFunction.FunctionUrlConfigPropertydefault Stringdefault ObjectReturns union: eitherIResolvableorCfnFunction.ImageConfigPropertydefault Stringdefault Stringdefault Stringdefault Numberdefault Stringdefault Stringdefault ObjectReturns union: eitherStringorIResolvableorCfnFunction.IAMPolicyDocumentPropertyor Listinvalid input: '<'eitherStringorIResolvableorCfnFunction.IAMPolicyDocumentPropertyorCfnFunction.SAMPolicyTemplateProperty>default ObjectReturns union: eitherIResolvableorCfnFunction.ProvisionedConcurrencyConfigPropertydefault Numberdefault StringgetRole()default StringgetTags()default Numberdefault Stringdefault Stringdefault ObjectReturns union: eitherIResolvableorCfnFunction.VpcConfigPropertyMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getArchitectures
- See Also:
-
getAssumeRolePolicyDocument
- See Also:
-
getAutoPublishAlias
- See Also:
-
getAutoPublishCodeSha256
- See Also:
-
getCodeSigningConfigArn
- See Also:
-
getCodeUri
- See Also:
-
getDeadLetterQueue
Returns union: eitherIResolvableorCfnFunction.DeadLetterQueueProperty- See Also:
-
getDeploymentPreference
Returns union: eitherIResolvableorCfnFunction.DeploymentPreferenceProperty- See Also:
-
getDescription
- See Also:
-
getEnvironment
Returns union: eitherIResolvableorCfnFunction.FunctionEnvironmentProperty- See Also:
-
getEphemeralStorage
Returns union: eitherIResolvableorCfnFunction.EphemeralStorageProperty- See Also:
-
getEventInvokeConfig
Returns union: eitherIResolvableorCfnFunction.EventInvokeConfigProperty- See Also:
-
getEvents
Returns union: eitherIResolvableor Mapinvalid input: '<'String, eitherIResolvableorCfnFunction.EventSourceProperty>- See Also:
-
getFileSystemConfigs
Returns union: eitherIResolvableor Listinvalid input: '<'eitherIResolvableorCfnFunction.FileSystemConfigProperty>- See Also:
-
getFunctionName
- See Also:
-
getFunctionUrlConfig
Returns union: eitherIResolvableorCfnFunction.FunctionUrlConfigProperty- See Also:
-
getHandler
- See Also:
-
getImageConfig
Returns union: eitherIResolvableorCfnFunction.ImageConfigProperty- See Also:
-
getImageUri
- See Also:
-
getInlineCode
- See Also:
-
getKmsKeyArn
- See Also:
-
getLayers
- See Also:
-
getMemorySize
- See Also:
-
getPackageType
- See Also:
-
getPermissionsBoundary
- See Also:
-
getPolicies
Returns union: eitherStringorIResolvableorCfnFunction.IAMPolicyDocumentPropertyor Listinvalid input: '<'eitherStringorIResolvableorCfnFunction.IAMPolicyDocumentPropertyorCfnFunction.SAMPolicyTemplateProperty>- See Also:
-
getProvisionedConcurrencyConfig
Returns union: eitherIResolvableorCfnFunction.ProvisionedConcurrencyConfigProperty- See Also:
-
getReservedConcurrentExecutions
- See Also:
-
getRole
- See Also:
-
getRuntime
- See Also:
-
getTags
- See Also:
-
getTimeout
- See Also:
-
getTracing
- See Also:
-
getVersionDescription
- See Also:
-
getVpcConfig
Returns union: eitherIResolvableorCfnFunction.VpcConfigProperty- See Also:
-
builder
- Returns:
- a
CfnFunctionProps.BuilderofCfnFunctionProps
-