Amazon AppSync · JSON Structure

Appsync Graphql Api Structure

A GraphQL API object managed by AppSync

Type: record Properties: 0
Amazon AppSyncGraphQLAPI ManagementServerless

Appsync Graphql Api Structure is a JSON Structure definition published by Amazon AppSync. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://api-evangelist.github.io/amazon-appsync/json-structure/appsync-graphql-api-structure.json",
  "title": "GraphqlApi",
  "description": "A GraphQL API object managed by AppSync",
  "type": "record",
  "fields": {
    "apiId": {
      "type": "string",
      "description": "The API ID"
    },
    "name": {
      "type": "string",
      "description": "The API name"
    },
    "authenticationType": {
      "type": "string",
      "description": "The default authentication type"
    },
    "arn": {
      "type": "string",
      "description": "The ARN of the API"
    },
    "uris": {
      "type": "object",
      "description": "The URIs for the API endpoint"
    },
    "tags": {
      "type": "object",
      "description": "Tags on the API"
    },
    "additionalAuthenticationProviders": {
      "type": "array",
      "description": "Additional authentication providers"
    },
    "logConfig": {
      "type": "string",
      "description": "logConfig"
    },
    "xrayEnabled": {
      "type": "boolean",
      "description": "Whether X-Ray tracing is enabled"
    },
    "wafWebAclArn": {
      "type": "string",
      "description": "WAF Web ACL ARN"
    },
    "lambdaAuthorizerConfig": {
      "type": "string",
      "description": "lambdaAuthorizerConfig"
    },
    "visibility": {
      "type": "string",
      "description": "API visibility"
    },
    "apiType": {
      "type": "string",
      "description": "API type"
    }
  }
}