Link

A design-time dependency between two components in a blueprint.

A link declares that one component's output should be wired into another component's input. For example, a link from a database component's authentication output to an application component's database input ensures the app receives the database connection string.

At deploy time, each link is realized as a connection in the environment, wiring the actual instance outputs to instance inputs.

type Link {
  id: ID!
  fromField: String!
  toField: String!
  fromVersionConstraint: String
  toVersionConstraint: String
  createdAt: DateTime!
  updatedAt: DateTime!
  fromComponent: Component
  toComponent: Component
}

Fields

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

Unique identifier for this link.

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

The output field name on the source component (e.g., authentication).

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

The input field name on the destination component (e.g., database).

Link.fromVersionConstraint ● String scalar {#from-version-constraint}

The version range of the source component this link routes from, as a tilde constraint (~1 covers 1.x, ~0.4 covers 0.4.x). Null when the range has not been determined.

Link.toVersionConstraint ● String scalar {#to-version-constraint}

The version range of the destination component this link routes to, as a tilde constraint (~1 covers 1.x, ~0.4 covers 0.4.x). Null when the range has not been determined.

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

When this link was created (UTC).

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

When this link was last modified (UTC).

Link.fromComponent ● Component object {#from-component}

The source component that produces the output.

Link.toComponent ● Component object {#to-component}

The destination component that consumes the input.

Member Of

Connection object ● Environment object ● LinkEvent object ● LinkPayload object ● LinksPage object ● Project object