Package software.amazon.awscdk.services.appsync

Interface SchemaOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SchemaOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.575Z")
@Stability(Experimental)
public interface SchemaOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) The options for configuring a schema.

If no options are specified, then the schema will be generated code-first.

Example:

 // 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.*;
 SchemaOptions schemaOptions = SchemaOptions.builder()
         .filePath("filePath")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SchemaOptions.Builder	A builder for SchemaOptions
static final class	SchemaOptions.Jsii$Proxy	An implementation for SchemaOptions

Method Summary

Modifier and Type	Method	Description
static SchemaOptions.Builder	builder()
default String	getFilePath()	(experimental) The file path for the schema.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFilePath

@Stability(Experimental)
@Nullable
default String getFilePath()

(experimental) The file path for the schema.

When this option is configured, then the schema will be generated from an existing file from disk.

Default: - schema not configured through disk asset

builder

@Stability(Experimental)
static SchemaOptions.Builder builder()

Returns:

a SchemaOptions.Builder of SchemaOptions