aws-cdk-lib.aws_appsync.BackedDataSourceProps

interface BackedDataSourceProps

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

properties for an AppSync datasource backed by a resource.

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';

declare const graphqlApi: appsync.GraphqlApi;
declare const role: iam.Role;
const backedDataSourceProps: appsync.BackedDataSourceProps = {
  api: graphqlApi,

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

Properties

NameTypeDescription
apiIGraphqlApiThe API to attach this data source to.
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.


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.