Skip to content
v2.273.0

BaseAppsyncFunctionProps Struct ​

the base properties for AppSync Functions.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';

declare const code: appsync.Code;
declare const functionRuntime: appsync.FunctionRuntime;
declare const mappingTemplate: appsync.MappingTemplate;
const baseAppsyncFunctionProps: appsync.BaseAppsyncFunctionProps = {
  name: 'name',

  // the properties below are optional
  code: code,
  description: 'description',
  maxBatchSize: 123,
  requestMappingTemplate: mappingTemplate,
  responseMappingTemplate: mappingTemplate,
  runtime: functionRuntime,
};

Properties ​

codeCodecodeCodecodeCodeCodeCodeCodeCode= no code is used#
The function code.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#
the description for this AppSync Function.
maxBatchSizenumbermax_batch_sizeint | floatmaxBatchSizeNumberMaxBatchSizedoubleMaxBatchSize*float64= No max batch size#
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.

namestringnamestrnameStringNamestringName*stringrequired#
the name of the AppSync Function.
requestMappingTemplateMappingTemplaterequest_mapping_templateMappingTemplaterequestMappingTemplateMappingTemplateRequestMappingTemplateMappingTemplateRequestMappingTemplateMappingTemplate= no request mapping template#
the request mapping template for the AppSync Function.
responseMappingTemplateMappingTemplateresponse_mapping_templateMappingTemplateresponseMappingTemplateMappingTemplateResponseMappingTemplateMappingTemplateResponseMappingTemplateMappingTemplate= no response mapping template#
the response mapping template for the AppSync Function.
runtimeFunctionRuntimeruntimeFunctionRuntimeruntimeFunctionRuntimeRuntimeFunctionRuntimeRuntimeFunctionRuntime= no function runtime, VTL mapping…#
The functions runtime.
default

Default: no function runtime, VTL mapping templates used