software.amazon.awscdk.services.appsync

Class BaseDataSource

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.appsync.BaseDataSource

All Implemented Interfaces:

IConstruct, IDependable

Direct Known Subclasses:

BackedDataSource, NoneDataSource

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:02.206Z")
public abstract class BaseDataSource
extends Construct

(experimental) Abstract AppSync datasource implementation.

Do not use directly but use subclasses for concrete datasources

Example:

 GraphqlApi api;
 MappingTemplate dummyRequest;
 MappingTemplate dummyResponse;
 ObjectType info = ObjectType.Builder.create("Info")
         .definition(Map.of(
                 "node", ResolvableField.Builder.create()
                         .returnType(GraphqlType.string())
                         .args(Map.of(
                                 "id", GraphqlType.string()))
                         .dataSource(api.addNoneDataSource("none"))
                         .requestMappingTemplate(dummyRequest)
                         .responseMappingTemplate(dummyResponse)
                         .build()))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BaseDataSource(software.amazon.jsii.JsiiObjectRef objRef)
protected	BaseDataSource(software.constructs.Construct scope, java.lang.String id, BackedDataSourceProps props, ExtendedDataSourceProps extended)

Method Summary

Modifier and Type	Method and Description
AppsyncFunction	createFunction(BaseAppsyncFunctionProps props) (experimental) creates a new appsync function for this datasource and API using the given properties.
Resolver	createResolver(BaseResolverProps props) (experimental) creates a new resolver for this datasource and API using the given properties.
protected IGraphqlApi	getApi()
CfnDataSource	getDs() (experimental) the underlying CFN data source resource.
java.lang.String	getName() (experimental) the name of the data source.
protected IRole	getServiceRole()
protected void	setApi(IGraphqlApi value)
protected void	setServiceRole(IRole value)

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseDataSource

protected BaseDataSource(software.amazon.jsii.JsiiObjectRef objRef)

BaseDataSource

protected BaseDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BaseDataSource

protected BaseDataSource(software.constructs.Construct scope,
                         java.lang.String id,
                         BackedDataSourceProps props,
                         ExtendedDataSourceProps extended)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

extended - This parameter is required.

Method Detail

createFunction

public AppsyncFunction createFunction(BaseAppsyncFunctionProps props)

(experimental) creates a new appsync function for this datasource and API using the given properties.

Parameters:

props - This parameter is required.

createResolver

public Resolver createResolver(BaseResolverProps props)

(experimental) creates a new resolver for this datasource and API using the given properties.

Parameters:

props - This parameter is required.

getDs

public CfnDataSource getDs()

(experimental) the underlying CFN data source resource.

getName

public java.lang.String getName()

(experimental) the name of the data source.

getApi

protected IGraphqlApi getApi()

setApi

protected void setApi(IGraphqlApi value)

getServiceRole

protected IRole getServiceRole()

setServiceRole

protected void setServiceRole(IRole value)