Interface RuntimeConfig

Hierarchy

  • RuntimeConfig

Properties

appConfigS3Bucket? appName? aws_region behaviours? bulkOperations? chatgpt? cognito? cognitoProxyServiceLambdaName? cognito_iss? dataCache? dynamoDb? edgeCache? elastic_host elasticsearch eventBridge externalStorage graphQlTracing? gremlin_host gremlin_reader_connections? inMemoryDatabases is_local maxMembersDepth media_s3_bucket queryCache? reactions? redis? roles? s3? search? stepFunctions? url_alias verifiedPermissions?

Properties

Optional appConfigS3Bucket

appConfigS3Bucket?: string

Optional appName

appName?: string

aws_region

aws_region: string

Optional behaviours

behaviours?: KosmosConfig<string>[]

Optional bulkOperations

bulkOperations?: {
    jwtSecret: string;
}

Type declaration

  • jwtSecret: string

Optional chatgpt

chatgpt?: {
    apiKey: string;
    maxTokens: number;
    model: string;
    organisation: string;
}

Type declaration

  • apiKey: string
  • maxTokens: number
  • model: string
  • organisation: string

Optional cognito

cognito?: {
    region: string;
}

Type declaration

  • region: string

Optional cognitoProxyServiceLambdaName

cognitoProxyServiceLambdaName?: string

Optional cognito_iss

cognito_iss?: string

Optional dataCache

dataCache?: {
    enabled?: boolean;
    entities?: VertexCacheConfig[];
    ttl?: number;
}

Type declaration

  • Optional enabled?: boolean
  • Optional entities?: VertexCacheConfig[]
  • Optional ttl?: number

Optional dynamoDb

dynamoDb?: {
    endpoint?: string;
    region: string;
}

Type declaration

  • Optional endpoint?: string
  • region: string

Optional edgeCache

edgeCache?: {
    enabled?: boolean;
    ttl?: number;
}

Type declaration

  • Optional enabled?: boolean
  • Optional ttl?: number

elastic_host

elastic_host: string

elasticsearch

elasticsearch: {
    connectionHost?: string;
    connectionPort?: number;
    connectionUrl: string;
    endpointUrl: string;
    hostname: string;
    index: string;
    port?: number;
    useHttps?: boolean;
}

Type declaration

  • Optional connectionHost?: string
  • Optional connectionPort?: number
  • connectionUrl: string
  • endpointUrl: string
  • hostname: string
  • index: string
  • Optional port?: number
  • Optional useHttps?: boolean

eventBridge

eventBridge: {
    endpoint?: string;
    eventBusName: string;
    region: string;
}

Type declaration

  • Optional endpoint?: string
  • eventBusName: string
  • region: string

externalStorage

externalStorage: any

Optional graphQlTracing

graphQlTracing?: boolean

Enable support for Apollo Tracing (used by GraphQL Playground).

gremlin_host

gremlin_host: string

Optional gremlin_reader_connections

gremlin_reader_connections?: number

The number of read-only Gremlin connections. Used by ReaderConnectionPool.

inMemoryDatabases

inMemoryDatabases: Record<string, {
    host: string;
    password?: string;
    port: string | number;
    type: string;
    username?: string;
}>

is_local

is_local: boolean

maxMembersDepth

maxMembersDepth: number

media_s3_bucket

media_s3_bucket: string

Optional queryCache

queryCache?: {
    enabled?: boolean;
    ttl?: number;
}

Type declaration

  • Optional enabled?: boolean
  • Optional ttl?: number

Optional reactions

reactions?: {
    control_triggers_enabled?: boolean;
    table_name: string;
}

Type declaration

  • Optional control_triggers_enabled?: boolean
  • table_name: string

Optional redis

redis?: {
    host: string;
    password: string;
    port: string | number;
    username: string;
}

Type declaration

  • host: string
  • password: string
  • port: string | number
  • username: string

Optional roles

roles?: string[]

Optional s3

s3?: {
    endpoint?: string;
    region: string;
}

Type declaration

  • Optional endpoint?: string
  • region: string

Optional search

search?: {
    disable_gremlin_search_integration?: boolean;
    roles: {
        [key: string]: {
            accessKeys?: {
                custom?: TraversalAccessKeys;
                label?: string[];
            };
            fullAccess?: boolean;
        };
    };
    search_based_connections?: boolean;
    synonymsEnabled?: boolean;
}

Type declaration

  • Optional disable_gremlin_search_integration?: boolean
  • roles: {
        [key: string]: {
            accessKeys?: {
                custom?: TraversalAccessKeys;
                label?: string[];
            };
            fullAccess?: boolean;
        };
    }
    • [key: string]: {
          accessKeys?: {
              custom?: TraversalAccessKeys;
              label?: string[];
          };
          fullAccess?: boolean;
      }
      • Optional accessKeys?: {
            custom?: TraversalAccessKeys;
            label?: string[];
        }
        • Optional custom?: TraversalAccessKeys
        • Optional label?: string[]
      • Optional fullAccess?: boolean
  • Optional search_based_connections?: boolean
  • Optional synonymsEnabled?: boolean

Optional stepFunctions

stepFunctions?: {
    endpoint?: string;
    region: string;
}

Type declaration

  • Optional endpoint?: string
  • region: string

url_alias

url_alias: {
    table: string;
}

Type declaration

  • table: string

Optional verifiedPermissions

verifiedPermissions?: {
    endpoint?: string;
    mode?: string;
    policyStoreId: string;
    region: string;
    roleEdges?: string;
}

Type declaration

  • Optional endpoint?: string
  • Optional mode?: string
  • policyStoreId: string
  • region: string
  • Optional roleEdges?: string

Settings

Member Visibility

Theme

Generated using TypeDoc