appsync/aws.sdk.kotlin.services.appsync.model/Api

Api

class Api

Describes an AppSync API. You can use Api for an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

Types

Builder

class Builder

Companion

object Companion

Properties

apiArn

val apiArn: String?

The Amazon Resource Name (ARN) for the Api.

apiId

val apiId: String?

The Api ID.

created

val created: Instant?

The date and time that the Api was created.

dns

val dns: Map<String, String>?

The DNS records for the API. This will include an HTTP and a real-time endpoint.

eventConfig

val eventConfig: EventConfig?

The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

name

val name: String?

The name of the Api.

ownerContact

val ownerContact: String?

The owner contact information for the Api

Functions

copy

inline fun copy(block: Api.Builder.() -> Unit = {}): Api

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String