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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync
# code: appsync.Code
# function_runtime: appsync.FunctionRuntime
# mapping_template: appsync.MappingTemplate
base_appsync_function_props = appsync.BaseAppsyncFunctionProps(
name="name",
# the properties below are optional
code=code,
description="description",
max_batch_size=123,
request_mapping_template=mapping_template,
response_mapping_template=mapping_template,
runtime=function_runtime
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
Code code;
FunctionRuntime functionRuntime;
MappingTemplate mappingTemplate;
var baseAppsyncFunctionProps = new BaseAppsyncFunctionProps {
Name = "name",
// the properties below are optional
Code = code,
Description = "description",
MaxBatchSize = 123,
RequestMappingTemplate = mappingTemplate,
ResponseMappingTemplate = mappingTemplate,
Runtime = functionRuntime
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var code Code
var functionRuntime FunctionRuntime
var mappingTemplate MappingTemplate
baseAppsyncFunctionProps := &BaseAppsyncFunctionProps{
Name: jsii.String("name"),
// the properties below are optional
Code: code,
Description: jsii.String("description"),
MaxBatchSize: jsii.Number(123),
RequestMappingTemplate: mappingTemplate,
ResponseMappingTemplate: mappingTemplate,
Runtime: functionRuntime,
}
Properties
The function code.
Default: no code is used
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#the description for this AppSync Function.
Default: no description
maxBatchSizeoptionalnumbermax_batch_sizeoptionalint | floatmaxBatchSizeoptionalNumberMaxBatchSizeoptionaldoubleMaxBatchSizeoptional*float64#The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
Default: No max batch size
Can only be set when using LambdaDataSource.
the name of the AppSync Function.
requestMappingTemplateoptionalMappingTemplaterequest_mapping_templateoptionalMappingTemplaterequestMappingTemplateoptionalMappingTemplateRequestMappingTemplateoptionalMappingTemplateRequestMappingTemplateoptionalMappingTemplate#the request mapping template for the AppSync Function.
Default: no request mapping template
responseMappingTemplateoptionalMappingTemplateresponse_mapping_templateoptionalMappingTemplateresponseMappingTemplateoptionalMappingTemplateResponseMappingTemplateoptionalMappingTemplateResponseMappingTemplateoptionalMappingTemplate#the response mapping template for the AppSync Function.
Default: no response mapping template
runtimeoptionalFunctionRuntimeruntimeoptionalFunctionRuntimeruntimeoptionalFunctionRuntimeRuntimeoptionalFunctionRuntimeRuntimeoptionalFunctionRuntime#The functions runtime.
Default: no function runtime, VTL mapping templates used