Package software.amazon.awscdk.services.sam

Interface CfnFunctionProps

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-31T18:44:07.450Z") @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()
                 .enabled(false)
                 .type("type")
                 // the properties below are optional
                 .alarms(List.of("alarms"))
                 .hooks(HooksProperty.builder()
                         .postTraffic("postTraffic")
                         .preTraffic("preTraffic")
                         .build())
                 .build())
         .description("description")
         .environment(FunctionEnvironmentProperty.builder()
                 .variables(Map.of(
                         "variablesKey", "variables"))
                 .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(S3EventProperty.builder()
                                 .variables(Map.of(
                                         "variablesKey", "variables"))
                                 .build())
                         .type("type")
                         .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())
         .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();

  • Method Details

    • getArchitectures

      @Stability(Stable) @Nullable default List<String> getArchitectures()
      `AWS::Serverless::Function.Architectures`.

    • getAssumeRolePolicyDocument

      @Stability(Stable) @Nullable default Object getAssumeRolePolicyDocument()
      `AWS::Serverless::Function.AssumeRolePolicyDocument`.

    • getAutoPublishAlias

      @Stability(Stable) @Nullable default String getAutoPublishAlias()
      `AWS::Serverless::Function.AutoPublishAlias`.

    • getAutoPublishCodeSha256

      @Stability(Stable) @Nullable default String getAutoPublishCodeSha256()
      `AWS::Serverless::Function.AutoPublishCodeSha256`.

    • getCodeSigningConfigArn

      @Stability(Stable) @Nullable default String getCodeSigningConfigArn()
      `AWS::Serverless::Function.CodeSigningConfigArn`.

    • getCodeUri

      @Stability(Stable) @Nullable default Object getCodeUri()
      `AWS::Serverless::Function.CodeUri`.

    • getDeadLetterQueue

      @Stability(Stable) @Nullable default Object getDeadLetterQueue()
      `AWS::Serverless::Function.DeadLetterQueue`.

    • getDeploymentPreference

      @Stability(Stable) @Nullable default Object getDeploymentPreference()
      `AWS::Serverless::Function.DeploymentPreference`.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      `AWS::Serverless::Function.Description`.

    • getEnvironment

      @Stability(Stable) @Nullable default Object getEnvironment()
      `AWS::Serverless::Function.Environment`.

    • getEventInvokeConfig

      @Stability(Stable) @Nullable default Object getEventInvokeConfig()
      `AWS::Serverless::Function.EventInvokeConfig`.

    • getEvents

      @Stability(Stable) @Nullable default Object getEvents()
      `AWS::Serverless::Function.Events`.

    • getFileSystemConfigs

      @Stability(Stable) @Nullable default Object getFileSystemConfigs()
      `AWS::Serverless::Function.FileSystemConfigs`.

    • getFunctionName

      @Stability(Stable) @Nullable default String getFunctionName()
      `AWS::Serverless::Function.FunctionName`.

    • getHandler

      @Stability(Stable) @Nullable default String getHandler()
      `AWS::Serverless::Function.Handler`.

    • getImageConfig

      @Stability(Stable) @Nullable default Object getImageConfig()
      `AWS::Serverless::Function.ImageConfig`.

    • getImageUri

      @Stability(Stable) @Nullable default String getImageUri()
      `AWS::Serverless::Function.ImageUri`.

    • getInlineCode

      @Stability(Stable) @Nullable default String getInlineCode()
      `AWS::Serverless::Function.InlineCode`.

    • getKmsKeyArn

      @Stability(Stable) @Nullable default String getKmsKeyArn()
      `AWS::Serverless::Function.KmsKeyArn`.

    • getLayers

      @Stability(Stable) @Nullable default List<String> getLayers()
      `AWS::Serverless::Function.Layers`.

    • getMemorySize

      @Stability(Stable) @Nullable default Number getMemorySize()
      `AWS::Serverless::Function.MemorySize`.

    • getPackageType

      @Stability(Stable) @Nullable default String getPackageType()
      `AWS::Serverless::Function.PackageType`.

    • getPermissionsBoundary

      @Stability(Stable) @Nullable default String getPermissionsBoundary()
      `AWS::Serverless::Function.PermissionsBoundary`.

    • getPolicies

      @Stability(Stable) @Nullable default Object getPolicies()
      `AWS::Serverless::Function.Policies`.

    • getProvisionedConcurrencyConfig

      @Stability(Stable) @Nullable default Object getProvisionedConcurrencyConfig()
      `AWS::Serverless::Function.ProvisionedConcurrencyConfig`.

    • getReservedConcurrentExecutions

      @Stability(Stable) @Nullable default Number getReservedConcurrentExecutions()
      `AWS::Serverless::Function.ReservedConcurrentExecutions`.

    • getRole

      @Stability(Stable) @Nullable default String getRole()
      `AWS::Serverless::Function.Role`.

    • getRuntime

      @Stability(Stable) @Nullable default String getRuntime()
      `AWS::Serverless::Function.Runtime`.

    • getTags

      @Stability(Stable) @Nullable default Map<String,String> getTags()
      `AWS::Serverless::Function.Tags`.

    • getTimeout

      @Stability(Stable) @Nullable default Number getTimeout()
      `AWS::Serverless::Function.Timeout`.

    • getTracing

      @Stability(Stable) @Nullable default String getTracing()
      `AWS::Serverless::Function.Tracing`.

    • getVersionDescription

      @Stability(Stable) @Nullable default String getVersionDescription()
      `AWS::Serverless::Function.VersionDescription`.

    • getVpcConfig

      @Stability(Stable) @Nullable default Object getVpcConfig()
      `AWS::Serverless::Function.VpcConfig`.

    • builder

      @Stability(Stable) static CfnFunctionProps.Builder builder()
      Returns:
      a CfnFunctionProps.Builder of CfnFunctionProps