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(Stable)
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	definition(Definition definition)	Sets the value of GraphqlApiProps.getDefinition()
GraphqlApiProps.Builder	domainName(DomainOptions domainName)	Sets the value of GraphqlApiProps.getDomainName()
GraphqlApiProps.Builder	environmentVariables(Map<String,String> environmentVariables)	Sets the value of GraphqlApiProps.getEnvironmentVariables()
GraphqlApiProps.Builder	introspectionConfig(IntrospectionConfig introspectionConfig)	Sets the value of GraphqlApiProps.getIntrospectionConfig()
GraphqlApiProps.Builder	logConfig(LogConfig logConfig)	Sets the value of GraphqlApiProps.getLogConfig()
GraphqlApiProps.Builder	name(String name)	Sets the value of GraphqlApiProps.getName()
GraphqlApiProps.Builder	queryDepthLimit(Number queryDepthLimit)	Sets the value of GraphqlApiProps.getQueryDepthLimit()
GraphqlApiProps.Builder	resolverCountLimit(Number resolverCountLimit)	Sets the value of GraphqlApiProps.getResolverCountLimit()
GraphqlApiProps.Builder	schema(ISchema schema)	Deprecated. use Definition.schema instead
GraphqlApiProps.Builder	visibility(Visibility visibility)	Sets the value of GraphqlApiProps.getVisibility()
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(Stable)
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(Stable)
public GraphqlApiProps.Builder authorizationConfig(AuthorizationConfig authorizationConfig)

Sets the value of GraphqlApiProps.getAuthorizationConfig()

Parameters:

authorizationConfig - Optional authorization configuration.

Returns:

this

definition

@Stability(Stable)
public GraphqlApiProps.Builder definition(Definition definition)

Sets the value of GraphqlApiProps.getDefinition()

Parameters:

definition - Definition (schema file or source APIs) for this GraphQL Api.

Returns:

this

domainName

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

environmentVariables

@Stability(Stable)
public GraphqlApiProps.Builder environmentVariables(Map<String,String> environmentVariables)

Sets the value of GraphqlApiProps.getEnvironmentVariables()

Parameters:

environmentVariables - A map containing the list of resources with their properties and environment variables. There are a few rules you must follow when creating keys and values:

• Keys must begin with a letter.
• Keys must be between 2 and 64 characters long.
• Keys can only contain letters, numbers, and the underscore character (_).
• Values can be up to 512 characters long.
• You can configure up to 50 key-value pairs in a GraphQL API.

Returns:

this

introspectionConfig

@Stability(Stable)
public GraphqlApiProps.Builder introspectionConfig(IntrospectionConfig introspectionConfig)

Sets the value of GraphqlApiProps.getIntrospectionConfig()

Parameters:

introspectionConfig - A value indicating whether the API to enable (ENABLED) or disable (DISABLED) introspection.

Returns:

this

logConfig

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

Sets the value of GraphqlApiProps.getLogConfig()

Parameters:

logConfig - Logging configuration for this api.

Returns:

this

queryDepthLimit

@Stability(Stable)
public GraphqlApiProps.Builder queryDepthLimit(Number queryDepthLimit)

Sets the value of GraphqlApiProps.getQueryDepthLimit()

Parameters:

queryDepthLimit - A number indicating the maximum depth resolvers should be accepted when handling queries. Value must be withing range of 0 to 75

Returns:

this

resolverCountLimit

@Stability(Stable)
public GraphqlApiProps.Builder resolverCountLimit(Number resolverCountLimit)

Sets the value of GraphqlApiProps.getResolverCountLimit()

Parameters:

resolverCountLimit - A number indicating the maximum number of resolvers that should be accepted when handling queries. Value must be withing range of 0 to 10000

Returns:

this

schema

@Stability(Deprecated)
@Deprecated
public GraphqlApiProps.Builder schema(ISchema schema)

Deprecated.

use Definition.schema instead

Sets the value of GraphqlApiProps.getSchema()

Parameters:

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

Returns:

this

visibility

@Stability(Stable)
public GraphqlApiProps.Builder visibility(Visibility visibility)

Sets the value of GraphqlApiProps.getVisibility()

Parameters:

visibility - A value indicating whether the API is accessible from anywhere (GLOBAL) or can only be access from a VPC (PRIVATE).

Returns:

this

xrayEnabled

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