Package software.amazon.awscdk.cfnpropertymixins.services.appsync

Interface CfnGraphQLSchemaMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGraphQLSchemaMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.001Z")
@Stability(Stable)
public interface CfnGraphQLSchemaMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnGraphQLSchemaPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.appsync.*;
 CfnGraphQLSchemaMixinProps cfnGraphQLSchemaMixinProps = CfnGraphQLSchemaMixinProps.builder()
         .apiId("apiId")
         .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	CfnGraphQLSchemaMixinProps.Builder	A builder for CfnGraphQLSchemaMixinProps
static final class	CfnGraphQLSchemaMixinProps.Jsii$Proxy	An implementation for CfnGraphQLSchemaMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnGraphQLSchemaMixinProps.Builder	builder()
default 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)
@Nullable
default 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 CfnGraphQLSchemaMixinProps.Builder builder()

Returns:

a CfnGraphQLSchemaMixinProps.Builder of CfnGraphQLSchemaMixinProps