ResolverProps

class aws_cdk.aws_appsync.ResolverProps(*, field_name, type_name, caching_config=None, pipeline_config=None, request_mapping_template=None, response_mapping_template=None, data_source=None, api)

Bases: aws_cdk.aws_appsync.ExtendedResolverProps

(experimental) Additional property for an AppSync resolver for GraphQL API reference.

Parameters
  • field_name (str) – (experimental) name of the GraphQL field in the given type this resolver is attached to.

  • type_name (str) – (experimental) name of the GraphQL type this resolver is attached to.

  • caching_config (Union[CachingConfig, Dict[str, Any], None]) – (experimental) The caching configuration for this resolver. Default: - No caching configuration

  • pipeline_config (Optional[Sequence[IAppsyncFunction]]) – (experimental) configuration of the pipeline resolver. Default: - no pipeline resolver configuration An empty array | undefined sets resolver to be of kind, unit

  • request_mapping_template (Optional[MappingTemplate]) – (experimental) The request mapping template for this resolver. Default: - No mapping template

  • response_mapping_template (Optional[MappingTemplate]) – (experimental) The response mapping template for this resolver. Default: - No mapping template

  • data_source (Optional[BaseDataSource]) – (experimental) The data source this resolver is using. Default: - No datasource

  • api (IGraphqlApi) – (experimental) The API this resolver is attached to.

Stability

experimental

ExampleMetadata

infused

Example:

# api: appsync.GraphqlApi
# appsync_function: appsync.AppsyncFunction


pipeline_resolver = appsync.Resolver(self, "pipeline",
    api=api,
    data_source=api.add_none_data_source("none"),
    type_name="typeName",
    field_name="fieldName",
    request_mapping_template=appsync.MappingTemplate.from_file("beforeRequest.vtl"),
    pipeline_config=[appsync_function],
    response_mapping_template=appsync.MappingTemplate.from_file("afterResponse.vtl")
)

Attributes

api

(experimental) The API this resolver is attached to.

Stability

experimental

Return type

IGraphqlApi

caching_config

(experimental) The caching configuration for this resolver.

Default
  • No caching configuration

Stability

experimental

Return type

Optional[CachingConfig]

data_source

(experimental) The data source this resolver is using.

Default
  • No datasource

Stability

experimental

Return type

Optional[BaseDataSource]

field_name

(experimental) name of the GraphQL field in the given type this resolver is attached to.

Stability

experimental

Return type

str

pipeline_config

(experimental) configuration of the pipeline resolver.

Default

  • no pipeline resolver configuration

An empty array | undefined sets resolver to be of kind, unit

Stability

experimental

Return type

Optional[List[IAppsyncFunction]]

request_mapping_template

(experimental) The request mapping template for this resolver.

Default
  • No mapping template

Stability

experimental

Return type

Optional[MappingTemplate]

response_mapping_template

(experimental) The response mapping template for this resolver.

Default
  • No mapping template

Stability

experimental

Return type

Optional[MappingTemplate]

type_name

(experimental) name of the GraphQL type this resolver is attached to.

Stability

experimental

Return type

str