Interface CfnFunctionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFunctionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-12T12:32:10.931Z")
@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 class
A builder forCfnFunctionProps
static final class
An implementation forCfnFunctionProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnFunctionProps.Builder
builder()
default Object
default String
default String
default String
default Object
default Object
default Object
default String
default Object
default Object
default Object
default Object
default Object
default String
default Object
default String
default Object
default String
default String
default String
default Number
default String
default String
default Object
default Object
default Number
default String
getRole()
default String
getTags()
default Number
default String
default String
default Object
Methods 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
- See Also:
-
getDeploymentPreference
- See Also:
-
getDescription
- See Also:
-
getEnvironment
- See Also:
-
getEphemeralStorage
- See Also:
-
getEventInvokeConfig
- See Also:
-
getEvents
- See Also:
-
getFileSystemConfigs
- See Also:
-
getFunctionName
- See Also:
-
getFunctionUrlConfig
- See Also:
-
getHandler
- See Also:
-
getImageConfig
- See Also:
-
getImageUri
- See Also:
-
getInlineCode
- See Also:
-
getKmsKeyArn
- See Also:
-
getLayers
- See Also:
-
getMemorySize
- See Also:
-
getPackageType
- See Also:
-
getPermissionsBoundary
- See Also:
-
getPolicies
- See Also:
-
getProvisionedConcurrencyConfig
- See Also:
-
getReservedConcurrentExecutions
- See Also:
-
getRole
- See Also:
-
getRuntime
- See Also:
-
getTags
- See Also:
-
getTimeout
- See Also:
-
getTracing
- See Also:
-
getVersionDescription
- See Also:
-
getVpcConfig
- See Also:
-
builder
- Returns:
- a
CfnFunctionProps.Builder
ofCfnFunctionProps
-