interface SchemaProps

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.SchemaProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#SchemaProps
Java	software.amazon.awscdk.services.appsync.SchemaProps
Python	aws_cdk.aws_appsync.SchemaProps
TypeScript (source)	aws-cdk-lib » aws_appsync » SchemaProps

The options for configuring a schema from an existing file.

Example

const schema = new appsync.SchemaFile({ filePath: 'mySchemaFile' })
const api = new appsync.GraphqlApi(this, 'api', {
  name: 'myApi',
  definition: appsync.Definition.fromSchema(schema),
  enhancedMetricsConfig: {
    dataSourceLevelMetricsBehavior: appsync.DataSourceLevelMetricsBehavior.PER_DATA_SOURCE_METRICS,
    operationLevelMetricsConfig: appsync.OperationLevelMetricsConfig.ENABLED,
    resolverLevelMetricsBehavior: appsync.ResolverLevelMetricsBehavior.PER_RESOLVER_METRICS,
  },
});

const noneDS = api.addNoneDataSource('none', {
  metricsConfig: appsync.DataSourceMetricsConfig.ENABLED,
});

noneDS.createResolver('noneResolver', {
  typeName: 'Mutation',
  fieldName: 'addDemoMetricsConfig',
  metricsConfig: appsync.ResolverMetricsConfig.ENABLED,
});

Properties

Name	Type	Description
filePath	string	The file path for the schema.

---

filePath

Type: string

The file path for the schema.

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