Amazon AppSync · Schema

CreateGraphqlApiRequest

Request to create a GraphQL API

Amazon AppSyncGraphQLAPI ManagementServerless

Properties

Name Type Description
name string The API name
authenticationType string Default authentication type
logConfig string logConfig
additionalAuthenticationProviders array Additional authentication providers
xrayEnabled boolean Enable X-Ray tracing
tags object Resource tags
lambdaAuthorizerConfig string lambdaAuthorizerConfig
visibility string API visibility
apiType string API type
View JSON Schema on GitHub

JSON Schema

appsync-create-graphql-api-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/amazon-appsync/json-schema/appsync-create-graphql-api-request-schema.json",
  "title": "CreateGraphqlApiRequest",
  "description": "Request to create a GraphQL API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The API name"
    },
    "authenticationType": {
      "type": "string",
      "description": "Default authentication type"
    },
    "logConfig": {
      "type": "string",
      "description": "logConfig"
    },
    "additionalAuthenticationProviders": {
      "type": "array",
      "description": "Additional authentication providers"
    },
    "xrayEnabled": {
      "type": "boolean",
      "description": "Enable X-Ray tracing"
    },
    "tags": {
      "type": "object",
      "description": "Resource tags"
    },
    "lambdaAuthorizerConfig": {
      "type": "string",
      "description": "lambdaAuthorizerConfig"
    },
    "visibility": {
      "type": "string",
      "description": "API visibility"
    },
    "apiType": {
      "type": "string",
      "description": "API type"
    }
  }
}