class Resolver (construct)

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

Implements IConstruct, IDependable

An AppSync resolver.

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'),
});

Initializer

new Resolver(scope: Construct, id: string, props: ResolverProps)

Parameters

• scope Construct
• id string
• props ResolverProps

Construct Props

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.
metricsConfig?	ResolverMetricsConfig	Whether to enable enhanced metrics Value will be ignored, if enhancedMetricsConfig.resolverLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_RESOLVER_METRICS.
pipelineConfig?	IFunctionConfigurationRef[]	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.

---

metricsConfig?

Type: ResolverMetricsConfig (optional, default: no metrics configuration)

Whether to enable enhanced metrics Value will be ignored, if enhancedMetricsConfig.resolverLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_RESOLVER_METRICS.

---

pipelineConfig?

Type: IFunctionConfigurationRef[] (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.

Properties

Name	Type	Description
arn	string	the ARN of the resolver.
node	Node	The tree node.

---

arn

Type: string

the ARN of the resolver.

---

node

Type: Node

The tree node.

Methods

Name	Description
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.