Class CfnGraphQLSchema
A CloudFormation AWS::AppSync::GraphQLSchema
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public class CfnGraphQLSchema : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnGraphQLSchema
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 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 in the AWS CloudFormation User Guide .
CloudformationResource: AWS::AppSync::GraphQLSchema
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 cfnGraphQLSchema = new CfnGraphQLSchema(this, "MyCfnGraphQLSchema", new CfnGraphQLSchemaProps {
ApiId = "apiId",
// the properties below are optional
Definition = "definition",
DefinitionS3Location = "definitionS3Location"
});
Synopsis
Constructors
CfnGraphQLSchema(Construct, String, ICfnGraphQLSchemaProps) | Create a new |
CfnGraphQLSchema(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGraphQLSchema(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiId | The AWS AppSync GraphQL API identifier to which you want to apply this schema. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Definition | The text representation of a GraphQL schema in SDL format. |
DefinitionS3Location | The location of a GraphQL schema file in an Amazon S3 bucket. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGraphQLSchema(Construct, String, ICfnGraphQLSchemaProps)
Create a new AWS::AppSync::GraphQLSchema
.
public CfnGraphQLSchema(Construct scope, string id, ICfnGraphQLSchemaProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnGraphQLSchemaProps
- resource properties.
CfnGraphQLSchema(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGraphQLSchema(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGraphQLSchema(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGraphQLSchema(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiId
The AWS AppSync GraphQL API identifier to which you want to apply this schema.
public virtual string ApiId { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Definition
The text representation of a GraphQL schema in SDL format.
public virtual string Definition { get; set; }
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.
public virtual string DefinitionS3Location { get; set; }
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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>