The type definition for the GraphQL resolvers.
Creates an instance of GraphQlApi.
The scope in which this construct is defined.
The scoped construct ID.
The properties of the GraphQlApi construct.
Private
_functionsA collection of Lambda functions used as resolvers for the GraphQL API.
Readonly
apiThe AWS AppSync GraphQL API instance.
Protected
Optional
Readonly
apiProtected
Optional
Readonly
apiFQDNProtected
Optional
Readonly
apiPrivate
cognitoThe Cognito authentication configuration.
Protected
Optional
Readonly
hostedReadonly
nodeThe tree node.
Private
propsThe properties of the GraphQlApi construct.
Optional
Readonly
tableThe optional DynamoDB data source for the GraphQL API.
Optional
options: JsResolverOptionsOptional
Optional
options: Omit<VtlResolverOptions, "dataSource">Optional
Optional
options: JsResolverOptionsOptional
Private
createPrivate
createJSResolvergetFunctionForOperation
Private
substStatic
isChecks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
Any object
true if x
is an object created from a class which extends Construct
.
Generated using TypeDoc
The GraphQlApi construct sets up an AWS AppSync GraphQL API integrated with Cognito for authentication and DynamoDB for data storage. This construct facilitates the creation of a GraphQL API with various configurations, including custom domain, logging, schema definition, and authorization using Cognito User Pool and Identity Pool. It also provides methods to dynamically add resolvers and grant access to specific fields.
Example