interface BaseAppsyncFunctionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppSync.BaseAppsyncFunctionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#BaseAppsyncFunctionProps |
![]() | software.amazon.awscdk.services.appsync.BaseAppsyncFunctionProps |
![]() | aws_cdk.aws_appsync.BaseAppsyncFunctionProps |
![]() | aws-cdk-lib » aws_appsync » BaseAppsyncFunctionProps |
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 { 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
Name | Type | Description |
---|---|---|
name | string | the name of the AppSync Function. |
code? | Code | The function code. |
description? | string | the description for this AppSync Function. |
max | number | The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation. |
request | Mapping | the request mapping template for the AppSync Function. |
response | Mapping | the response mapping template for the AppSync Function. |
runtime? | Function | The functions runtime. |
name
Type:
string
the name of the AppSync Function.
code?
Type:
Code
(optional, default: no code is used)
The function code.
description?
Type:
string
(optional, default: no description)
the description for this AppSync Function.
maxBatchSize?
Type:
number
(optional, default: 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.
requestMappingTemplate?
Type:
Mapping
(optional, default: no request mapping template)
the request mapping template for the AppSync Function.
responseMappingTemplate?
Type:
Mapping
(optional, default: no response mapping template)
the response mapping template for the AppSync Function.
runtime?
Type:
Function
(optional, default: no function runtime, VTL mapping templates used)
The functions runtime.