Class: AWSCDK::AppSync::Definition

Inherits:
Jsii::Object
  • Object
show all
Defined in:
app_sync/definition.rb

Overview

AppSync definition.

Specify how you want to define your AppSync API.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Definition

Returns a new instance of Definition.



10
11
12
 
# File 'app_sync/definition.rb', line 10

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.from_file(file_path) ⇒ AWSCDK::AppSync::Definition

Schema from file, allows schema definition through schema.graphql file.

Parameters:

  • file_path (String) —

    the file path of the schema file.

Returns:

  • (AWSCDK::AppSync::Definition) —

    Definition with schema from file



25
26
27
28
 
# File 'app_sync/definition.rb', line 25

def self.from_file(file_path)
  Jsii::Type.check_type(file_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filePath")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.Definition", "fromFile", [file_path])
end

.from_schema(schema) ⇒ AWSCDK::AppSync::Definition

Schema from schema object.

Parameters:

  • schema (AWSCDK::AppSync::ISchema) —

    SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file.

Returns:

  • (AWSCDK::AppSync::Definition) —

    Definition with schema from file



34
35
36
37
 
# File 'app_sync/definition.rb', line 34

def self.from_schema(schema)
  Jsii::Type.check_type(schema, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5JU2NoZW1hIn0=")), "schema")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.Definition", "fromSchema", [schema])
end

.from_source_apis(source_api_options) ⇒ AWSCDK::AppSync::Definition

Schema from existing AppSync APIs - used for creating a AppSync Merged API.

Parameters:

Returns:

  • (AWSCDK::AppSync::Definition) —

    Definition with for AppSync Merged API



43
44
45
46
47
 
# File 'app_sync/definition.rb', line 43

def self.from_source_apis(source_api_options)
  source_api_options = source_api_options.is_a?(Hash) ? ::AWSCDK::AppSync::SourceAPIOptions.new(**source_api_options.transform_keys(&:to_sym)) : source_api_options
  Jsii::Type.check_type(source_api_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5Tb3VyY2VBcGlPcHRpb25zIn0=")), "sourceApiOptions")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.Definition", "fromSourceApis", [source_api_options])
end

.jsii_overridable_methods ⇒ Object 



14
15
16
17
18
19
 
# File 'app_sync/definition.rb', line 14

def self.jsii_overridable_methods
  {
    :schema => { kind: :property, name: "schema", is_optional: true },
    :source_api_options => { kind: :property, name: "sourceApiOptions", is_optional: true },
  }
end

Instance Method Details

#schema ⇒ AWSCDK::AppSync::ISchema?

Schema, when AppSync API is created from schema file.

Returns:



52
53
54
 
# File 'app_sync/definition.rb', line 52

def schema()
  jsii_get_property("schema")
end

#source_api_options ⇒ AWSCDK::AppSync::SourceAPIOptions?

Source APIs for Merged API.

Returns:



59
60
61
 
# File 'app_sync/definition.rb', line 59

def source_api_options()
  jsii_get_property("sourceApiOptions")
end