aws-cdk-lib.aws_appsync.SourceApi

SourceApi Struct

Configuration of source API.

Source

aws-appsync/lib/graphqlapi.ts

Type last changed

v2.97.0 · 22 Sep 2023

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

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

Description of the Source API asssociation.

mergeType?optionalMergeTypemerge_type?optionalMergeTypemergeType?optionalMergeTypeMergeType?optionalMergeTypeMergeType?optionalMergeType#

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

Default: Auto merge. The merge is triggered automatically when the source API has changed

sourceApiIGraphqlApisource_apiIGraphqlApisourceApiIGraphqlApiSourceApiIGraphqlApiSourceApiIGraphqlApirequired#

Source API that is associated with the merged API.