AppSync GraphQL API

Docs > DDSQL Reference > Data Directory > AppSync GraphQL API

AppSync GraphQL API is a managed service in AWS that lets you build scalable GraphQL APIs by connecting to data sources like DynamoDB, Lambda, or HTTP endpoints. It handles real-time data synchronization, offline access, and security with fine-grained access control. This service simplifies API development by managing the heavy lifting of querying, caching, and data integration.

aws.appsync_graphql_api

Fields

ID	Type	Data Type	Description
_key	core	string
account_id	core	string
additional_authentication_providers	core	json	A list of additional authentication providers for the GraphqlApi API.
api_id	core	string	The API ID.
api_type	core	string	The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
arn	core	string	The Amazon Resource Name (ARN).
authentication_type	core	string	The authentication type.
dns	core	hstore	The DNS records for the API.
enhanced_metrics_config	core	json	The enhancedMetricsConfig object.
introspection_config	core	string	Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled. For more information about introspection, see GraphQL introspection.
lambda_authorizer_config	core	json	Configuration for Lambda function authorization.
log_config	core	json	The Amazon CloudWatch Logs configuration.
merged_api_execution_role_arn	core	string	The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
name	core	string	The API name.
open_id_connect_config	core	json	The OpenID Connect configuration.
owner	core	string	The account owner of the GraphQL API.
owner_contact	core	string	The owner contact information for an API resource. This field accepts any string input with a length of 0 - 256 characters.
query_depth_limit	core	int64	The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds. Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.
resolver_count_limit	core	int64	The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.
tags	core	hstore
uris	core	hstore	The URIs.
user_pool_config	core	json	The Amazon Cognito user pool configuration.
visibility	core	string	Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
waf_web_acl_arn	core	string	The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
xray_enabled	core	bool	A flag indicating whether to use X-Ray tracing for this GraphqlApi.