GraphqlApi

Describes a GraphQL API.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A list of additional authentication providers for the GraphqlApi API.

Link copied to clipboard

The API ID.

Link copied to clipboard

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

Link copied to clipboard
val arn: String?

The Amazon Resource Name (ARN).

Link copied to clipboard

The authentication type.

Link copied to clipboard

The DNS records for the API.

Link copied to clipboard

The enhancedMetricsConfig object.

Link copied to clipboard

Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

Link copied to clipboard

Configuration for Lambda function authorization.

Link copied to clipboard

The Amazon CloudWatch Logs configuration.

Link copied to clipboard

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

Link copied to clipboard
val name: String?

The API name.

Link copied to clipboard

The OpenID Connect configuration.

Link copied to clipboard

The account owner of the GraphQL API.

Link copied to clipboard

The owner contact information for an API resource.

Link copied to clipboard

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

Link copied to clipboard

The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

Link copied to clipboard

The tags.

Link copied to clipboard

The URIs.

Link copied to clipboard

The Amazon Cognito user pool configuration.

Link copied to clipboard

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Link copied to clipboard

The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

Link copied to clipboard

A flag indicating whether to use X-Ray tracing for this GraphqlApi.

Functions

Link copied to clipboard
inline fun copy(block: GraphqlApi.Builder.() -> Unit = {}): GraphqlApi
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String