ExtendedResolverProps Struct
Additional property for an AppSync resolver for data source reference.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_appsync as appsync } from 'aws-cdk-lib';
import { aws_appsync as interfaces_appsync } from 'aws-cdk-lib/interfaces';
declare const baseDataSource: appsync.BaseDataSource;
declare const code: appsync.Code;
declare const functionConfigurationRef: interfaces_appsync.IFunctionConfigurationRef;
declare const functionRuntime: appsync.FunctionRuntime;
declare const mappingTemplate: appsync.MappingTemplate;
const extendedResolverProps: appsync.ExtendedResolverProps = {
fieldName: 'fieldName',
typeName: 'typeName',
// the properties below are optional
cachingConfig: {
ttl: cdk.Duration.minutes(30),
// the properties below are optional
cachingKeys: ['cachingKeys'],
},
code: code,
dataSource: baseDataSource,
maxBatchSize: 123,
metricsConfig: appsync.ResolverMetricsConfig.ENABLED,
pipelineConfig: [functionConfigurationRef],
requestMappingTemplate: mappingTemplate,
responseMappingTemplate: mappingTemplate,
runtime: functionRuntime,
};
Properties
cachingConfigoptionalCachingConfigcaching_configoptionalCachingConfigcachingConfigoptionalCachingConfigCachingConfigoptionalCachingConfigCachingConfigoptionalCachingConfig#The caching configuration for this resolver.
Default: No caching configuration
The function code.
Default: no code is used
dataSourceoptionalBaseDataSourcedata_sourceoptionalBaseDataSourcedataSourceoptionalBaseDataSourceDataSourceoptionalBaseDataSourceDataSourceoptionalBaseDataSource#The data source this resolver is using.
Default: No datasource
name of the GraphQL field in the given type this resolver is attached to.
maxBatchSizeoptionalnumbermax_batch_sizeoptionalint | floatmaxBatchSizeoptionalNumberMaxBatchSizeoptionaldoubleMaxBatchSizeoptional*float64#The maximum number of elements per batch, when using batch invoke.
Default: No max batch size
metricsConfigoptionalResolverMetricsConfigmetrics_configoptionalResolverMetricsConfigmetricsConfigoptionalResolverMetricsConfigMetricsConfigoptionalResolverMetricsConfigMetricsConfigoptionalResolverMetricsConfig#Whether to enable enhanced metrics Value will be ignored, if `enhancedMetricsConfig.resolverLevelMetricsBehavior` on AppSync GraphqlApi construct is set to `FULL_REQUEST_RESOLVER_METRICS`.
Default: no metrics configuration
pipelineConfigoptionalIFunctionConfigurationRef[]pipeline_configoptionaltyping.List[IFunctionConfigurationRef]pipelineConfigoptionalList<IFunctionConfigurationRef>PipelineConfigoptionalIFunctionConfigurationRef[]PipelineConfigoptional*[]IFunctionConfigurationRef#configuration of the pipeline resolver.
Default: no pipeline resolver configuration An empty array | undefined sets resolver to be of kind, unit
requestMappingTemplateoptionalMappingTemplaterequest_mapping_templateoptionalMappingTemplaterequestMappingTemplateoptionalMappingTemplateRequestMappingTemplateoptionalMappingTemplateRequestMappingTemplateoptionalMappingTemplate#The request mapping template for this resolver.
Default: No mapping template
responseMappingTemplateoptionalMappingTemplateresponse_mapping_templateoptionalMappingTemplateresponseMappingTemplateoptionalMappingTemplateResponseMappingTemplateoptionalMappingTemplateResponseMappingTemplateoptionalMappingTemplate#The response mapping template for this resolver.
Default: No mapping template
runtimeoptionalFunctionRuntimeruntimeoptionalFunctionRuntimeruntimeoptionalFunctionRuntimeRuntimeoptionalFunctionRuntimeRuntimeoptionalFunctionRuntime#The functions runtime.
Default: no function runtime, VTL mapping templates used
name of the GraphQL type this resolver is attached to.