Package software.amazon.awscdk.services.appsync

Class BaseDataSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.appsync.BaseDataSource

All Implemented Interfaces:

IConstruct, IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

BackedDataSource, NoneDataSource

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.368Z")
@Stability(Experimental)
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 class software.constructs.Construct

software.constructs.Construct.Builder

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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.
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 software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

BaseDataSource

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

BaseDataSource

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

BaseDataSource

@Stability(Experimental)
protected BaseDataSource(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BackedDataSourceProps props,
 @NotNull
 ExtendedDataSourceProps extended)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

extended - This parameter is required.

Method Details

createFunction

@Stability(Experimental)
@NotNull
public AppsyncFunction createFunction(@NotNull
 BaseAppsyncFunctionProps props)

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

Parameters:

props - This parameter is required.

createResolver

@Stability(Experimental)
@NotNull
public Resolver createResolver(@NotNull
 BaseResolverProps props)

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

Parameters:

props - This parameter is required.

getDs

@Stability(Experimental)
@NotNull
public CfnDataSource getDs()

(experimental) the underlying CFN data source resource.

getName

@Stability(Experimental)
@NotNull
public String getName()

(experimental) the name of the data source.

getApi

@Stability(Experimental)
@NotNull
protected IGraphqlApi getApi()

setApi

@Stability(Experimental)
protected void setApi(@NotNull
 IGraphqlApi value)

getServiceRole

@Stability(Experimental)
@Nullable
protected IRole getServiceRole()

setServiceRole

@Stability(Experimental)
protected void setServiceRole(@Nullable
 IRole value)