class BaseDataSource 🔹

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.BaseDataSource
Java	software.amazon.awscdk.services.appsync.BaseDataSource
Python	aws_cdk.aws_appsync.BaseDataSource
TypeScript (source)	@aws-cdk/aws-appsync » BaseDataSource

Implements IConstruct, IConstruct, IDependable

Extends Construct

Implemented by DynamoDbDataSource, ElasticsearchDataSource, HttpDataSource, LambdaDataSource, NoneDataSource, OpenSearchDataSource, RdsDataSource

Abstract AppSync datasource implementation.

Do not use directly but use subclasses for concrete datasources

Example

declare const api: appsync.GraphqlApi;
declare const dummyRequest: appsync.MappingTemplate;
declare const dummyResponse: appsync.MappingTemplate;
const info = new appsync.ObjectType('Info', {
  definition: {
    node: new appsync.ResolvableField({
      returnType: appsync.GraphqlType.string(),
      args: {
        id: appsync.GraphqlType.string(),
      },
      dataSource: api.addNoneDataSource('none'),
      requestMappingTemplate: dummyRequest,
      responseMappingTemplate: dummyResponse,
    }),
  },
});

Initializer

new BaseDataSource(scope: Construct, id: string, props: BackedDataSourceProps, extended: ExtendedDataSourceProps)

Parameters

• scope Construct
• id string
• props BackedDataSourceProps
• extended ExtendedDataSourceProps

Properties

Name	Type	Description
api🔹	IGraphqlApi
ds🔹	CfnDataSource	the underlying CFN data source resource.
name🔹	string	the name of the data source.
node🔹	ConstructNode	The construct tree node associated with this construct.
serviceRole?🔹	IRole

---

api🔹

Type: IGraphqlApi

---

ds🔹

Type: CfnDataSource

the underlying CFN data source resource.

---

name🔹

Type: string

the name of the data source.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

serviceRole?🔹

Type: IRole (optional)

Methods

Name	Description
createFunction(props)🔹	creates a new appsync function for this datasource and API using the given properties.
createResolver(props)🔹	creates a new resolver for this datasource and API using the given properties.
toString()🔹	Returns a string representation of this construct.

---

createFunction(props)🔹

public createFunction(props: BaseAppsyncFunctionProps): AppsyncFunction

Parameters

• props BaseAppsyncFunctionProps

Returns

• AppsyncFunction

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

---

createResolver(props)🔹

public createResolver(props: BaseResolverProps): Resolver

Parameters

• props BaseResolverProps

Returns

• Resolver

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

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.