Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateResolverCommandInput

Hierarchy

Index

Properties

apiId

apiId: string | undefined

The ID for the GraphQL API for which the resolver is being created.

Optional cachingConfig

cachingConfig: CachingConfig

The caching configuration for the resolver.

Optional dataSourceName

dataSourceName: undefined | string

The name of the data source for which the resolver is being created.

fieldName

fieldName: string | undefined

The name of the field to attach the resolver to.

Optional kind

kind: ResolverKind | string

The resolver type.

  • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

  • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

Optional maxBatchSize

maxBatchSize: undefined | number

The maximum batching size for a resolver.

Optional pipelineConfig

pipelineConfig: PipelineConfig

The PipelineConfig.

Optional requestMappingTemplate

requestMappingTemplate: undefined | string

The mapping template to use for requests.

A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

Optional responseMappingTemplate

responseMappingTemplate: undefined | string

The mapping template to use for responses from the data source.

Optional syncConfig

syncConfig: SyncConfig

The SyncConfig for a resolver attached to a versioned data source.

typeName

typeName: string | undefined

The name of the Type.