RemoteReference

A link between an instance's resource field and a resource from another project or an imported resource.

Remote references enable cross-project infrastructure sharing. For example, a networking team can provision a VPC in one project, and application teams can reference that VPC from their own projects using remote references.

Each remote reference binds a specific field on the instance to the target resource. Setting a remote reference on an instance with no other references transitions the instance to EXTERNAL status. Removing the last reference resets it to INITIALIZED.

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

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.

Member Of

RemoteReferencePayload object