interface ISchema

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

Implemented by SchemaFile

Interface for implementing your own schema.

Useful for providing schema's from sources other than assets

Methods

Name	Description
bind(api, options?)	Binds a schema string to a GraphQlApi.

---

bind(api, options?)

public bind(api: IGraphqlApi, options?: SchemaBindOptions): ISchemaConfig

Parameters

• api IGraphqlApi — the api to bind the schema to.
• options SchemaBindOptions — configuration for bind behavior.

Returns

• ISchemaConfig

Binds a schema string to a GraphQlApi.