Package software.amazon.awscdk.services.appsync

Interface ISchema

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ISchema.Jsii$Default
All Known Implementing Classes:
ISchema.Jsii$Proxy, SchemaFile
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:23:57.190Z") @Stability(Stable) public interface ISchema extends software.amazon.jsii.JsiiSerializable
Interface for implementing your own schema.

Useful for providing schema's from sources other than assets

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ISchema.Jsii$Default
    Internal default implementation for ISchema.
    static final class 
    ISchema.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    ISchemaConfig
    bind(IGraphqlApi api)
    Binds a schema string to a GraphQlApi.
    ISchemaConfig
    bind(IGraphqlApi api, SchemaBindOptions options)
    Binds a schema string to a GraphQlApi.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • bind

      @Stability(Stable) @NotNull ISchemaConfig bind(@NotNull IGraphqlApi api, @Nullable SchemaBindOptions options)
      Binds a schema string to a GraphQlApi.

      Parameters:
      api - the api to bind the schema to. This parameter is required.
      options - configuration for bind behavior.
      Returns:
      ISchemaConfig with apiId and schema definition string

    • bind

      @Stability(Stable) @NotNull ISchemaConfig bind(@NotNull IGraphqlApi api)
      Binds a schema string to a GraphQlApi.

      Parameters:
      api - the api to bind the schema to. This parameter is required.
      Returns:
      ISchemaConfig with apiId and schema definition string