Skip to main content
Version: Next

graphql_api

Table to manage GraphQL API entires

See

https://aws.amazon.com/appsync

Columns

api_id: string

AWS ID for the GraphQL entry

arn: string

ARN for the AWS resource

authentication_type: authentication_type

Authentication type for the endpoint

Optional lambda_authorizer_config: Object

Specific configuration for Lambda Authentication Type

See

https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html

Type declaration

NameType
authorizer_result_ttl_in_secondsundefined | number
authorizer_uriundefined | string
identity_validation_expressionundefined | string

name: string

Name to identify the GraphQL entry

Optional open_id_connect_config: Object

Specific configuration for the Open ID authentication type

See

https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html

Type declaration

NameType
auth_ttlundefined | number
client_idundefined | string
ia_ttlundefined | number
issuerundefined | string

region: string

Region where the API gateway will be created

See

https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html

Optional tags: Object

Complex type to provide identifier tags

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-appsync/interfaces/graphqlapi-3.html#tags-4

Type definition

[key: string]: string

Optional user_pool_config: Object

Specific configuration for Cognito authentication type

See

https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html

Type declaration

NameType
app_id_client_regexundefined | string
aws_regionundefined | string
default_actionundefined | default_action
user_pool_idundefined | string