Package software.amazon.awscdk.services.appsync

Class CfnGraphQLSchema.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.CfnGraphQLSchema.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGraphQLSchema>

Enclosing class:

CfnGraphQLSchema

@Stability(Stable)
public static final class CfnGraphQLSchema.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGraphQLSchema>

A fluent builder for CfnGraphQLSchema.

Method Summary

Modifier and Type	Method	Description
CfnGraphQLSchema.Builder	apiId(String apiId)	The AWS AppSync GraphQL API identifier to which you want to apply this schema.
CfnGraphQLSchema	build()
static CfnGraphQLSchema.Builder	create(Construct scope, String id)
CfnGraphQLSchema.Builder	definition(String definition)	The text representation of a GraphQL schema in SDL format.
CfnGraphQLSchema.Builder	definitionS3Location(String definitionS3Location)	The location of a GraphQL schema file in an Amazon S3 bucket.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnGraphQLSchema.Builder create(Construct scope,
 String id)

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

Returns:

a new instance of CfnGraphQLSchema.Builder.

apiId

@Stability(Stable)
public CfnGraphQLSchema.Builder apiId(String apiId)

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

Parameters:

apiId - The AWS AppSync GraphQL API identifier to which you want to apply this schema. This parameter is required.

Returns:

this

definition

@Stability(Stable)
public CfnGraphQLSchema.Builder definition(String definition)

The text representation of a GraphQL schema in SDL format.

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

Parameters:

definition - The text representation of a GraphQL schema in SDL format. This parameter is required.

Returns:

this

definitionS3Location

@Stability(Stable)
public CfnGraphQLSchema.Builder definitionS3Location(String definitionS3Location)

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.

Parameters:

definitionS3Location - The location of a GraphQL schema file in an Amazon S3 bucket. This parameter is required.

Returns:

this

build

@Stability(Stable)
public CfnGraphQLSchema build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnGraphQLSchema>

Returns:

a newly built instance of CfnGraphQLSchema.