software.amazon.awscdk.services.appsync

Interface BaseResolverProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ExtendedResolverProps, ResolverProps

All Known Implementing Classes:

BaseResolverProps.Jsii$Proxy, ExtendedResolverProps.Jsii$Proxy, ResolverProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:00.948Z")
 @Stability(value=Experimental)
public interface BaseResolverProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Basic properties for an AppSync resolver.

Example:

 // Build a data source for AppSync to access the database.
 GraphqlApi api;
 // Create username and password secret for DB Cluster
 DatabaseSecret secret = DatabaseSecret.Builder.create(this, "AuroraSecret")
         .username("clusteradmin")
         .build();
 // The VPC to place the cluster in
 Vpc vpc = new Vpc(this, "AuroraVpc");
 // Create the serverless cluster, provide all values needed to customise the database.
 ServerlessCluster cluster = ServerlessCluster.Builder.create(this, "AuroraCluster")
         .engine(DatabaseClusterEngine.AURORA_MYSQL)
         .vpc(vpc)
         .credentials(Map.of("username", "clusteradmin"))
         .clusterIdentifier("db-endpoint-test")
         .defaultDatabaseName("demos")
         .build();
 RdsDataSource rdsDS = api.addRdsDataSource("rds", cluster, secret, "demos");
 // Set up a resolver for an RDS query.
 rdsDS.createResolver(BaseResolverProps.builder()
         .typeName("Query")
         .fieldName("getDemosRds")
         .requestMappingTemplate(MappingTemplate.fromString("\n  {\n    \"version\": \"2018-05-29\",\n    \"statements\": [\n      \"SELECT * FROM demos\"\n    ]\n  }\n  "))
         .responseMappingTemplate(MappingTemplate.fromString("\n    $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])\n  "))
         .build());
 // Set up a resolver for an RDS mutation.
 rdsDS.createResolver(BaseResolverProps.builder()
         .typeName("Mutation")
         .fieldName("addDemoRds")
         .requestMappingTemplate(MappingTemplate.fromString("\n  {\n    \"version\": \"2018-05-29\",\n    \"statements\": [\n      \"INSERT INTO demos VALUES (:id, :version)\",\n      \"SELECT * WHERE id = :id\"\n    ],\n    \"variableMap\": {\n      \":id\": $util.toJson($util.autoId()),\n      \":version\": $util.toJson($ctx.args.version)\n    }\n  }\n  "))
         .responseMappingTemplate(MappingTemplate.fromString("\n    $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])\n  "))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BaseResolverProps.Builder A builder for BaseResolverProps
static class	BaseResolverProps.Jsii$Proxy An implementation for BaseResolverProps

Method Summary

Modifier and Type	Method and Description
static BaseResolverProps.Builder	builder()
default CachingConfig	getCachingConfig() (experimental) The caching configuration for this resolver.
String	getFieldName() (experimental) name of the GraphQL field in the given type this resolver is attached to.
default List<IAppsyncFunction>	getPipelineConfig() (experimental) configuration of the pipeline resolver.
default MappingTemplate	getRequestMappingTemplate() (experimental) The request mapping template for this resolver.
default MappingTemplate	getResponseMappingTemplate() (experimental) The response mapping template for this resolver.
String	getTypeName() (experimental) name of the GraphQL type this resolver is attached to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFieldName

@Stability(value=Experimental)
 @NotNull
String getFieldName()

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

getTypeName

@Stability(value=Experimental)
 @NotNull
String getTypeName()

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

getCachingConfig

@Stability(value=Experimental)
 @Nullable
default CachingConfig getCachingConfig()

(experimental) The caching configuration for this resolver.

Default: - No caching configuration

getPipelineConfig

@Stability(value=Experimental)
 @Nullable
default List<IAppsyncFunction> getPipelineConfig()

(experimental) configuration of the pipeline resolver.

Default: - no pipeline resolver configuration An empty array | undefined sets resolver to be of kind, unit

getRequestMappingTemplate

@Stability(value=Experimental)
 @Nullable
default MappingTemplate getRequestMappingTemplate()

(experimental) The request mapping template for this resolver.

Default: - No mapping template

getResponseMappingTemplate

@Stability(value=Experimental)
 @Nullable
default MappingTemplate getResponseMappingTemplate()

(experimental) The response mapping template for this resolver.

Default: - No mapping template

builder

@Stability(value=Experimental)
static BaseResolverProps.Builder builder()

Returns:

a BaseResolverProps.Builder of BaseResolverProps