class BaseDataSource
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppSync.BaseDataSource |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#BaseDataSource |
![]() | software.amazon.awscdk.services.appsync.BaseDataSource |
![]() | aws_cdk.aws_appsync.BaseDataSource |
![]() | aws-cdk-lib » aws_appsync » BaseDataSource |
Implements
IConstruct
, IDependable
Extends
Construct
Implemented by
Dynamo
, Elasticsearch
, Event
, Http
, Lambda
, None
, Open
, Rds
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
Backed
Data Source Props - extended
Extended
Data Source Props
Properties
Name | Type | Description |
---|---|---|
api | IGraphql | |
ds | Cfn | the underlying CFN data source resource. |
name | string | the name of the data source. |
node | Node | The tree node. |
service | IRole |
api
Type:
IGraphql
ds
Type:
Cfn
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 |
---|---|
create | creates a new appsync function for this datasource and API using the given properties. |
create | creates a new resolver for this datasource and API using the given properties. |
to | Returns a string representation of this construct. |
createFunction(id, props)
public createFunction(id: string, props: BaseAppsyncFunctionProps): AppsyncFunction
Parameters
- id
string
- props
Base
Appsync Function Props
Returns
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
Base
Resolver Props
Returns
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.