Connection

A runtime wiring between two instances in an environment.

A connection is the runtime realization of a blueprint link. Where a link says "the database component's authentication output goes to the app component's database input," the connection in each environment carries the actual resource data (e.g., a connection string) from the source instance to the destination instance.

Connections are created automatically when instances are deployed and a matching blueprint link exists.

type Connection {
  id: ID!
  fromField: String!
  toField: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  fromInstance: Instance
  toInstance: Instance
  link: Link
}

Fields

Connection.id ● ID! non-null scalar {#id}

Unique identifier for this connection.

Connection.fromField ● String! non-null scalar {#from-field}

The output field name on the source instance that produces the resource.

Connection.toField ● String! non-null scalar {#to-field}

The input field name on the destination instance that consumes the resource.

Connection.createdAt ● DateTime! non-null scalar {#created-at}

When this connection was created (UTC).

Connection.updatedAt ● DateTime! non-null scalar {#updated-at}

When this connection was last modified (UTC).

Connection.fromInstance ● Instance object {#from-instance}

The source instance that produces the resource wired through this connection.

Connection.toInstance ● Instance object {#to-instance}

The destination instance that consumes the resource wired through this connection.

Connection.link ● Link object {#link}

The blueprint link that this connection realizes. Null if the link has since been removed.

Member Of

ConnectionEvent object ● ConnectionsPage object

Implemented By

InstanceDependencySource union