class BaseDataSource

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.BaseDataSource
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#BaseDataSource
Java	software.amazon.awscdk.services.appsync.BaseDataSource
Python	aws_cdk.aws_appsync.BaseDataSource
TypeScript (source)	aws-cdk-lib » aws_appsync » BaseDataSource

Implements IConstruct, IDependable

Extends Construct

Implemented by DynamoDbDataSource, ElasticsearchDataSource, EventBridgeDataSource, 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 appsyncFunction: appsync.AppsyncFunction;

const pipelineResolver = new appsync.Resolver(this, 'pipeline', {
  api,
  dataSource: api.addNoneDataSource('none'),
  typeName: 'typeName',
  fieldName: 'fieldName',
  requestMappingTemplate: appsync.MappingTemplate.fromFile('beforeRequest.vtl'),
  pipelineConfig: [appsyncFunction],
  responseMappingTemplate: appsync.MappingTemplate.fromFile('afterResponse.vtl'),
});

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	The API this data source is attached to Set the API this data source is attached to.
ds	CfnDataSource	the underlying CFN data source resource.
name	string	the name of the data source.
node	Node	The tree node.
serviceRole?	IRole

---

api

Type: IGraphqlApi

The API this data source is attached to Set the API this data source is attached to.

---

ds

Type: CfnDataSource

the underlying CFN data source resource.

---

name

Type: string

the name of the data source.

---

node

Type: Node

The tree node.

---

serviceRole?

Type: IRole (optional)

Methods

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

---

createFunction(id, props)

public createFunction(id: string, props: BaseAppsyncFunctionProps): AppsyncFunction

Parameters

• id string
• props BaseAppsyncFunctionProps

Returns

• AppsyncFunction

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

---

createResolver(id, props)

public createResolver(id: string, props: BaseResolverProps): Resolver

Parameters

• id string
• 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.