class Resolver (construct)
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.AppSync.Resolver |
Java | software.amazon.awscdk.services.appsync.Resolver |
Python | aws_cdk.aws_appsync.Resolver |
TypeScript (source) | @aws-cdk/aws-appsync » Resolver |
Implements
IConstruct, 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 | IGraphql | The API this resolver is attached to. |
| field | string | name of the GraphQL field in the given type this resolver is attached to. |
| type | string | name of the GraphQL type this resolver is attached to. |
| caching | Caching | The caching configuration for this resolver. |
| data | Base | The data source this resolver is using. |
| pipeline | IAppsync[] | configuration of the pipeline resolver. |
| request | Mapping | The request mapping template for this resolver. |
| response | Mapping | The response mapping template for this resolver. |
api
Type:
IGraphql
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:
Caching
(optional, default: No caching configuration)
The caching configuration for this resolver.
dataSource?
Type:
Base
(optional, default: No datasource)
The data source this resolver is using.
pipelineConfig?
Type:
IAppsync[]
(optional, default: no pipeline resolver configuration
An empty array | undefined sets resolver to be of kind, unit)
configuration of the pipeline resolver.
requestMappingTemplate?
Type:
Mapping
(optional, default: No mapping template)
The request mapping template for this resolver.
responseMappingTemplate?
Type:
Mapping
(optional, default: No mapping template)
The response mapping template for this resolver.
Properties
| Name | Type | Description |
|---|---|---|
| arn | string | the ARN of the resolver. |
| node | Construct | The construct tree node associated with this construct. |
arn
Type:
string
the ARN of the resolver.
node
Type:
Construct
The construct tree node associated with this construct.
Methods
| Name | Description |
|---|---|
| to | Returns a string representation of this construct. |
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.

.NET
Java
Python
TypeScript (