Skip to main content

Interface: AppSyncConfig

Configuration options for AWS AppSync GraphQL API. These options are used to connect to the AppSync GraphQL endpoint.

Example​

const appSyncConfig: AppSyncConfig = {
  endpoint: 'https://xxxxxxxxxx.appsync-api.us-east-1.amazonaws.com/graphql',
  apiKey: 'da2-xxxxxxxxxxxxxxxxxxxxxxxx'
};

Properties​

apiKey?​

optional apiKey: string

API key for accessing the AppSync API when using API key authentication. Required only if the auth mode is 'apiKey'.

endpoint​

endpoint: string

The URL of the AppSync GraphQL endpoint. This is where all GraphQL queries and mutations will be sent.