Skip to content
v2.277.0

Definition Class ​

AppSync definition.

Specify how you want to define your AppSync API.

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,
  },
});
python
schema = appsync.SchemaFile(file_path="mySchemaFile")
appsync.GraphqlApi(self, "api",
    name="myApi",
    definition=appsync.Definition.from_schema(schema),
    enhanced_metrics_config=appsync.EnhancedMetricsConfig(
        data_source_level_metrics_behavior=appsync.DataSourceLevelMetricsBehavior.FULL_REQUEST_DATA_SOURCE_METRICS,
        operation_level_metrics_config=appsync.OperationLevelMetricsConfig.ENABLED,
        resolver_level_metrics_behavior=appsync.ResolverLevelMetricsBehavior.FULL_REQUEST_RESOLVER_METRICS
    )
)
java
SchemaFile schema = SchemaFile.Builder.create().filePath("mySchemaFile").build();
GraphqlApi.Builder.create(this, "api")
        .name("myApi")
        .definition(Definition.fromSchema(schema))
        .enhancedMetricsConfig(EnhancedMetricsConfig.builder()
                .dataSourceLevelMetricsBehavior(DataSourceLevelMetricsBehavior.FULL_REQUEST_DATA_SOURCE_METRICS)
                .operationLevelMetricsConfig(OperationLevelMetricsConfig.ENABLED)
                .resolverLevelMetricsBehavior(ResolverLevelMetricsBehavior.FULL_REQUEST_RESOLVER_METRICS)
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
var schema = new SchemaFile(new SchemaProps { FilePath = "mySchemaFile" });
new GraphqlApi(this, "api", new GraphqlApiProps {
    Name = "myApi",
    Definition = Definition.FromSchema(schema),
    EnhancedMetricsConfig = new EnhancedMetricsConfig {
        DataSourceLevelMetricsBehavior = DataSourceLevelMetricsBehavior.FULL_REQUEST_DATA_SOURCE_METRICS,
        OperationLevelMetricsConfig = OperationLevelMetricsConfig.ENABLED,
        ResolverLevelMetricsBehavior = ResolverLevelMetricsBehavior.FULL_REQUEST_RESOLVER_METRICS
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
schema := appsync.NewSchemaFile(&SchemaProps{
	FilePath: jsii.String("mySchemaFile"),
})
appsync.NewGraphqlApi(this, jsii.String("api"), &GraphqlApiProps{
	Name: jsii.String("myApi"),
	Definition: appsync.Definition_FromSchema(schema),
	EnhancedMetricsConfig: &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 ​

schemamay be undefinedISchemaschemamay be undefinedISchemaschemamay be undefinedISchemaSchemamay be undefinedISchemaSchemamay be undefinedISchema#
Schema, when AppSync API is created from schema file.
sourceApiOptionsmay be undefinedSourceApiOptionssource_api_optionsmay be undefinedSourceApiOptionssourceApiOptionsmay be undefinedSourceApiOptionsSourceApiOptionsmay be undefinedSourceApiOptionsSourceApiOptionsmay be undefinedSourceApiOptions#
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