Interface APIGraphQLConfig

interface APIGraphQLConfig {
    apiKey?: string;
    customEndpoint?: string;
    customEndpointRegion?: string;
    defaultAuthMode: GraphQLAuthMode;
    endpoint: string;
    modelIntrospection?: ModelIntrospectionSchema;
    region?: string;
}

Properties

apiKey? customEndpoint? customEndpointRegion? defaultAuthMode endpoint modelIntrospection? region?

Properties

Optional apiKey

apiKey?: string

Optional API key string. Required only if the auth mode is 'apiKey'.

Optional customEndpoint

customEndpoint?: string

Custom domain endpoint for GraphQL API.

Optional customEndpointRegion

customEndpointRegion?: string

Optional region string used to sign the request to customEndpoint. Effective only if customEndpoint is specified, and the auth mode is 'iam'.

defaultAuthMode

defaultAuthMode: GraphQLAuthMode

Default auth mode for all the API calls to given service.

endpoint

endpoint: string

Required GraphQL endpoint, must be a valid URL string.

Optional modelIntrospection

modelIntrospection?: ModelIntrospectionSchema

Optional region

region?: string

Optional region string used to sign the request. Required only if the auth mode is 'iam'.

Settings

Member Visibility

Theme

On This Page