Skip to main content

RemoteReference

A per-instance override of a single connection slot. The blueprint Link wires a slot from a sibling package's output; a remote reference overrides that wiring on one instance, pointing the slot at a resource from another project (or an imported resource) instead.

Remote references enable cross-project infrastructure sharing. For example, a networking team provisions a VPC in one project, and application teams override the vpc connection slot on their database/cache/etc. instances to point at that shared VPC.

Each remote reference binds a specific field on the instance — a key in the instance's bundle's connectionsSchema — to the target resource. The override takes priority over any blueprint-level Link on the same slot, and reverts to the Link (or environment default) when removed.

type RemoteReference {
id: ID!
field: String!
createdAt: DateTime!
updatedAt: DateTime!
resource: Resource!
instance: Instance!
}

Fields

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

Unique identifier for this remote reference.

RemoteReference.field ● String! non-null scalar {#field}

The name of the resource field on the instance that this reference satisfies (e.g., aws_authentication or vpc).

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

When this remote reference was created (UTC).

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

When this remote reference was last modified (UTC).

RemoteReference.resource ● Resource! non-null object {#resource}

The resource from another project (or an imported resource) that this reference points to.

RemoteReference.instance ● Instance! non-null object {#instance}

The instance whose connection slot this remote reference overrides.

Member Of

RemoteReferencePayload object ● RemoteReferencesPage object

Implemented By

InstanceDependencySource union