Class CfnGraphQLSchemaProps

Properties for defining a CfnGraphQLSchema.

Inheritance

object

CfnGraphQLSchemaProps

Implements

ICfnGraphQLSchemaProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGraphQLSchemaProps : ICfnGraphQLSchemaProps

Syntax (vb)

Public Class CfnGraphQLSchemaProps Implements ICfnGraphQLSchemaProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html

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

Constructors

CfnGraphQLSchemaProps()

Properties for defining a CfnGraphQLSchema.

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.

Constructors

CfnGraphQLSchemaProps()

Properties for defining a CfnGraphQLSchema.

public CfnGraphQLSchemaProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html

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"
             };

Properties

ApiId

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

public string ApiId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-apiid

Definition

The text representation of a GraphQL schema in SDL format.

public string? Definition { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definition

DefinitionS3Location

The location of a GraphQL schema file in an Amazon S3 bucket.

public string? DefinitionS3Location { get; set; }

Property Value

string

Remarks

Use this if you want to provision with the schema living in Amazon S3 rather than embedding it in your CloudFormation template.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definitions3location

Implements

ICfnGraphQLSchemaProps