software.amazon.awscdk.services.appsync

Class GraphqlApi.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.GraphqlApi.Builder

Enclosing class:

GraphqlApi

public static final class GraphqlApi.Builder
extends java.lang.Object

(experimental) A fluent builder for GraphqlApi.

Method Summary

Modifier and Type	Method and Description
GraphqlApi.Builder	authorizationConfig(AuthorizationConfig authorizationConfig) (experimental) Optional authorization configuration.
GraphqlApi	build()
static GraphqlApi.Builder	create(software.constructs.Construct scope, java.lang.String id)
GraphqlApi.Builder	domainName(DomainOptions domainName) (experimental) The domain name configuration for the GraphQL API.
GraphqlApi.Builder	logConfig(LogConfig logConfig) (experimental) Logging configuration for this api.
GraphqlApi.Builder	name(java.lang.String name) (experimental) the name of the GraphQL API.
GraphqlApi.Builder	schema(Schema schema) (experimental) GraphQL schema definition.
GraphqlApi.Builder	xrayEnabled(java.lang.Boolean xrayEnabled) (experimental) A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static GraphqlApi.Builder create(software.constructs.Construct scope,
                                        java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of GraphqlApi.Builder.

name

public GraphqlApi.Builder name(java.lang.String name)

(experimental) the name of the GraphQL API.

Parameters:

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

Returns:

this

authorizationConfig

public GraphqlApi.Builder authorizationConfig(AuthorizationConfig authorizationConfig)

(experimental) Optional authorization configuration.

Default: - API Key authorization

Parameters:

authorizationConfig - Optional authorization configuration. This parameter is required.

Returns:

this

domainName

public GraphqlApi.Builder domainName(DomainOptions domainName)

(experimental) 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

Default: - no domain name

Parameters:

domainName - The domain name configuration for the GraphQL API. This parameter is required.

Returns:

this

logConfig

public GraphqlApi.Builder logConfig(LogConfig logConfig)

(experimental) Logging configuration for this api.

Default: - None

Parameters:

logConfig - Logging configuration for this api. This parameter is required.

Returns:

this

schema

public GraphqlApi.Builder schema(Schema schema)

(experimental) GraphQL schema definition. Specify how you want to define your schema.

Schema.fromFile(filePath: string) allows schema definition through schema.graphql file

Default: - schema will be generated code-first (i.e. addType, addObjectType, etc.)

Parameters:

schema - GraphQL schema definition. Specify how you want to define your schema. This parameter is required.

Returns:

this

xrayEnabled

public GraphqlApi.Builder xrayEnabled(java.lang.Boolean xrayEnabled)

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

Default: - false

Parameters:

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

Returns:

this

build

public GraphqlApi build()