AWS::AppSync::GraphQLSchemaCfnGraphQLSchema
The `AWS::AppSync::GraphQLSchema` resource is used for your AWS AppSync GraphQL schema that controls the data model for your API. Schema files are text written in Schema Definition Language (SDL) format. For more information about schema authoring, see [Designing a GraphQL API](https://docs.aws.amazon.com/appsync/latest/devguide/designing-a-graphql-api.html) in the *AWS AppSync Developer Guide* . > When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation. > > See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide* .
Import
import { CfnGraphQLSchema } from 'aws-cdk-lib/aws-appsync';Or use the module namespace:
import * as appsync from 'aws-cdk-lib/aws-appsync';
// appsync.CfnGraphQLSchemaProperties
Configuration passed to the constructor as CfnGraphQLSchemaProps.
apiIdRequiredstringThe AWS AppSync GraphQL API identifier to which you want to apply this schema.
definitionOptionalstringThe text representation of a GraphQL schema in SDL format. For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref) .
definitionS3LocationOptionalstringThe location of a GraphQL schema file in an Amazon S3 bucket. Use this if you want to provision with the schema living in Amazon S3 rather than embedding it in your CloudFormation template.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
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-appsyncAWS::AppSync::GraphQLSchema