interface CfnResolverProps

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

Properties for defining a CfnResolver.

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';
const cfnResolverProps: appsync.CfnResolverProps = {
  apiId: 'apiId',
  fieldName: 'fieldName',
  typeName: 'typeName',

  // the properties below are optional
  cachingConfig: {
    ttl: 123,

    // the properties below are optional
    cachingKeys: ['cachingKeys'],
  },
  code: 'code',
  codeS3Location: 'codeS3Location',
  dataSourceName: 'dataSourceName',
  kind: 'kind',
  maxBatchSize: 123,
  metricsConfig: 'metricsConfig',
  pipelineConfig: {
    functions: ['functions'],
  },
  requestMappingTemplate: 'requestMappingTemplate',
  requestMappingTemplateS3Location: 'requestMappingTemplateS3Location',
  responseMappingTemplate: 'responseMappingTemplate',
  responseMappingTemplateS3Location: 'responseMappingTemplateS3Location',
  runtime: {
    name: 'name',
    runtimeVersion: 'runtimeVersion',
  },
  syncConfig: {
    conflictDetection: 'conflictDetection',

    // the properties below are optional
    conflictHandler: 'conflictHandler',
    lambdaConflictHandlerConfig: {
      lambdaConflictHandlerArn: 'lambdaConflictHandlerArn',
    },
  },
};

Properties

Name	Type	Description
apiId	`string`	The AWS AppSync GraphQL API to which you want to attach this resolver.
fieldName	`string`	The GraphQL field on a type that invokes the resolver.
typeName	`string`	The GraphQL type that invokes this resolver.
cachingConfig?	`IResolvable` `\|` `CachingConfigProperty`	The caching configuration for the resolver.
code?	`string`	The `resolver` code that contains the request and response functions.
codeS3Location?	`string`	The Amazon S3 endpoint.
dataSourceName?	`string`	The resolver data source name.
kind?	`string`	The resolver type.
maxBatchSize?	`number`	The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.
metricsConfig?	`string`	Enables or disables enhanced resolver metrics for specified resolvers.
pipelineConfig?	`IResolvable` `\|` `PipelineConfigProperty`	Functions linked with the pipeline resolver.
requestMappingTemplate?	`string`	The request mapping template.
requestMappingTemplateS3Location?	`string`	The location of a request mapping template in an Amazon S3 bucket.
responseMappingTemplate?	`string`	The response mapping template.
responseMappingTemplateS3Location?	`string`	The location of a response mapping template in an Amazon S3 bucket.
runtime?	`IResolvable` `\|` `AppSyncRuntimeProperty`	Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
syncConfig?	`IResolvable` `\|` `SyncConfigProperty`	The `SyncConfig` for a resolver attached to a versioned data source.

apiId

Type: string

The AWS AppSync GraphQL API to which you want to attach this resolver.

fieldName

Type: string

The GraphQL field on a type that invokes the resolver.

typeName

Type: string

The GraphQL type that invokes this resolver.

cachingConfig?

Type: IResolvable | CachingConfigProperty (optional)

The caching configuration for the resolver.

code?

Type: string (optional)

The resolver code that contains the request and response functions.

When code is used, the runtime is required. The runtime value must be APPSYNC_JS .

codeS3Location?

Type: string (optional)

The Amazon S3 endpoint.

dataSourceName?

Type: string (optional)

The resolver data source name.

kind?

Type: string (optional)

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.

maxBatchSize?

Type: number (optional)

The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.

metricsConfig?

Type: string (optional)

Enables or disables enhanced resolver metrics for specified resolvers.

Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS . If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.

pipelineConfig?

Type: IResolvable | PipelineConfigProperty (optional)

Functions linked with the pipeline resolver.

requestMappingTemplate?

Type: string (optional)

The request mapping template.

Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.

requestMappingTemplateS3Location?

Type: string (optional)

The location of a request mapping template in an Amazon S3 bucket.

Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.

responseMappingTemplate?

Type: string (optional)

The response mapping template.

responseMappingTemplateS3Location?

Type: string (optional)

The location of a response mapping template in an Amazon S3 bucket.

Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.

runtime?

Type: IResolvable | AppSyncRuntimeProperty (optional)

Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.

Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

syncConfig?

Type: IResolvable | SyncConfigProperty (optional)

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