interface ResolverProps

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.ResolverProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#ResolverProps
Java	software.amazon.awscdk.services.appsync.ResolverProps
Python	aws_cdk.aws_appsync.ResolverProps
TypeScript (source)	aws-cdk-lib » aws_appsync » ResolverProps

Additional property for an AppSync resolver for GraphQL API reference.

Example

declare const api: appsync.GraphqlApi;
declare const appsyncFunction: appsync.AppsyncFunction;

const pipelineResolver = new appsync.Resolver(this, 'pipeline', {
  api,
  dataSource: api.addNoneDataSource('none'),
  typeName: 'typeName',
  fieldName: 'fieldName',
  requestMappingTemplate: appsync.MappingTemplate.fromFile('beforeRequest.vtl'),
  pipelineConfig: [appsyncFunction],
  responseMappingTemplate: appsync.MappingTemplate.fromFile('afterResponse.vtl'),
});

Properties

Name	Type	Description
api	IGraphqlApi	The API this resolver is attached to.
fieldName	string	name of the GraphQL field in the given type this resolver is attached to.
typeName	string	name of the GraphQL type this resolver is attached to.
cachingConfig?	CachingConfig	The caching configuration for this resolver.
code?	Code	The function code.
dataSource?	BaseDataSource	The data source this resolver is using.
maxBatchSize?	number	The maximum number of elements per batch, when using batch invoke.
pipelineConfig?	IAppsyncFunction[]	configuration of the pipeline resolver.
requestMappingTemplate?	MappingTemplate	The request mapping template for this resolver.
responseMappingTemplate?	MappingTemplate	The response mapping template for this resolver.
runtime?	FunctionRuntime	The functions runtime.

---

api

Type: IGraphqlApi

The API this resolver is attached to.

---

fieldName

Type: string

name of the GraphQL field in the given type this resolver is attached to.

---

typeName

Type: string

name of the GraphQL type this resolver is attached to.

---

cachingConfig?

Type: CachingConfig (optional, default: No caching configuration)

The caching configuration for this resolver.

---

code?

Type: Code (optional, default: no code is used)

The function code.

---

dataSource?

Type: BaseDataSource (optional, default: No datasource)

The data source this resolver is using.

---

maxBatchSize?

Type: number (optional, default: No max batch size)

The maximum number of elements per batch, when using batch invoke.

---

pipelineConfig?

Type: IAppsyncFunction[] (optional, default: no pipeline resolver configuration An empty array | undefined sets resolver to be of kind, unit)

configuration of the pipeline resolver.

---

requestMappingTemplate?

Type: MappingTemplate (optional, default: No mapping template)

The request mapping template for this resolver.

---

responseMappingTemplate?

Type: MappingTemplate (optional, default: No mapping template)

The response mapping template for this resolver.

---

runtime?

Type: FunctionRuntime (optional, default: no function runtime, VTL mapping templates used)

The functions runtime.