interface CfnResolverMixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.AppSync.Mixins.CfnResolverMixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsappsync/mixins#CfnResolverMixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.appsync.mixins.CfnResolverMixinProps |
 Python | aws_cdk.mixins_preview.aws_appsync.mixins.CfnResolverMixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_appsync » mixins » CfnResolverMixinProps |
Properties for CfnResolverPropsMixin.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as appsync_mixins } from '@aws-cdk/mixins-preview/aws-appsync';
const cfnResolverMixinProps: appsync_mixins.CfnResolverMixinProps = {
apiId: 'apiId',
cachingConfig: {
cachingKeys: ['cachingKeys'],
ttl: 123,
},
code: 'code',
codeS3Location: 'codeS3Location',
dataSourceName: 'dataSourceName',
fieldName: 'fieldName',
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',
conflictHandler: 'conflictHandler',
lambdaConflictHandlerConfig: {
lambdaConflictHandlerArn: 'lambdaConflictHandlerArn',
},
},
typeName: 'typeName',
};
Properties
| Name | Type | Description |
|---|---|---|
| api | string | The AWS AppSync GraphQL API to which you want to attach this resolver. |
| caching | IResolvable | Caching | The caching configuration for the resolver. |
| code? | string | The resolver code that contains the request and response functions. |
| code | string | The Amazon S3 endpoint. |
| data | string | The resolver data source name. |
| field | string | The GraphQL field on a type that invokes the resolver. |
| kind? | string | The resolver type. |
| max | number | The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation. |
| metrics | string | Enables or disables enhanced resolver metrics for specified resolvers. |
| pipeline | IResolvable | Pipeline | Functions linked with the pipeline resolver. |
| request | string | The request mapping template. |
| request | string | The location of a request mapping template in an Amazon S3 bucket. |
| response | string | The response mapping template. |
| response | string | The location of a response mapping template in an Amazon S3 bucket. |
| runtime? | IResolvable | App | Describes a runtime used by an AWS AppSync resolver or AWS AppSync function. |
| sync | IResolvable | Sync | The SyncConfig for a resolver attached to a versioned data source. |
| type | string | The GraphQL type that invokes this resolver. |
apiId?
Type:
string
(optional)
The AWS AppSync GraphQL API to which you want to attach this resolver.
cachingConfig?
Type:
IResolvable | Caching
(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.
fieldName?
Type:
string
(optional)
The GraphQL field on a type that invokes the resolver.
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
Functionobjects 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 | Pipeline
(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 | App
(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 | Sync
(optional)
The SyncConfig for a resolver attached to a versioned data source.
typeName?
Type:
string
(optional)
The GraphQL type that invokes this resolver.