interface SourceApi

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.SourceApi
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#SourceApi
Java	software.amazon.awscdk.services.appsync.SourceApi
Python	aws_cdk.aws_appsync.SourceApi
TypeScript (source)	aws-cdk-lib » aws_appsync » SourceApi

Configuration of source API.

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 sourceApi: appsync.SourceApi = {
  sourceApi: graphqlApi,

  // the properties below are optional
  description: 'description',
  mergeType: appsync.MergeType.MANUAL_MERGE,
};

Properties

Name	Type	Description
sourceApi	IGraphqlApi	Source API that is associated with the merged API.
description?	string	Description of the Source API asssociation.
mergeType?	MergeType	Merging option used to associate the source API to the Merged API.

---

sourceApi

Type: IGraphqlApi

Source API that is associated with the merged API.

---

description?

Type: string (optional)

Description of the Source API asssociation.

---

mergeType?

Type: MergeType (optional, default: Auto merge. The merge is triggered automatically when the source API has changed)

Merging option used to associate the source API to the Merged API.