aws-cdk-lib.aws_appsync.BaseDataSourceProps

interface BaseDataSourceProps

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

Base properties for an AppSync 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';

declare const graphqlApi: appsync.GraphqlApi;
const baseDataSourceProps: appsync.BaseDataSourceProps = {
  api: graphqlApi,

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

Properties

NameTypeDescription
apiIGraphqlApiThe API to attach this data source to.
description?stringthe description of the data source.
name?stringThe name of 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.