Package software.amazon.awscdk.services.appsync

Interface BaseAppsyncFunctionProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
AppsyncFunctionProps
All Known Implementing Classes:
AppsyncFunctionProps.Jsii$Proxy, BaseAppsyncFunctionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:09:58.886Z") @Stability(Stable) public interface BaseAppsyncFunctionProps extends software.amazon.jsii.JsiiSerializable
the base properties for AppSync Functions.

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.appsync.*;
 Code code;
 FunctionRuntime functionRuntime;
 MappingTemplate mappingTemplate;
 BaseAppsyncFunctionProps baseAppsyncFunctionProps = BaseAppsyncFunctionProps.builder()
         .name("name")
         // the properties below are optional
         .code(code)
         .description("description")
         .maxBatchSize(123)
         .requestMappingTemplate(mappingTemplate)
         .responseMappingTemplate(mappingTemplate)
         .runtime(functionRuntime)
         .build();

  • Method Details

    • getName

      @Stability(Stable) @NotNull String getName()
      the name of the AppSync Function.

    • getCode

      @Stability(Stable) @Nullable default Code getCode()
      The function code.

      Default: - no code is used

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      the description for this AppSync Function.

      Default: - no description

    • getMaxBatchSize

      @Stability(Stable) @Nullable default Number getMaxBatchSize()
      The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.

      Can only be set when using LambdaDataSource.

      Default: - No max batch size

    • getRequestMappingTemplate

      @Stability(Stable) @Nullable default MappingTemplate getRequestMappingTemplate()
      the request mapping template for the AppSync Function.

      Default: - no request mapping template

    • getResponseMappingTemplate

      @Stability(Stable) @Nullable default MappingTemplate getResponseMappingTemplate()
      the response mapping template for the AppSync Function.

      Default: - no response mapping template

    • getRuntime

      @Stability(Stable) @Nullable default FunctionRuntime getRuntime()
      The functions runtime.

      Default: - no function runtime, VTL mapping templates used

    • builder

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