Skip to content
v2.277.0

SourceApi Struct ​

Configuration of source API.

Example ​

ts
// 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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync

# graphql_api: appsync.GraphqlApi

source_api = appsync.SourceApi(
    source_api=graphql_api,

    # the properties below are optional
    description="description",
    merge_type=appsync.MergeType.MANUAL_MERGE
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.appsync.*;

GraphqlApi graphqlApi;

SourceApi sourceApi = SourceApi.builder()
        .sourceApi(graphqlApi)

        // the properties below are optional
        .description("description")
        .mergeType(MergeType.MANUAL_MERGE)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;

GraphqlApi graphqlApi;

var sourceApi = new SourceApi {
    SourceApi = graphqlApi,

    // the properties below are optional
    Description = "description",
    MergeType = MergeType.MANUAL_MERGE
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var graphqlApi GraphqlApi

sourceApi := &SourceApi{
	SourceApi: graphqlApi,

	// the properties below are optional
	Description: jsii.String("description"),
	MergeType: awscdk.Aws_appsync.MergeType_MANUAL_MERGE,
}

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Description of the Source API asssociation.
mergeTypeoptionalMergeTypemerge_typeoptionalMergeTypemergeTypeoptionalMergeTypeMergeTypeoptionalMergeTypeMergeTypeoptionalMergeType#
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.