Package software.amazon.awscdk.services.appsync

Interface GraphqlApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GraphqlApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.506Z")
@Stability(Experimental)
public interface GraphqlApiProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for an AppSync GraphQL API.

Example:

 GraphqlApi api = GraphqlApi.Builder.create(this, "Api")
         .name("demo")
         .build();
 ObjectType demo = ObjectType.Builder.create("Demo")
         .definition(Map.of(
                 "id", GraphqlType.string(BaseTypeOptions.builder().isRequired(true).build()),
                 "version", GraphqlType.string(BaseTypeOptions.builder().isRequired(true).build())))
         .build();
 api.addType(demo);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GraphqlApiProps.Builder	A builder for GraphqlApiProps
static final class	GraphqlApiProps.Jsii$Proxy	An implementation for GraphqlApiProps

Method Summary

Modifier and Type	Method	Description
static GraphqlApiProps.Builder	builder()
default AuthorizationConfig	getAuthorizationConfig()	(experimental) Optional authorization configuration.
default DomainOptions	getDomainName()	(experimental) The domain name configuration for the GraphQL API.
default LogConfig	getLogConfig()	(experimental) Logging configuration for this api.
String	getName()	(experimental) the name of the GraphQL API.
default Schema	getSchema()	(experimental) GraphQL schema definition.
default Boolean	getXrayEnabled()	(experimental) A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) the name of the GraphQL API.

getAuthorizationConfig

@Stability(Experimental)
@Nullable
default AuthorizationConfig getAuthorizationConfig()

(experimental) Optional authorization configuration.

Default: - API Key authorization

getDomainName

@Stability(Experimental)
@Nullable
default DomainOptions getDomainName()

(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

getLogConfig

@Stability(Experimental)
@Nullable
default LogConfig getLogConfig()

(experimental) Logging configuration for this api.

Default: - None

getSchema

@Stability(Experimental)
@Nullable
default Schema getSchema()

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

getXrayEnabled

@Stability(Experimental)
@Nullable
default Boolean getXrayEnabled()

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

Default: - false

builder

@Stability(Experimental)
static GraphqlApiProps.Builder builder()

Returns:

a GraphqlApiProps.Builder of GraphqlApiProps