Package software.amazon.awscdk.services.appsync

Class CfnGraphQLSchema

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appsync.CfnGraphQLSchema
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.449Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGraphQLSchema

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

    • CfnGraphQLSchema

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

    • CfnGraphQLSchema

      @Stability(Stable) public CfnGraphQLSchema(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The AWS AppSync GraphQL API identifier to which you want to apply this schema.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The AWS AppSync GraphQL API identifier to which you want to apply this schema.

    • getDefinition

      @Stability(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(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(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(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.