Package software.amazon.awscdk.services.appsync

Interface SchemaProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SchemaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-31T09:54:25.455Z")
@Stability(Stable)
public interface SchemaProps
extends software.amazon.jsii.JsiiSerializable

The options for configuring a schema from an existing file.

Example:

 SchemaFile schema = SchemaFile.Builder.create().filePath("mySchemaFile").build();
 GraphqlApi api = GraphqlApi.Builder.create(this, "api")
         .name("myApi")
         .definition(Definition.fromSchema(schema))
         .enhancedMetricsConfig(EnhancedMetricsConfig.builder()
                 .dataSourceLevelMetricsBehavior(DataSourceLevelMetricsBehavior.PER_DATA_SOURCE_METRICS)
                 .operationLevelMetricsConfig(OperationLevelMetricsConfig.ENABLED)
                 .resolverLevelMetricsBehavior(ResolverLevelMetricsBehavior.PER_RESOLVER_METRICS)
                 .build())
         .build();
 NoneDataSource noneDS = api.addNoneDataSource("none", DataSourceOptions.builder()
         .metricsConfig(DataSourceMetricsConfig.ENABLED)
         .build());
 noneDS.createResolver("noneResolver", BaseResolverProps.builder()
         .typeName("Mutation")
         .fieldName("addDemoMetricsConfig")
         .metricsConfig(ResolverMetricsConfig.ENABLED)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFilePath

@Stability(Stable)
@NotNull
String getFilePath()

The file path for the schema.

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

builder

@Stability(Stable)
static SchemaProps.Builder builder()

Returns:

a SchemaProps.Builder of SchemaProps