Module: AWSCDK::AppSync::ISchema

Included in:

SchemaFile

Defined in:

app_sync/i_schema.rb

Overview

Interface for implementing your own schema.

Useful for providing schema's from sources other than assets

Class Method Summary

• .jsii_overridable_methods ⇒ Object

Instance Method Summary

• #bind(api, options = nil) ⇒ AWSCDK::AppSync::ISchemaConfig

  Binds a schema string to a GraphQlApi.

Class Method Details

.jsii_overridable_methods ⇒ Object

# File 'app_sync/i_schema.rb', line 21

def self.jsii_overridable_methods
  {
    :bind => { kind: :method, name: "bind", is_optional: false },
  }
end

Instance Method Details

#bind(api, options = nil) ⇒ AWSCDK::AppSync::ISchemaConfig

Binds a schema string to a GraphQlApi.

Parameters:

• api (AWSCDK::Interfaces::AWSAppsync::IGraphQLAPIRef) —

  the api to bind the schema to.

• options (AWSCDK::AppSync::SchemaBindOptions, nil) (defaults to: nil) —

  configuration for bind behavior.

Returns:

• (AWSCDK::AppSync::ISchemaConfig) —

  ISchemaConfig with apiId and schema definition string

# File 'app_sync/i_schema.rb', line 14

def bind(api, options = nil)
  Jsii::Type.check_type(api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBzeW5jLklHcmFwaFFMQXBpUmVmIn0=")), "api")
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::SchemaBindOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5TY2hlbWFCaW5kT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("bind", [api, options])
end