Interface ICfnGraphQLSchemaProps
Properties for defining a CfnGraphQLSchema
.
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnGraphQLSchemaProps
Syntax (vb)
Public Interface ICfnGraphQLSchemaProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
var cfnGraphQLSchemaProps = new CfnGraphQLSchemaProps {
ApiId = "apiId",
// the properties below are optional
Definition = "definition",
DefinitionS3Location = "definitionS3Location"
};
Synopsis
Properties
ApiId | The AWS AppSync GraphQL API identifier to which you want to apply this schema. |
Definition | The text representation of a GraphQL schema in SDL format. |
DefinitionS3Location | The location of a GraphQL schema file in an Amazon S3 bucket. |
Properties
ApiId
The AWS AppSync GraphQL API identifier to which you want to apply this schema.
string ApiId { get; }
Property Value
System.String
Remarks
Definition
The text representation of a GraphQL schema in SDL format.
virtual string Definition { get; }
Property Value
System.String
Remarks
For more information about using the Ref
function, see Ref .
DefinitionS3Location
The location of a GraphQL schema file in an Amazon S3 bucket.
virtual string DefinitionS3Location { get; }
Property Value
System.String
Remarks
Use this if you want to provision with the schema living in Amazon S3 rather than embedding it in your CloudFormation template.