AWS CDK Reference

Appearance

v2.273.0

Definition Class ​

AppSync definition.

Specify how you want to define your AppSync API.

Source
aws-appsync/lib/graphqlapi.ts
Type last changed
v2.94.0 · 1 Sep 2023

Example ​

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

Initializer ​

ts
new Definition()
python
Definition()
java
new Definition()
csharp
new Definition()
go
NewDefinition()

Properties ​

schemaISchemaschemaISchemaschemaISchemaSchemaISchemaSchemaISchema#
Schema, when AppSync API is created from schema file.
sourceApiOptionsSourceApiOptionssource_api_optionsSourceApiOptionssourceApiOptionsSourceApiOptionsSourceApiOptionsSourceApiOptionsSourceApiOptionsSourceApiOptions#
Source APIs for Merged API.

Methods ​

fromFile(filePath: string): Definition // chainable@staticmethod def from_file(file_path: str) -> Definitionpublic static Definition fromFile(String filePath)public static Definition FromFile(string filePath)func FromFile(FilePath *string) Definitionstatic#
Schema from file, allows schema definition through schema.graphql file.
1 parameter · returns

Parameters

  • filePathfile_pathfilePathfilePathFilePath — the file path of the schema file.

Returns: Definition with schema from file

fromSchema(schema: ISchema): Definition // chainable@staticmethod def from_schema(schema: ISchema) -> Definitionpublic static Definition fromSchema(ISchema schema)public static Definition FromSchema(ISchema schema)func FromSchema(Schema ISchema) Definitionstatic#
Schema from schema object.
1 parameter · returns

Parameters

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

Returns: Definition with schema from file

fromSourceApis(sourceApiOptions: SourceApiOptions): Definition // chainable@staticmethod def from_source_apis(source_api_options: SourceApiOptions) -> Definitionpublic static Definition fromSourceApis(SourceApiOptions sourceApiOptions)public static Definition FromSourceApis(SourceApiOptions sourceApiOptions)func FromSourceApis(SourceApiOptions SourceApiOptions) Definitionstatic#
Schema from existing AppSync APIs - used for creating a AppSync Merged API.
1 parameter · returns

Parameters

  • sourceApiOptionssource_api_optionssourceApiOptionssourceApiOptionsSourceApiOptions — Configuration for AppSync Merged API.

Returns: Definition with for AppSync Merged API