Package software.amazon.awscdk.services.appsync

Interface CfnGraphQLSchemaProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGraphQLSchemaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:28.925Z")
@Stability(Stable)
public interface CfnGraphQLSchemaProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGraphQLSchema.

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.*;
 CfnGraphQLSchemaProps cfnGraphQLSchemaProps = CfnGraphQLSchemaProps.builder()
         .apiId("apiId")
         // the properties below are optional
         .definition("definition")
         .definitionS3Location("definitionS3Location")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGraphQLSchemaProps.Builder	A builder for CfnGraphQLSchemaProps
static final class	CfnGraphQLSchemaProps.Jsii$Proxy	An implementation for CfnGraphQLSchemaProps

Method Summary

Modifier and Type	Method	Description
static CfnGraphQLSchemaProps.Builder	builder()
String	getApiId()	The AWS AppSync GraphQL API identifier to which you want to apply this schema.
default String	getDefinition()	The text representation of a GraphQL schema in SDL format.
default String	getDefinitionS3Location()	The location of a GraphQL schema file in an Amazon S3 bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

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

See Also:

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

getDefinition

@Stability(Stable)
@Nullable
default String getDefinition()

The text representation of a GraphQL schema in SDL format.

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

See Also:

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

getDefinitionS3Location

@Stability(Stable)
@Nullable
default 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.

See Also:

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

builder

@Stability(Stable)
static CfnGraphQLSchemaProps.Builder builder()

Returns:

a CfnGraphQLSchemaProps.Builder of CfnGraphQLSchemaProps