aws-cdk-lib.aws_appsync.LambdaDataSourceProps

interface LambdaDataSourceProps

LanguageType name
.NETAmazon.CDK.AWS.AppSync.LambdaDataSourceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#LambdaDataSourceProps
Javasoftware.amazon.awscdk.services.appsync.LambdaDataSourceProps
Pythonaws_cdk.aws_appsync.LambdaDataSourceProps
TypeScript (source)aws-cdk-lib » aws_appsync » LambdaDataSourceProps

Properties for an AppSync Lambda datasource.

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 lambdaDataSourceProps: appsync.LambdaDataSourceProps = {
  api: graphqlApi,
  lambdaFunction: function_,

  // the properties below are optional
  description: 'description',
  name: 'name',
  serviceRole: role,
};

Properties

NameTypeDescription
apiIGraphqlApiThe API to attach this data source to.
lambdaFunctionIFunctionThe Lambda function to call to interact with this data source.
description?stringthe description of the data source.
name?stringThe name of the data source.
serviceRole?IRoleThe IAM service role to be assumed by AppSync to interact with the data source.

api

Type: IGraphqlApi

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.