public static final class GraphqlApi.Builder
extends java.lang.Object
GraphqlApi
.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.
|
public static GraphqlApi.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.GraphqlApi.Builder
.public GraphqlApi.Builder name(java.lang.String name)
name
- the name of the GraphQL API. This parameter is required.this
public GraphqlApi.Builder authorizationConfig(AuthorizationConfig authorizationConfig)
Default: - API Key authorization
authorizationConfig
- Optional authorization configuration. This parameter is required.this
public GraphqlApi.Builder domainName(DomainOptions domainName)
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
domainName
- The domain name configuration for the GraphQL API. This parameter is required.this
public GraphqlApi.Builder logConfig(LogConfig logConfig)
Default: - None
logConfig
- Logging configuration for this api. This parameter is required.this
public GraphqlApi.Builder schema(Schema schema)
Schema.fromFile(filePath: string) allows schema definition through schema.graphql file
Default: - schema will be generated code-first (i.e. addType, addObjectType, etc.)
schema
- GraphQL schema definition. Specify how you want to define your schema. This parameter is required.this
public GraphqlApi.Builder xrayEnabled(java.lang.Boolean xrayEnabled)
Default: - false
xrayEnabled
- A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API. This parameter is required.this
public GraphqlApi build()