AppSyncApiConfig

Defined in: packages/core/src/config/types.ts:181

One AppSync GraphQL API (Phase 3D — schema-first + Lambda data sources). Extends the full CDK GraphqlApiProps minus the props Axis controls, so every other CDK option is available directly (“Axis IS CDK”).

Extends

Omit<appsync.GraphqlApiProps, "name" | "definition" | "schema" | "authorizationConfig" | "xrayEnabled" | "logConfig">

Properties

authModes?

optional authModes?: AppSyncAuthMode[]

Defined in: packages/core/src/config/types.ts:197

First = defaultAuthorization, rest = additional. Default: [{ type: “userPool” }].

baseName

baseName: string

Defined in: packages/core/src/config/types.ts:188

Stable base name; the API name becomes ${baseName}-${stageName}.

cache?

optional cache?: AppSyncCacheConfig

Defined in: packages/core/src/config/types.ts:203

API-level server-side cache (Phase 3D3). Absent ⇒ no cache.

constructId

constructId: string

Defined in: packages/core/src/config/types.ts:186

NEVER-rename construct id (logical-ID stability).

dataSources?

optional dataSources?: AppSyncDataSourceConfig[]

Defined in: packages/core/src/config/types.ts:195

Non-Lambda data sources (DynamoDB/HTTP/None), referenced by name.

domain?

optional domain?: AppSyncDomainConfig

Defined in: packages/core/src/config/types.ts:205

Custom domain for the GraphQL + realtime endpoints (Phase 3D3).

domainName?

readonly optional domainName?: DomainOptions

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-appsync/lib/graphqlapi.d.ts:420

The domain name configuration for the GraphQL API

The Route 53 hosted zone and CName DNS record must be configured in addition to this setting to enable custom domain URL

Default

- no domain name

Inherited from

Omit.domainName

enhancedMetricsConfig?

readonly optional enhancedMetricsConfig?: EnhancedMetricsConfig

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-appsync/lib/graphqlapi.d.ts:469

Enables and controls the enhanced metrics feature.

Default

- Enhanced metrics disabled.

Inherited from

Omit.enhancedMetricsConfig

environmentVariables?

readonly optional environmentVariables?: object

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-appsync/lib/graphqlapi.d.ts:453

A map containing the list of resources with their properties and environment variables.

There are a few rules you must follow when creating keys and values:

Keys must begin with a letter.
Keys must be between 2 and 64 characters long.
Keys can only contain letters, numbers, and the underscore character (_).
Values can be up to 512 characters long.
You can configure up to 50 key-value pairs in a GraphQL API.

Index Signature

[key: string]: string

Default

- No environment variables.

Inherited from

Omit.environmentVariables

fieldLogLevel?

optional fieldLogLevel?: AppSyncFieldLogLevel

Defined in: packages/core/src/config/types.ts:199

Field-level logging. Default “ERROR”; “NONE” disables logConfig.

introspectionConfig?

readonly optional introspectionConfig?: IntrospectionConfig

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-appsync/lib/graphqlapi.d.ts:426

A value indicating whether the API to enable (ENABLED) or disable (DISABLED) introspection.

Default

IntrospectionConfig.ENABLED

Inherited from

Omit.introspectionConfig

ownerContact?

readonly optional ownerContact?: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-appsync/lib/graphqlapi.d.ts:463

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Default

- No owner contact.

Inherited from

Omit.ownerContact

privateVpc?

optional privateVpc?: AppSyncPrivateVpcConfig

Defined in: packages/core/src/config/types.ts:207

VPC interface-endpoint wiring when visibility is PRIVATE (Phase 3D3).

queryDepthLimit?

readonly optional queryDepthLimit?: number

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-appsync/lib/graphqlapi.d.ts:433

A number indicating the maximum depth resolvers should be accepted when handling queries. Value must be withing range of 0 to 75

Default

- The default value is 0 (or unspecified) which indicates no maximum depth.

Inherited from

Omit.queryDepthLimit

resolverCountLimit?

readonly optional resolverCountLimit?: number

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-appsync/lib/graphqlapi.d.ts:440

A number indicating the maximum number of resolvers that should be accepted when handling queries. Value must be withing range of 0 to 10000

Default

- The default value is 0 (or unspecified), which will set the limit to 10000

Inherited from

Omit.resolverCountLimit

resolvers

resolvers: AppSyncResolverConfig[]

Defined in: packages/core/src/config/types.ts:193

Resolvers. Untyped / type:“lambda” → frozen 3D Lambda path; vtl/js/pipeline are 3D2. Bare GraphqlLambdaConfig[] from a 3D project still type-checks.

schemaPath

schemaPath: string

Defined in: packages/core/src/config/types.ts:190

Path (relative to projectRoot) to the .graphql SDL schema.

visibility?

readonly optional visibility?: Visibility

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-appsync/lib/graphqlapi.d.ts:411

A value indicating whether the API is accessible from anywhere (GLOBAL) or can only be access from a VPC (PRIVATE).

Default

- GLOBAL

Inherited from

Omit.visibility

xray?

optional xray?: boolean

Defined in: packages/core/src/config/types.ts:201

X-Ray tracing. Default true.