GraphqlApi
An AppSync GraphQL API.
Import
import { GraphqlApi } from 'aws-cdk-lib/aws-appsync';Or use the module namespace:
import * as appsync from 'aws-cdk-lib/aws-appsync';
// appsync.GraphqlApiProperties
Configuration passed to the constructor as GraphqlApiProps.
nameRequiredstringthe name of the GraphQL API.
authorizationConfigOptionalAuthorizationConfigOptional authorization configuration.
Default: - API Key authorization
definitionOptionalDefinitionDefinition (schema file or source APIs) for this GraphQL Api.
domainNameOptionalDomainOptionsThe 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
enhancedMetricsConfigOptionalEnhancedMetricsConfigEnables and controls the enhanced metrics feature.
Default: - Enhanced metrics disabled.
environmentVariablesOptional{ [key: string]: string }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.
Default: - No environment variables.
introspectionConfigOptionalIntrospectionConfigA value indicating whether the API to enable (ENABLED) or disable (DISABLED) introspection.
Default: IntrospectionConfig.ENABLED
logConfigOptionalLogConfigLogging configuration for this api.
Default: - None
ownerContactOptionalstringThe owner contact information for an API resource. This field accepts any string input with a length of 0 - 256 characters.
Default: - No owner contact.
queryDepthLimitOptionalnumberA 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.
resolverCountLimitOptionalnumberA 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
schemaOptionalDeprecatedISchemaGraphQL schema definition. Specify how you want to define your schema. SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file
Default: - schema will be generated code-first (i.e. addType, addObjectType, etc.)
Deprecated: use Definition.schema instead
visibilityOptionalVisibilityA value indicating whether the API is accessible from anywhere (GLOBAL) or can only be access from a VPC (PRIVATE).
Default: - GLOBAL
xrayEnabledOptionalbooleanA flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.
Default: - false
Get the AWS AppSync Cheat Sheet
Everything you need to know about AWS AppSync on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-appsync