aws-cdk-lib.aws_appsync.CfnGraphQLSchemaProps

interface CfnGraphQLSchemaProps

LanguageType name
.NETAmazon.CDK.AWS.AppSync.CfnGraphQLSchemaProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnGraphQLSchemaProps
Javasoftware.amazon.awscdk.services.appsync.CfnGraphQLSchemaProps
Pythonaws_cdk.aws_appsync.CfnGraphQLSchemaProps
TypeScript aws-cdk-lib » aws_appsync » CfnGraphQLSchemaProps

Properties for defining a CfnGraphQLSchema.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const cfnGraphQLSchemaProps: appsync.CfnGraphQLSchemaProps = {
  apiId: 'apiId',

  // the properties below are optional
  definition: 'definition',
  definitionS3Location: 'definitionS3Location',
};

Properties

NameTypeDescription
apiIdstringThe AWS AppSync GraphQL API identifier to which you want to apply this schema.
definition?stringThe text representation of a GraphQL schema in SDL format.
definitionS3Location?stringThe location of a GraphQL schema file in an Amazon S3 bucket.

apiId

Type: string

The AWS AppSync GraphQL API identifier to which you want to apply this schema.


definition?

Type: string (optional)

The text representation of a GraphQL schema in SDL format.

For more information about using the Ref function, see Ref .


definitionS3Location?

Type: string (optional)

The 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.