class LambdaDataSource (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppSync.LambdaDataSource |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#LambdaDataSource |
![]() | software.amazon.awscdk.services.appsync.LambdaDataSource |
![]() | aws_cdk.aws_appsync.LambdaDataSource |
![]() | aws-cdk-lib » aws_appsync » LambdaDataSource |
Implements
IConstruct
, IDependable
, IGrantable
An AppSync datasource backed by a Lambda function.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';
declare const function_: lambda.Function;
declare const graphqlApi: appsync.GraphqlApi;
declare const role: iam.Role;
const lambdaDataSource = new appsync.LambdaDataSource(this, 'MyLambdaDataSource', {
api: graphqlApi,
lambdaFunction: function_,
// the properties below are optional
description: 'description',
name: 'name',
serviceRole: role,
});
Initializer
new LambdaDataSource(scope: Construct, id: string, props: LambdaDataSourceProps)
Parameters
- scope
Construct
- id
string
- props
Lambda
Data Source Props
Construct Props
Name | Type | Description |
---|---|---|
api | IGraphql | The API to attach this data source to. |
lambda | IFunction | The Lambda function to call to interact with this data source. |
description? | string | the description of the data source. |
name? | string | The name of the data source. |
service | IRole | The IAM service role to be assumed by AppSync to interact with the data source. |
api
Type:
IGraphql
The API to attach this data source to.
lambdaFunction
Type:
IFunction
The Lambda function to call to interact with this data source.
description?
Type:
string
(optional, default: None)
the description of the data source.
name?
Type:
string
(optional, default: id of data source)
The name of the data source.
serviceRole?
Type:
IRole
(optional, default: Create a new role)
The IAM service role to be assumed by AppSync to interact with the data source.
Properties
Name | Type | Description |
---|---|---|
ds | Cfn | the underlying CFN data source resource. |
grant | IPrincipal | the principal of the data source to be IGrantable. |
name | string | the name of the data source. |
node | Node | The tree node. |
ds
Type:
Cfn
the underlying CFN data source resource.
grantPrincipal
Type:
IPrincipal
the principal of the data source to be IGrantable.
name
Type:
string
the name of the data source.
node
Type:
Node
The tree node.
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.