Package software.amazon.awscdk.services.appsync

Interface ResolvableFieldOptions

All Superinterfaces:

FieldOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ResolvableFieldOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.570Z")
@Stability(Experimental)
public interface ResolvableFieldOptions
extends software.amazon.jsii.JsiiSerializable, FieldOptions

(experimental) Properties for configuring a resolvable field.

Example:

 GraphqlApi api;
 ObjectType filmNode;
 MappingTemplate dummyRequest;
 MappingTemplate dummyResponse;
 GraphqlType string = GraphqlType.string();
 GraphqlType int = GraphqlType.int();
 api.addMutation("addFilm", ResolvableField.Builder.create()
         .returnType(filmNode.attribute())
         .args(Map.of("name", string, "film_number", int))
         .dataSource(api.addNoneDataSource("none"))
         .requestMappingTemplate(dummyRequest)
         .responseMappingTemplate(dummyResponse)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ResolvableFieldOptions.Builder	builder()
default BaseDataSource	getDataSource()	(experimental) The data source creating linked to this resolvable field.
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.

Methods inherited from interface software.amazon.awscdk.services.appsync.FieldOptions

getArgs, getDirectives, getReturnType

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSource

@Stability(Experimental)
@Nullable
default BaseDataSource getDataSource()

(experimental) The data source creating linked to this resolvable field.

Default: - no data source

getPipelineConfig

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

(experimental) configuration of the pipeline resolver.

Default: - no pipeline resolver configuration An empty array or undefined prop will set resolver to be of type unit

getRequestMappingTemplate

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

(experimental) The request mapping template for this resolver.

Default: - No mapping template

getResponseMappingTemplate

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

(experimental) The response mapping template for this resolver.

Default: - No mapping template

builder

@Stability(Experimental)
static ResolvableFieldOptions.Builder builder()

Returns:

a ResolvableFieldOptions.Builder of ResolvableFieldOptions