software.amazon.awscdk.services.appsync

Class CfnGraphQLSchema

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appsync.CfnGraphQLSchema

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.682Z")
 @Stability(value=Stable)
public class CfnGraphQLSchema
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppSync::GraphQLSchema`.

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 CfnGraphQLSchema cfnGraphQLSchema = CfnGraphQLSchema.Builder.create(this, "MyCfnGraphQLSchema")
         .apiId("apiId")
         // the properties below are optional
         .definition("definition")
         .definitionS3Location("definitionS3Location")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGraphQLSchema.Builder A fluent builder for CfnGraphQLSchema.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGraphQLSchema(software.constructs.Construct scope, String id, CfnGraphQLSchemaProps props) Create a new `AWS::AppSync::GraphQLSchema`.
protected	CfnGraphQLSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGraphQLSchema(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApiId() The AWS AppSync GraphQL API identifier to which you want to apply this schema.
protected Map<String,Object>	getCfnProperties()
String	getDefinition() The text representation of a GraphQL schema in SDL format.
String	getDefinitionS3Location() The location of a GraphQL schema file in an Amazon S3 bucket.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(String value) The AWS AppSync GraphQL API identifier to which you want to apply this schema.
void	setDefinition(String value) The text representation of a GraphQL schema in SDL format.
void	setDefinitionS3Location(String value) The location of a GraphQL schema file in an Amazon S3 bucket.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGraphQLSchema

protected CfnGraphQLSchema(software.amazon.jsii.JsiiObjectRef objRef)

CfnGraphQLSchema

protected CfnGraphQLSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGraphQLSchema

@Stability(value=Stable)
public CfnGraphQLSchema(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnGraphQLSchemaProps props)

Create a new `AWS::AppSync::GraphQLSchema`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

@Stability(value=Stable)
 @NotNull
public String getApiId()

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

setApiId

@Stability(value=Stable)
public void setApiId(@NotNull
                                              String value)

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

getDefinition

@Stability(value=Stable)
 @Nullable
public String getDefinition()

The text representation of a GraphQL schema in SDL format.

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

setDefinition

@Stability(value=Stable)
public void setDefinition(@Nullable
                                                   String value)

The text representation of a GraphQL schema in SDL format.

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

getDefinitionS3Location

@Stability(value=Stable)
 @Nullable
public String getDefinitionS3Location()

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.

setDefinitionS3Location

@Stability(value=Stable)
public void setDefinitionS3Location(@Nullable
                                                             String value)

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.