Package software.amazon.awscdk.services.appsync

Class GraphqlApiProps.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.GraphqlApiProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GraphqlApiProps>

Enclosing interface:

GraphqlApiProps

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

A builder for GraphqlApiProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GraphqlApiProps.Builder	authorizationConfig(AuthorizationConfig authorizationConfig)	Sets the value of GraphqlApiProps.getAuthorizationConfig()
GraphqlApiProps	build()	Builds the configured instance.
GraphqlApiProps.Builder	domainName(DomainOptions domainName)	Sets the value of GraphqlApiProps.getDomainName()
GraphqlApiProps.Builder	logConfig(LogConfig logConfig)	Sets the value of GraphqlApiProps.getLogConfig()
GraphqlApiProps.Builder	name(String name)	Sets the value of GraphqlApiProps.getName()
GraphqlApiProps.Builder	schema(Schema schema)	Sets the value of GraphqlApiProps.getSchema()
GraphqlApiProps.Builder	xrayEnabled(Boolean xrayEnabled)	Sets the value of GraphqlApiProps.getXrayEnabled()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

name

@Stability(Experimental)
public GraphqlApiProps.Builder name(String name)

Sets the value of GraphqlApiProps.getName()

Parameters:

name - the name of the GraphQL API. This parameter is required.

Returns:

this

authorizationConfig

@Stability(Experimental)
public GraphqlApiProps.Builder authorizationConfig(AuthorizationConfig authorizationConfig)

Sets the value of GraphqlApiProps.getAuthorizationConfig()

Parameters:

authorizationConfig - Optional authorization configuration.

Returns:

this

domainName

@Stability(Experimental)
public GraphqlApiProps.Builder domainName(DomainOptions domainName)

Sets the value of GraphqlApiProps.getDomainName()

Parameters:

domainName - The domain name configuration for the GraphQL API. The Route 53 hosted zone and CName DNS record must be configured in addition to this setting to enable custom domain URL

Returns:

this

logConfig

@Stability(Experimental)
public GraphqlApiProps.Builder logConfig(LogConfig logConfig)

Sets the value of GraphqlApiProps.getLogConfig()

Parameters:

logConfig - Logging configuration for this api.

Returns:

this

schema

@Stability(Experimental)
public GraphqlApiProps.Builder schema(Schema schema)

Sets the value of GraphqlApiProps.getSchema()

Parameters:

schema - GraphQL schema definition. Specify how you want to define your schema. Schema.fromFile(filePath: string) allows schema definition through schema.graphql file

Returns:

this

xrayEnabled

@Stability(Experimental)
public GraphqlApiProps.Builder xrayEnabled(Boolean xrayEnabled)

Sets the value of GraphqlApiProps.getXrayEnabled()

Parameters:

xrayEnabled - A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.

Returns:

this

build

@Stability(Experimental)
public GraphqlApiProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GraphqlApiProps

Throws:

NullPointerException - if any required attribute was not provided